test/jalview/structures/models/AAStructureBindingModelTest.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.structures.models;
  22
  23 import static org.testng.Assert.assertFalse;
  24 import static org.testng.AssertJUnit.assertEquals;
  25 import static org.testng.AssertJUnit.assertTrue;
  26
  27 import jalview.api.AlignmentViewPanel;
  28 import jalview.api.FeatureRenderer;
  29 import jalview.api.SequenceRenderer;
  30 import jalview.datamodel.Alignment;
  31 import jalview.datamodel.AlignmentI;
  32 import jalview.datamodel.HiddenColumns;
  33 import jalview.datamodel.PDBEntry;
  34 import jalview.datamodel.PDBEntry.Type;
  35 import jalview.datamodel.Sequence;
  36 import jalview.datamodel.SequenceI;
  37 import jalview.gui.JvOptionPane;
  38 import jalview.io.DataSourceType;
  39 import jalview.io.FileFormats;
  40 import jalview.schemes.ColourSchemeI;
  41 import jalview.structure.AtomSpec;
  42 import jalview.structure.StructureSelectionManager;
  43 import jalview.structures.models.AAStructureBindingModel.SuperposeData;
  44
  45 import java.awt.Color;
  46 import java.io.IOException;
  47 import java.util.Arrays;
  48 import java.util.BitSet;
  49 import java.util.List;
  50
  51 import org.testng.annotations.BeforeClass;
  52 import org.testng.annotations.BeforeMethod;
  53 import org.testng.annotations.Test;
  54
  55 /**
  56  * Unit tests for non-abstract methods of abstract base class
  57  *
  58  * @author gmcarstairs
  59  *
  60  */
  61 public class AAStructureBindingModelTest
  62 {
  63
  64   @BeforeClass(alwaysRun = true)
  65   public void setUpJvOptionPane()
  66   {
  67     JvOptionPane.setInteractiveMode(false);
  68     JvOptionPane.setMockResponse(JvOptionPane.CANCEL_OPTION);
  69   }
  70
  71   /*
  72    * Scenario: Jalview has 4 sequences, corresponding to 1YCS (chains A and B), 3A6S|B, 1OOT|A
  73    */
  74   private static final String PDB_1 = "HEADER    COMPLEX (ANTI-ONCOGENE/ANKYRIN REPEATS) 30-SEP-96   1YCS              \n"
  75           + "ATOM      2  CA  VAL A  97      24.134   4.926  45.821  1.00 47.43           C  \n"
  76           + "ATOM      9  CA  PRO A  98      25.135   8.584  46.217  1.00 41.60           C  \n"
  77           + "ATOM     16  CA  SER A  99      28.243   9.596  44.271  1.00 39.63           C  \n"
  78           + "ATOM     22  CA  GLN A 100      31.488  10.133  46.156  1.00 35.60           C  \n"
  79           // artificial jump in residue numbering to prove it is correctly
  80           // mapped:
  81           + "ATOM     31  CA  LYS A 102      33.323  11.587  43.115  1.00 41.69           C  \n"
  82           + "ATOM   1857  CA  GLU B 374       9.193 -16.005  95.870  1.00 54.22           C  \n"
  83           + "ATOM   1866  CA  ILE B 375       7.101 -14.921  92.847  1.00 46.82           C  \n"
  84           + "ATOM   1874  CA  VAL B 376      10.251 -13.625  91.155  1.00 47.80           C  \n"
  85           + "ATOM   1881  CA  LYS B 377      11.767 -17.068  91.763  1.00 50.21           C  \n"
  86           + "ATOM   1890  CA  PHE B 378       8.665 -18.948  90.632  1.00 44.85           C  \n";
  87
  88   private static final String PDB_2 = "HEADER    HYDROLASE                               09-SEP-09   3A6S              \n"
  89           + "ATOM      2  CA  MET B   1      15.366 -11.648  24.854  1.00 32.05           C  \n"
  90           + "ATOM     10  CA  LYS B   2      16.846  -9.215  22.340  1.00 25.68           C  \n"
  91           + "ATOM     19  CA  LYS B   3      15.412  -6.335  20.343  1.00 19.42           C  \n"
  92           + "ATOM     28  CA  LEU B   4      15.629  -5.719  16.616  1.00 15.49           C  \n"
  93           + "ATOM     36  CA  GLN B   5      14.412  -2.295  15.567  1.00 12.19           C  \n";
  94
  95   private static final String PDB_3 = "HEADER    STRUCTURAL GENOMICS                     04-MAR-03   1OOT              \n"
  96           + "ATOM      2  CA  SER A   7      29.427   3.330  -6.578  1.00 32.50           C  \n"
  97           + "ATOM      8  CA  PRO A   8      29.975   3.340  -2.797  1.00 17.62           C  \n"
  98           + "ATOM     16  CA ALYS A   9      26.958   3.024  -0.410  0.50  8.78           C  \n"
  99           + "ATOM     33  CA  ALA A  10      26.790   4.320   3.172  1.00 11.98           C  \n"
 100           + "ATOM     39  CA AVAL A  12      24.424   3.853   6.106  0.50 13.83           C  \n";
 101
 102   /**
 103    * Multichain PDB with identical sequences imported - Binding should correctly
 104    * recover chain mappings for each derived sequence
 105    */
 106   private static final String PDB_4_MC = "HEADER    HYDROLASE                               09-SEP-09   3A6S              \n"
 107           + "ATOM      2  CA  MET A   1      15.366 -11.648  24.854  1.00 32.05           C  \n"
 108           + "ATOM     10  CA  LYS A   2      16.846  -9.215  22.340  1.00 25.68           C  \n"
 109           + "ATOM     19  CA  LYS A   3      15.412  -6.335  20.343  1.00 19.42           C  \n"
 110           + "ATOM     28  CA  LEU A   4      15.629  -5.719  16.616  1.00 15.49           C  \n"
 111           + "ATOM     36  CA  GLN A   5      14.412  -2.295  15.567  1.00 12.19           C  \n"
 112           + "ATOM   1030  CA  MET B   1      18.869  -7.572   3.432  1.00 31.52           C  \n"
 113           + "ATOM   1038  CA  LYS B   2      19.182 -10.025   6.313  1.00 26.41           C  \n"
 114           + "ATOM   1047  CA  LYS B   3      17.107 -12.963   7.534  1.00 19.71           C  \n"
 115           + "ATOM   1056  CA  LEU B   4      16.142 -13.579  11.164  1.00 14.81           C  \n"
 116           + "ATOM   1064  CA  GLN B   5      14.648 -17.005  11.785  1.00 13.38           C  \n";
 117
 118   // TODO: JAL-2227 - import mmCIF PISA assembly & identify master/copy chains
 119
 120   @Test(groups= {"Functional"})
 121   public void testImportPDBPreservesChainMappings() throws IOException
 122   {
 123     AlignmentI importedAl = new jalview.io.FormatAdapter().readFile(
 124             PDB_4_MC, DataSourceType.PASTE, FileFormats.getInstance()
 125                     .forName(jalview.io.FileFormat.PDB.toString()));
 126     // ideally, we would match on the actual data for the 'File' handle for
 127     // pasted files,
 128     // see JAL-623 - pasting is still not correctly handled...
 129     PDBEntry importedPDB = new PDBEntry("3A6S", "", Type.PDB,
 130             "Paste");
 131     AAStructureBindingModel binder = new AAStructureBindingModel(
 132             new StructureSelectionManager(), new PDBEntry[]
 133             { importedPDB },
 134             new SequenceI[][]
 135             { importedAl.getSequencesArray() }, null)
 136     {
 137
 138       @Override
 139       public void updateColours(Object source)
 140       {
 141         // TODO Auto-generated method stub
 142
 143       }
 144
 145       @Override
 146       public void releaseReferences(Object svl)
 147       {
 148         // TODO Auto-generated method stub
 149
 150       }
 151
 152       @Override
 153       public String[] getStructureFiles()
 154       {
 155         // TODO Auto-generated method stub
 156         return null;
 157       }
 158
 159       @Override
 160       public String superposeStructures(AlignmentI[] alignments,
 161               int[] structureIndices, HiddenColumns[] hiddenCols)
 162       {
 163         // TODO Auto-generated method stub
 164         return null;
 165       }
 166
 167       @Override
 168       public void setJalviewColourScheme(ColourSchemeI cs)
 169       {
 170         // TODO Auto-generated method stub
 171
 172       }
 173
 174       @Override
 175       public void setBackgroundColour(Color col)
 176       {
 177         // TODO Auto-generated method stub
 178
 179       }
 180
 181       @Override
 182       public void highlightAtoms(List<AtomSpec> atoms)
 183       {
 184         // TODO Auto-generated method stub
 185
 186       }
 187
 188       @Override
 189       public SequenceRenderer getSequenceRenderer(AlignmentViewPanel alignment)
 190       {
 191         // TODO Auto-generated method stub
 192         return null;
 193       }
 194
 195       @Override
 196       public FeatureRenderer getFeatureRenderer(AlignmentViewPanel alignment)
 197       {
 198         // TODO Auto-generated method stub
 199         return null;
 200       }
 201
 202       @Override
 203       protected String[] getColourBySequenceCommands(String[] files,
 204               AlignmentViewPanel avp)
 205       {
 206         // TODO Auto-generated method stub
 207         return null;
 208       }
 209
 210       @Override
 211       protected void colourBySequence(String[] colourBySequenceCommands)
 212       {
 213         // TODO Auto-generated method stub
 214
 215       }
 216
 217       @Override
 218       public void colourByCharge()
 219       {
 220         // TODO Auto-generated method stub
 221
 222       }
 223
 224       @Override
 225       public void colourByChain()
 226       {
 227         // TODO Auto-generated method stub
 228
 229       }
 230     };
 231     String[][] chains = binder.getChains();
 232     assertFalse(chains == null || chains[0] == null,
 233             "No chains discovered by binding");
 234     assertEquals(2, chains[0].length);
 235     assertEquals("A", chains[0][0]);
 236     assertEquals("B", chains[0][1]);
 237   }
 238   AAStructureBindingModel testee;
 239
 240   AlignmentI al = null;
 241
 242   /**
 243    * Set up test conditions with three aligned sequences,
 244    */
 245   @BeforeMethod(alwaysRun = true)
 246   public void setUp()
 247   {
 248     SequenceI seq1a = new Sequence("1YCS|A", "-VPSQK");
 249     SequenceI seq1b = new Sequence("1YCS|B", "EIVKF-");
 250     SequenceI seq2 = new Sequence("3A6S", "MK-KLQ");
 251     SequenceI seq3 = new Sequence("1OOT", "SPK-AV");
 252     al = new Alignment(new SequenceI[] { seq1a, seq1b, seq2, seq3 });
 253     al.setDataset(null);
 254
 255     /*
 256      * give pdb files the name generated by Jalview for PASTE source
 257      */
 258     PDBEntry[] pdbFiles = new PDBEntry[3];
 259     pdbFiles[0] = new PDBEntry("1YCS", "A", Type.PDB, "INLINE1YCS");
 260     pdbFiles[1] = new PDBEntry("3A6S", "B", Type.PDB, "INLINE3A6S");
 261     pdbFiles[2] = new PDBEntry("1OOT", "A", Type.PDB, "INLINE1OOT");
 262     SequenceI[][] seqs = new SequenceI[3][];
 263     seqs[0] = new SequenceI[] { seq1a, seq1b };
 264     seqs[1] = new SequenceI[] { seq2 };
 265     seqs[2] = new SequenceI[] { seq3 };
 266     StructureSelectionManager ssm = new StructureSelectionManager();
 267
 268     ssm.setMapping(new SequenceI[] { seq1a, seq1b }, null, PDB_1,
 269             DataSourceType.PASTE, null);
 270     ssm.setMapping(new SequenceI[] { seq2 }, null, PDB_2,
 271             DataSourceType.PASTE, null);
 272     ssm.setMapping(new SequenceI[] { seq3 }, null, PDB_3,
 273             DataSourceType.PASTE, null);
 274
 275     testee = new AAStructureBindingModel(ssm, pdbFiles, seqs, null)
 276     {
 277       @Override
 278       public String[] getStructureFiles()
 279       {
 280         return new String[] { "INLINE1YCS", "INLINE3A6S", "INLINE1OOT" };
 281       }
 282
 283       @Override
 284       public void updateColours(Object source)
 285       {
 286       }
 287
 288       @Override
 289       public void releaseReferences(Object svl)
 290       {
 291       }
 292
 293       @Override
 294       public void highlightAtoms(List<AtomSpec> atoms)
 295       {
 296       }
 297
 298       @Override
 299       public void setJalviewColourScheme(ColourSchemeI cs)
 300       {
 301       }
 302
 303       @Override
 304       public String superposeStructures(AlignmentI[] als, int[] alm,
 305               HiddenColumns[] alc)
 306       {
 307         return null;
 308       }
 309
 310       @Override
 311       public void setBackgroundColour(Color col)
 312       {
 313       }
 314
 315       @Override
 316       protected String[] getColourBySequenceCommands(
 317               String[] files, AlignmentViewPanel avp)
 318       {
 319         return null;
 320       }
 321
 322       @Override
 323       public SequenceRenderer getSequenceRenderer(
 324               AlignmentViewPanel alignment)
 325       {
 326         return null;
 327       }
 328
 329       @Override
 330       protected void colourBySequence(String[] colourBySequenceCommands)
 331       {
 332       }
 333
 334       @Override
 335       public void colourByChain()
 336       {
 337       }
 338
 339       @Override
 340       public void colourByCharge()
 341       {
 342       }
 343
 344       @Override
 345       public FeatureRenderer getFeatureRenderer(
 346               AlignmentViewPanel alignment)
 347       {
 348         return null;
 349       }
 350     };
 351   }
 352
 353   /**
 354    * Verify that the method determines that columns 2, 5 and 6 of the alignment
 355    * are alignable in structure
 356    */
 357   @Test(groups = { "Functional" })
 358   public void testFindSuperposableResidues()
 359   {
 360     /*
 361      * create a data bean to hold data per structure file
 362      */
 363     SuperposeData[] structs = new SuperposeData[testee.getStructureFiles().length];
 364     for (int i = 0; i < structs.length; i++)
 365     {
 366       structs[i] = testee.new SuperposeData(al.getWidth());
 367     }
 368     /*
 369      * initialise BitSet of 'superposable columns' to true (would be false for
 370      * hidden columns)
 371      */
 372     BitSet matched = new BitSet();
 373     for (int i = 0; i < al.getWidth(); i++)
 374     {
 375       matched.set(i);
 376     }
 377
 378     int refStructure = testee
 379             .findSuperposableResidues(al, matched, structs);
 380
 381     assertEquals(0, refStructure);
 382
 383     /*
 384      * only ungapped, structure-mapped columns are superposable
 385      */
 386     assertFalse(matched.get(0)); // gap in first sequence
 387     assertTrue(matched.get(1));
 388     assertFalse(matched.get(2)); // gap in third sequence
 389     assertFalse(matched.get(3)); // gap in fourth sequence
 390     assertTrue(matched.get(4));
 391     assertTrue(matched.get(5)); // gap in second sequence
 392
 393     assertEquals("1YCS", structs[0].pdbId);
 394     assertEquals("3A6S", structs[1].pdbId);
 395     assertEquals("1OOT", structs[2].pdbId);
 396     assertEquals("A", structs[0].chain); // ? struct has chains A _and_ B
 397     assertEquals("B", structs[1].chain);
 398     assertEquals("A", structs[2].chain);
 399     // the 0's for unsuperposable positions propagate down the columns:
 400     assertEquals("[0, 97, 98, 99, 100, 102]",
 401             Arrays.toString(structs[0].pdbResNo));
 402     assertEquals("[0, 2, 0, 3, 4, 5]", Arrays.toString(structs[1].pdbResNo));
 403     assertEquals("[0, 8, 0, 0, 10, 12]",
 404             Arrays.toString(structs[2].pdbResNo));
 405   }
 406
 407   @Test(groups = { "Functional" })
 408   public void testFindSuperposableResidues_hiddenColumn()
 409   {
 410     SuperposeData[] structs = new SuperposeData[al.getHeight()];
 411     for (int i = 0; i < structs.length; i++)
 412     {
 413       structs[i] = testee.new SuperposeData(al.getWidth());
 414     }
 415     /*
 416      * initialise BitSet of 'superposable columns' to true (would be false for
 417      * hidden columns)
 418      */
 419     BitSet matched = new BitSet();
 420     for (int i = 0; i < al.getWidth(); i++)
 421     {
 422       matched.set(i);
 423     }
 424
 425     // treat column 5 of the alignment as hidden
 426     matched.clear(4);
 427
 428     int refStructure = testee
 429             .findSuperposableResidues(al, matched, structs);
 430
 431     assertEquals(0, refStructure);
 432
 433     // only ungapped, structure-mapped columns are not superposable
 434     assertFalse(matched.get(0));
 435     assertTrue(matched.get(1));
 436     assertFalse(matched.get(2));
 437     assertFalse(matched.get(3));
 438     assertFalse(matched.get(4)); // superposable, but hidden, column
 439     assertTrue(matched.get(5));
 440   }
 441 }