test/jalview/controller/AlignViewControllerTest.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.controller;
  22
  23 import static org.testng.AssertJUnit.assertEquals;
  24 import static org.testng.AssertJUnit.assertTrue;
  25
  26 import jalview.analysis.Finder;
  27 import jalview.api.AlignViewControllerI;
  28 import jalview.api.FeatureColourI;
  29 import jalview.api.FinderI;
  30 import jalview.datamodel.Alignment;
  31 import jalview.datamodel.SearchResults;
  32 import jalview.datamodel.SearchResultsI;
  33 import jalview.datamodel.Sequence;
  34 import jalview.datamodel.SequenceFeature;
  35 import jalview.datamodel.SequenceGroup;
  36 import jalview.datamodel.SequenceI;
  37 import jalview.gui.AlignFrame;
  38 import jalview.gui.JvOptionPane;
  39 import jalview.io.DataSourceType;
  40 import jalview.io.FileLoader;
  41 import jalview.schemes.FeatureColour;
  42
  43 import java.awt.Color;
  44 import java.util.Arrays;
  45 import java.util.BitSet;
  46
  47 import org.testng.annotations.BeforeClass;
  48 import org.testng.annotations.Test;
  49
  50 public class AlignViewControllerTest
  51 {
  52
  53   @BeforeClass(alwaysRun = true)
  54   public void setUpJvOptionPane()
  55   {
  56     JvOptionPane.setInteractiveMode(false);
  57     JvOptionPane.setMockResponse(JvOptionPane.CANCEL_OPTION);
  58   }
  59
  60   @Test(groups = "Functional")
  61   public void testFindColumnsWithFeature()
  62   {
  63     SequenceI seq1 = new Sequence("seq1", "-a-MMMaaaaaaaaaaaaaaaa");
  64     SequenceI seq2 = new Sequence("seq2/11-30", "aa--aMM-MMMMMaaaaaaaaaa");
  65     SequenceI seq3 = new Sequence("seq3", "abcab-caD-aaMMMMMaaaaa");
  66     SequenceI seq4 = new Sequence("seq4", "abc--abcaaaaaaaaaaaaaa");
  67
  68     /*
  69      * features
  70      */
  71     seq1.addSequenceFeature(
  72             new SequenceFeature("Metal", "desc", 2, 4, 0f, null));
  73     seq1.addSequenceFeature(
  74             new SequenceFeature("Helix", "desc", 1, 15, 0f, null));
  75     seq2.addSequenceFeature(
  76             new SequenceFeature("Metal", "desc", 14, 20, 10f, null));
  77     seq3.addSequenceFeature(
  78             new SequenceFeature("Metal", "desc", 11, 15, 10f, null));
  79     // disulfide bond is a 'contact feature' - only select its 'start' and 'end'
  80     seq3.addSequenceFeature(
  81             new SequenceFeature("disulfide bond", "desc", 8, 12, 0f, null));
  82
  83     /*
  84      * select the first five columns --> Metal in seq1 cols 4-5
  85      */
  86     SequenceGroup sg = new SequenceGroup();
  87     sg.setStartRes(0); // base 0
  88     sg.setEndRes(4);
  89     sg.addSequence(seq1, false);
  90     sg.addSequence(seq2, false);
  91     sg.addSequence(seq3, false);
  92     sg.addSequence(seq4, false);
  93
  94     /*
  95      * set features visible on a viewport as only visible features are selected
  96      */
  97     Alignment al = new Alignment(
  98             new SequenceI[]
  99             { seq1, seq2, seq3, seq4 });
 100     AlignFrame af = new AlignFrame(al, 100, 100);
 101     af.getFeatureRenderer().findAllFeatures(true);
 102
 103     AlignViewController avc = new AlignViewController(af, af.getViewport(),
 104             af.alignPanel);
 105
 106     BitSet bs = new BitSet();
 107     int seqCount = avc.findColumnsWithFeature(sg, bs, "Metal");
 108     assertEquals(1, seqCount);
 109     assertEquals(2, bs.cardinality());
 110     assertTrue(bs.get(3)); // base 0
 111     assertTrue(bs.get(4));
 112
 113     /*
 114      * select the first seven columns: Metal in seq1 cols 4-6, seq2 cols 6-7
 115      */
 116     sg.setEndRes(6);
 117     bs.clear();
 118     seqCount = avc.findColumnsWithFeature(sg, bs, "Metal");
 119     assertEquals(2, seqCount);
 120     assertEquals(4, bs.cardinality());
 121     assertTrue(bs.get(3));
 122     assertTrue(bs.get(4));
 123     assertTrue(bs.get(5));
 124     assertTrue(bs.get(6));
 125
 126     /*
 127      * select column 14: Metal in seq3 only
 128      */
 129     sg.setStartRes(13);
 130     sg.setEndRes(13);
 131     bs.clear();
 132     seqCount = avc.findColumnsWithFeature(sg, bs, "Metal");
 133     assertEquals(1, seqCount);
 134     assertEquals(1, bs.cardinality());
 135     assertTrue(bs.get(13));
 136
 137     /*
 138      * select columns 18-20: no Metal feature
 139      */
 140     sg.setStartRes(17);
 141     sg.setEndRes(19);
 142     bs.clear();
 143     seqCount = avc.findColumnsWithFeature(sg, bs, "Metal");
 144     assertEquals(0, seqCount);
 145     assertEquals(0, bs.cardinality());
 146
 147     /*
 148      * threshold Metal to hide where score < 5
 149      * seq1 feature in columns 4-6 is hidden
 150      * seq2 feature in columns 6-7 is shown
 151      */
 152     FeatureColourI fc = new FeatureColour(null, Color.red, Color.blue, null,
 153             0f, 10f);
 154     fc.setAboveThreshold(true);
 155     fc.setThreshold(5f);
 156     af.getFeatureRenderer().setColour("Metal", fc);
 157     sg.setStartRes(0);
 158     sg.setEndRes(6);
 159     bs.clear();
 160     seqCount = avc.findColumnsWithFeature(sg, bs, "Metal");
 161     assertEquals(1, seqCount);
 162     assertEquals(2, bs.cardinality());
 163     assertTrue(bs.get(5));
 164     assertTrue(bs.get(6));
 165
 166     /*
 167      * columns 11-13 should not match disulfide bond at 8/12
 168      */
 169     sg.setStartRes(10);
 170     sg.setEndRes(12);
 171     bs.clear();
 172     seqCount = avc.findColumnsWithFeature(sg, bs, "disulfide bond");
 173     assertEquals(0, seqCount);
 174     assertEquals(0, bs.cardinality());
 175
 176     /*
 177      * columns 6-18 should match disulfide bond at columns 9, 14
 178      */
 179     sg.setStartRes(5);
 180     sg.setEndRes(17);
 181     bs.clear();
 182     seqCount = avc.findColumnsWithFeature(sg, bs, "disulfide bond");
 183     assertEquals(1, seqCount);
 184     assertEquals(2, bs.cardinality());
 185     assertTrue(bs.get(8));
 186     assertTrue(bs.get(13));
 187
 188     /*
 189      * look for multiple features; should match
 190      * transcript_variant in seq3 positions 3-6, columns 3-7
 191      * sequence_variant in seq2 positions 15-18, columns 7-11
 192      * transcript_variant in seq3 positions 8 and 12, columns 9 and 14
 193      */
 194     seq3.addSequenceFeature(new SequenceFeature("transcript_variant",
 195             "desc", 3, 6, 0f, null));
 196     seq2.addSequenceFeature(new SequenceFeature("sequence_variant", "desc",
 197             15, 18, 0f, null));
 198     sg.setStartRes(0);
 199     sg.setEndRes(20);
 200     bs.clear();
 201     seqCount = avc.findColumnsWithFeature(sg, bs, "transcript_variant",
 202             "sequence_variant", "disulfide bond", "junk");
 203     assertEquals(2, seqCount);
 204     assertEquals(10, bs.cardinality()); // 2-10 and 13, base 0
 205     for (int i = 2; i <= 10; i++)
 206     {
 207       assertTrue(bs.get(i));
 208     }
 209     assertTrue(bs.get(13));
 210
 211     /*
 212      * look for a feature that isn't there
 213      */
 214     sg.setStartRes(0);
 215     sg.setEndRes(19);
 216     bs.clear();
 217     seqCount = avc.findColumnsWithFeature(sg, bs, "Pfam");
 218     assertEquals(0, seqCount);
 219     assertEquals(0, bs.cardinality());
 220   }
 221
 222   /**
 223    * shameless copy of test data from findFeature for testing mark columns from
 224    * highlight
 225    */
 226   @Test(groups = "Functional")
 227   public void testSelectColumnsWithHighlight()
 228   {
 229     AlignFrame af = new FileLoader().LoadFileWaitTillLoaded(
 230             "seq1 aMMMaaaaaaaaaaaaaaaa\n" + "seq2 aaaMMMMMMMaaaaaaaaaa\n"
 231                     + "seq3 aaaaaaaaaaMMMMMaaaaa\n"
 232                     + "seq4 aaaaaaaaaaaaaaaaaaaa\n", DataSourceType.PASTE);
 233
 234     SearchResultsI sr = new SearchResults();
 235     SequenceI[] sqs = af.getViewport().getAlignment().getSequencesArray();
 236     SequenceI seq1 = sqs[0];
 237     SequenceI seq2 = sqs[1];
 238     SequenceI seq3 = sqs[2];
 239     SequenceI seq4 = sqs[3];
 240
 241     /*
 242      * features start/end are base 1
 243      */
 244     sr.addResult(seq1, 2, 4);
 245     sr.addResult(seq2, 4, 10);
 246     sr.addResult(seq3, 11, 15);
 247
 248     /*
 249      *  test Match/Find works first
 250      */
 251     FinderI f = new Finder(af.getViewport());
 252     f.findAll("M+", true, false);
 253     assertEquals(
 254             "Finder found different set of results to manually created SearchResults",
 255             sr, f.getSearchResults());
 256
 257     /*
 258      * now check simple mark columns from find operation
 259      */
 260     af.getViewport().setSearchResults(sr);
 261     AlignViewControllerI avc = af.avc;
 262
 263     avc.markHighlightedColumns(false, false, false);
 264     assertTrue("Didn't select highlighted columns", Arrays.deepEquals(af
 265             .getViewport().getColumnSelection().getSelectedRanges()
 266             .toArray(), new int[][] { { 1, 14 } }));
 267   }
 268 }