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", "aa--aMM-MMMMMaaaaaaaaaa");
  65     SequenceI seq3 = new Sequence("seq3", "abcab-caD-aaMMMMMaaaaa");
  66     SequenceI seq4 = new Sequence("seq4", "abc--abcaaaaaaaaaaaaaa");
  67
  68     /*
  69      * features start/end are base 1
  70      */
  71     seq1.addSequenceFeature(new SequenceFeature("Metal", "desc", 2, 4, 0f,
  72             null));
  73     seq1.addSequenceFeature(new SequenceFeature("Helix", "desc", 1, 15, 0f,
  74             null));
  75     seq2.addSequenceFeature(new SequenceFeature("Metal", "desc", 4, 10,
  76             10f,
  77             null));
  78     seq3.addSequenceFeature(new SequenceFeature("Metal", "desc", 11, 15,
  79             10f, null));
  80     // disulfide bond is a 'contact feature' - only select its 'start' and 'end'
  81     seq3.addSequenceFeature(new SequenceFeature("disulfide bond", "desc",
  82             8, 12, 0f, null));
  83
  84     /*
  85      * select the first five columns --> Metal in seq1 cols 4-5
  86      */
  87     SequenceGroup sg = new SequenceGroup();
  88     sg.setStartRes(0); // base 0
  89     sg.setEndRes(4);
  90     sg.addSequence(seq1, false);
  91     sg.addSequence(seq2, false);
  92     sg.addSequence(seq3, false);
  93     sg.addSequence(seq4, false);
  94
  95     /*
  96      * set features visible on a viewport as only visible features are selected
  97      */
  98     AlignFrame af = new AlignFrame(new Alignment(new SequenceI[] { seq1,
  99         seq2, seq3, seq4 }), 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("Metal", sg, bs);
 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("Metal", sg, bs);
 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("Metal", sg, bs);
 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("Metal", sg, bs);
 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(null, Color.red, Color.blue, null,
 152             0f, 10f);
 153     fc.setAboveThreshold(true);
 154     fc.setThreshold(5f);
 155     af.getFeatureRenderer().setColour("Metal", fc);
 156     sg.setStartRes(0);
 157     sg.setEndRes(6);
 158     bs.clear();
 159     seqCount = avc.findColumnsWithFeature("Metal", sg, bs);
 160     assertEquals(1, seqCount);
 161     assertEquals(2, bs.cardinality());
 162     assertTrue(bs.get(5));
 163     assertTrue(bs.get(6));
 164
 165     /*
 166      * columns 11-13 should not match disulfide bond at 8/12
 167      */
 168     sg.setStartRes(10);
 169     sg.setEndRes(12);
 170     bs.clear();
 171     seqCount = avc.findColumnsWithFeature("disulfide bond", sg, bs);
 172     assertEquals(0, seqCount);
 173     assertEquals(0, bs.cardinality());
 174
 175     /*
 176      * columns 6-18 should match disulfide bond at columns 9, 14
 177      */
 178     sg.setStartRes(5);
 179     sg.setEndRes(17);
 180     bs.clear();
 181     seqCount = avc.findColumnsWithFeature("disulfide bond", sg, bs);
 182     assertEquals(1, seqCount);
 183     assertEquals(2, bs.cardinality());
 184     assertTrue(bs.get(8));
 185     assertTrue(bs.get(13));
 186
 187     /*
 188      * look for a feature that isn't there
 189      */
 190     sg.setStartRes(0);
 191     sg.setEndRes(19);
 192     bs.clear();
 193     seqCount = avc.findColumnsWithFeature("Pfam", sg, bs);
 194     assertEquals(0, seqCount);
 195     assertEquals(0, bs.cardinality());
 196   }
 197
 198   /**
 199    * shameless copy of test data from findFeature for testing mark columns from
 200    * highlight
 201    */
 202   @Test(groups = "Functional")
 203   public void testSelectColumnsWithHighlight()
 204   {
 205     AlignFrame af = new FileLoader().LoadFileWaitTillLoaded(
 206             "seq1 aMMMaaaaaaaaaaaaaaaa\n" + "seq2 aaaMMMMMMMaaaaaaaaaa\n"
 207                     + "seq3 aaaaaaaaaaMMMMMaaaaa\n"
 208                     + "seq4 aaaaaaaaaaaaaaaaaaaa\n", DataSourceType.PASTE);
 209
 210     SearchResultsI sr = new SearchResults();
 211     SequenceI[] sqs = af.getViewport().getAlignment().getSequencesArray();
 212     SequenceI seq1 = sqs[0];
 213     SequenceI seq2 = sqs[1];
 214     SequenceI seq3 = sqs[2];
 215     SequenceI seq4 = sqs[3];
 216
 217     /*
 218      * features start/end are base 1
 219      */
 220     sr.addResult(seq1, 2, 4);
 221     sr.addResult(seq2, 4, 10);
 222     sr.addResult(seq3, 11, 15);
 223
 224     /*
 225      *  test Match/Find works first
 226      */
 227     FinderI f = new Finder(af.getViewport());
 228     f.findAll("M+", true, false);
 229     assertEquals(
 230             "Finder found different set of results to manually created SearchResults",
 231             sr, f.getSearchResults());
 232
 233     /*
 234      * now check simple mark columns from find operation
 235      */
 236     af.getViewport().setSearchResults(sr);
 237     AlignViewControllerI avc = af.avc;
 238
 239     avc.markHighlightedColumns(false, false, false);
 240     assertTrue("Didn't select highlighted columns", Arrays.deepEquals(af
 241             .getViewport().getColumnSelection().getSelectedRanges()
 242             .toArray(), new int[][] { { 1, 14 } }));
 243   }
 244 }