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