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", "aa--aMM-MMMMMaaaaaaaaaa");
  64     SequenceI seq3 = new Sequence("seq3", "abcab-caD-aaMMMMMaaaaa");
  65     SequenceI seq4 = new Sequence("seq4", "abc--abcaaaaaaaaaaaaaa");
  66
  67     /*
  68      * features start/end are base 1
  69      */
  70     seq1.addSequenceFeature(new SequenceFeature("Metal", "desc", 2, 4, 0f,
  71             null));
  72     seq1.addSequenceFeature(new SequenceFeature("Helix", "desc", 1, 15, 0f,
  73             null));
  74     seq2.addSequenceFeature(new SequenceFeature("Metal", "desc", 4, 10,
  75             10f,
  76             null));
  77     seq3.addSequenceFeature(new SequenceFeature("Metal", "desc", 11, 15,
  78             10f, null));
  79     // disulfide bond is a 'contact feature' - only select its 'start' and 'end'
  80     seq3.addSequenceFeature(new SequenceFeature("disulfide bond", "desc",
  81             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     AlignFrame af = new AlignFrame(new Alignment(new SequenceI[] { seq1,
  98         seq2, seq3, seq4 }), 100, 100);
  99     af.getFeatureRenderer().findAllFeatures(true);
 100
 101     AlignViewController avc = new AlignViewController(af, af.getViewport(),
 102             af.alignPanel);
 103
 104     BitSet bs = new BitSet();
 105     int seqCount = avc.findColumnsWithFeature("Metal", sg, bs);
 106     assertEquals(1, seqCount);
 107     assertEquals(2, bs.cardinality());
 108     assertTrue(bs.get(3)); // base 0
 109     assertTrue(bs.get(4));
 110
 111     /*
 112      * select the first seven columns: Metal in seq1 cols 4-6, seq2 cols 6-7
 113      */
 114     sg.setEndRes(6);
 115     bs.clear();
 116     seqCount = avc.findColumnsWithFeature("Metal", sg, bs);
 117     assertEquals(2, seqCount);
 118     assertEquals(4, bs.cardinality());
 119     assertTrue(bs.get(3));
 120     assertTrue(bs.get(4));
 121     assertTrue(bs.get(5));
 122     assertTrue(bs.get(6));
 123
 124     /*
 125      * select column 14: Metal in seq3 only
 126      */
 127     sg.setStartRes(13);
 128     sg.setEndRes(13);
 129     bs.clear();
 130     seqCount = avc.findColumnsWithFeature("Metal", sg, bs);
 131     assertEquals(1, seqCount);
 132     assertEquals(1, bs.cardinality());
 133     assertTrue(bs.get(13));
 134
 135     /*
 136      * select columns 18-20: no Metal feature
 137      */
 138     sg.setStartRes(17);
 139     sg.setEndRes(19);
 140     bs.clear();
 141     seqCount = avc.findColumnsWithFeature("Metal", sg, bs);
 142     assertEquals(0, seqCount);
 143     assertEquals(0, bs.cardinality());
 144
 145     /*
 146      * threshold Metal to hide where score < 5
 147      * seq1 feature in columns 4-6 is hidden
 148      * seq2 feature in columns 6-7 is shown
 149      */
 150     FeatureColourI fc = new FeatureColour(null, Color.red, Color.blue, null,
 151             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("Metal", sg, bs);
 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("disulfide bond", sg, bs);
 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("disulfide bond", sg, bs);
 181     assertEquals(1, seqCount);
 182     assertEquals(2, bs.cardinality());
 183     assertTrue(bs.get(8));
 184     assertTrue(bs.get(13));
 185
 186     /*
 187      * look for a feature that isn't there
 188      */
 189     sg.setStartRes(0);
 190     sg.setEndRes(19);
 191     bs.clear();
 192     seqCount = avc.findColumnsWithFeature("Pfam", sg, bs);
 193     assertEquals(0, seqCount);
 194     assertEquals(0, bs.cardinality());
 195   }
 196
 197   /**
 198    * shameless copy of test data from findFeature for testing mark columns from
 199    * highlight
 200    */
 201   @Test(groups = "Functional")
 202   public void testSelectColumnsWithHighlight()
 203   {
 204     AlignFrame af = new FileLoader().LoadFileWaitTillLoaded(
 205             "seq1 aMMMaaaaaaaaaaaaaaaa\n" + "seq2 aaaMMMMMMMaaaaaaaaaa\n"
 206                     + "seq3 aaaaaaaaaaMMMMMaaaaa\n"
 207                     + "seq4 aaaaaaaaaaaaaaaaaaaa\n", DataSourceType.PASTE);
 208
 209     SearchResultsI sr = new SearchResults();
 210     SequenceI[] sqs = af.getViewport().getAlignment().getSequencesArray();
 211     SequenceI seq1 = sqs[0];
 212     SequenceI seq2 = sqs[1];
 213     SequenceI seq3 = sqs[2];
 214     SequenceI seq4 = sqs[3];
 215
 216     /*
 217      * features start/end are base 1
 218      */
 219     sr.addResult(seq1, 2, 4);
 220     sr.addResult(seq2, 4, 10);
 221     sr.addResult(seq3, 11, 15);
 222
 223     /*
 224      *  test Match/Find works first
 225      */
 226     Finder f = new Finder(af.getViewport().getAlignment(), null);
 227     f.setFindAll(true);
 228     f.setCaseSensitive(true);
 229     f.find("M+");
 230     assertEquals(
 231             "Finder found different set of results to manually created SearchResults",
 232             sr, f.getSearchResults());
 233
 234     /*
 235      * now check simple mark columns from find operation
 236      */
 237     af.getViewport().setSearchResults(sr);
 238     AlignViewControllerI avc = af.avc;
 239
 240     avc.markHighlightedColumns(false, false, false);
 241     assertTrue("Didn't select highlighted columns", Arrays.deepEquals(af
 242             .getViewport().getColumnSelection().getSelectedRanges()
 243             .toArray(), new int[][] { { 1, 14 } }));
 244   }
 245 }