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.AssertJUnit.assertEquals;
  24 import static org.testng.AssertJUnit.assertFalse;
  25 import static org.testng.AssertJUnit.assertTrue;
  26
  27 import jalview.api.AlignViewportI;
  28 import jalview.api.AlignmentViewPanel;
  29 import jalview.api.FeatureRenderer;
  30 import jalview.api.SequenceRenderer;
  31 import jalview.datamodel.Alignment;
  32 import jalview.datamodel.AlignmentI;
  33 import jalview.datamodel.ColumnSelection;
  34 import jalview.datamodel.PDBEntry;
  35 import jalview.datamodel.PDBEntry.Type;
  36 import jalview.datamodel.Sequence;
  37 import jalview.datamodel.SequenceI;
  38 import jalview.gui.JvOptionPane;
  39 import jalview.io.DataSourceType;
  40 import jalview.schemes.ColourSchemeI;
  41 import jalview.structure.AtomSpec;
  42 import jalview.structure.StructureMappingcommandSet;
  43 import jalview.structure.StructureSelectionManager;
  44 import jalview.structures.models.AAStructureBindingModel.SuperposeData;
  45
  46 import java.awt.Color;
  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   AAStructureBindingModel testee;
 103
 104   AlignmentI al = null;
 105
 106   /**
 107    * Set up test conditions with three aligned sequences,
 108    */
 109   @BeforeMethod(alwaysRun = true)
 110   public void setUp()
 111   {
 112     SequenceI seq1a = new Sequence("1YCS|A", "-VPSQK");
 113     SequenceI seq1b = new Sequence("1YCS|B", "EIVKF-");
 114     SequenceI seq2 = new Sequence("3A6S", "MK-KLQ");
 115     SequenceI seq3 = new Sequence("1OOT", "SPK-AV");
 116     al = new Alignment(new SequenceI[] { seq1a, seq1b, seq2, seq3 });
 117     al.setDataset(null);
 118
 119     /*
 120      * give pdb files the name generated by Jalview for PASTE source
 121      */
 122     PDBEntry[] pdbFiles = new PDBEntry[3];
 123     pdbFiles[0] = new PDBEntry("1YCS", "A", Type.PDB, "INLINE1YCS");
 124     pdbFiles[1] = new PDBEntry("3A6S", "B", Type.PDB, "INLINE3A6S");
 125     pdbFiles[2] = new PDBEntry("1OOT", "A", Type.PDB, "INLINE1OOT");
 126     SequenceI[][] seqs = new SequenceI[3][];
 127     seqs[0] = new SequenceI[] { seq1a, seq1b };
 128     seqs[1] = new SequenceI[] { seq2 };
 129     seqs[2] = new SequenceI[] { seq3 };
 130     StructureSelectionManager ssm = new StructureSelectionManager();
 131
 132     ssm.setMapping(new SequenceI[] { seq1a, seq1b }, null, PDB_1,
 133             DataSourceType.PASTE, null);
 134     ssm.setMapping(new SequenceI[] { seq2 }, null, PDB_2,
 135             DataSourceType.PASTE, null);
 136     ssm.setMapping(new SequenceI[] { seq3 }, null, PDB_3,
 137             DataSourceType.PASTE, null);
 138
 139
 140     testee = new AAStructureBindingModel(ssm, pdbFiles, seqs, null)
 141     {
 142       @Override
 143       public String[] getStructureFiles()
 144       {
 145         return new String[] { "INLINE1YCS", "INLINE3A6S", "INLINE1OOT" };
 146       }
 147
 148       @Override
 149       public void updateColours(Object source)
 150       {
 151       }
 152
 153       @Override
 154       public void releaseReferences(Object svl)
 155       {
 156       }
 157
 158       @Override
 159       public void highlightAtoms(List<AtomSpec> atoms)
 160       {
 161       }
 162
 163       @Override
 164       public List<String> getChainNames()
 165       {
 166         return null;
 167       }
 168
 169       @Override
 170       public void setJalviewColourScheme(ColourSchemeI cs)
 171       {
 172       }
 173
 174       @Override
 175       public String superposeStructures(AlignmentI[] als, int[] alm,
 176               ColumnSelection[] alc)
 177       {
 178         return null;
 179       }
 180
 181       @Override
 182       public void setBackgroundColour(Color col)
 183       {
 184       }
 185
 186       @Override
 187       protected StructureMappingcommandSet[] getColourBySequenceCommands(
 188               String[] files, SequenceRenderer sr, FeatureRenderer fr,
 189               AlignViewportI viewport)
 190       {
 191         return null;
 192       }
 193
 194       @Override
 195       public FeatureRenderer getFeatureRenderer(AlignmentViewPanel alignment)
 196       {
 197         return null;
 198       }
 199
 200       @Override
 201       public SequenceRenderer getSequenceRenderer(
 202               AlignmentViewPanel alignment)
 203       {
 204         return null;
 205       }
 206
 207       @Override
 208       protected void colourBySequence(
 209               StructureMappingcommandSet[] colourBySequenceCommands)
 210       {
 211       }
 212
 213       @Override
 214       public void colourByChain()
 215       {
 216       }
 217
 218       @Override
 219       public void colourByCharge()
 220       {
 221       }
 222     };
 223   }
 224
 225   /**
 226    * Verify that the method determines that columns 2, 5 and 6 of the alignment
 227    * are alignable in structure
 228    */
 229   @Test(groups = { "Functional" })
 230   public void testFindSuperposableResidues()
 231   {
 232     /*
 233      * create a data bean to hold data per structure file
 234      */
 235     SuperposeData[] structs = new SuperposeData[testee.getStructureFiles().length];
 236     for (int i = 0; i < structs.length; i++)
 237     {
 238       structs[i] = testee.new SuperposeData(al.getWidth());
 239     }
 240     /*
 241      * initialise BitSet of 'superposable columns' to true (would be false for
 242      * hidden columns)
 243      */
 244     BitSet matched = new BitSet();
 245     for (int i = 0; i < al.getWidth(); i++)
 246     {
 247       matched.set(i);
 248     }
 249
 250     int refStructure = testee
 251             .findSuperposableResidues(al, matched, structs);
 252
 253     assertEquals(0, refStructure);
 254
 255     /*
 256      * only ungapped, structure-mapped columns are superposable
 257      */
 258     assertFalse(matched.get(0)); // gap in first sequence
 259     assertTrue(matched.get(1));
 260     assertFalse(matched.get(2)); // gap in third sequence
 261     assertFalse(matched.get(3)); // gap in fourth sequence
 262     assertTrue(matched.get(4));
 263     assertTrue(matched.get(5)); // gap in second sequence
 264
 265     assertEquals("1YCS", structs[0].pdbId);
 266     assertEquals("3A6S", structs[1].pdbId);
 267     assertEquals("1OOT", structs[2].pdbId);
 268     assertEquals("A", structs[0].chain); // ? struct has chains A _and_ B
 269     assertEquals("B", structs[1].chain);
 270     assertEquals("A", structs[2].chain);
 271     // the 0's for unsuperposable positions propagate down the columns:
 272     assertEquals("[0, 97, 98, 99, 100, 102]",
 273             Arrays.toString(structs[0].pdbResNo));
 274     assertEquals("[0, 2, 0, 3, 4, 5]", Arrays.toString(structs[1].pdbResNo));
 275     assertEquals("[0, 8, 0, 0, 10, 12]",
 276             Arrays.toString(structs[2].pdbResNo));
 277   }
 278
 279   @Test(groups = { "Functional" })
 280   public void testFindSuperposableResidues_hiddenColumn()
 281   {
 282     SuperposeData[] structs = new SuperposeData[al.getHeight()];
 283     for (int i = 0; i < structs.length; i++)
 284     {
 285       structs[i] = testee.new SuperposeData(al.getWidth());
 286     }
 287     /*
 288      * initialise BitSet of 'superposable columns' to true (would be false for
 289      * hidden columns)
 290      */
 291     BitSet matched = new BitSet();
 292     for (int i = 0; i < al.getWidth(); i++)
 293     {
 294       matched.set(i);
 295     }
 296
 297     // treat column 5 of the alignment as hidden
 298     matched.clear(4);
 299
 300     int refStructure = testee
 301             .findSuperposableResidues(al, matched, structs);
 302
 303     assertEquals(0, refStructure);
 304
 305     // only ungapped, structure-mapped columns are not superposable
 306     assertFalse(matched.get(0));
 307     assertTrue(matched.get(1));
 308     assertFalse(matched.get(2));
 309     assertFalse(matched.get(3));
 310     assertFalse(matched.get(4)); // superposable, but hidden, column
 311     assertTrue(matched.get(5));
 312   }
 313 }