test/jalview/gui/PopupMenuTest.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.gui;
  22
  23 import static jalview.util.UrlConstants.DB_ACCESSION;
  24 import static jalview.util.UrlConstants.SEQUENCE_ID;
  25 import static org.testng.AssertJUnit.assertEquals;
  26 import static org.testng.AssertJUnit.assertFalse;
  27 import static org.testng.AssertJUnit.assertTrue;
  28
  29 import jalview.bin.Cache;
  30 import jalview.datamodel.AlignmentAnnotation;
  31 import jalview.datamodel.AlignmentI;
  32 import jalview.datamodel.Annotation;
  33 import jalview.datamodel.ColumnSelection;
  34 import jalview.datamodel.DBRefEntry;
  35 import jalview.datamodel.DBRefSource;
  36 import jalview.datamodel.HiddenColumns;
  37 import jalview.datamodel.Sequence;
  38 import jalview.datamodel.SequenceFeature;
  39 import jalview.datamodel.SequenceGroup;
  40 import jalview.datamodel.SequenceI;
  41 import jalview.io.DataSourceType;
  42 import jalview.io.FileFormat;
  43 import jalview.io.FormatAdapter;
  44 import jalview.urls.api.UrlProviderFactoryI;
  45 import jalview.urls.desktop.DesktopUrlProviderFactory;
  46 import jalview.util.MessageManager;
  47 import jalview.util.UrlConstants;
  48
  49 import java.awt.Component;
  50 import java.io.IOException;
  51 import java.util.ArrayList;
  52 import java.util.Collections;
  53 import java.util.Iterator;
  54 import java.util.List;
  55
  56 import javax.swing.JMenu;
  57 import javax.swing.JMenuItem;
  58 import javax.swing.JPopupMenu;
  59 import javax.swing.JSeparator;
  60
  61 import org.testng.annotations.BeforeClass;
  62 import org.testng.annotations.BeforeMethod;
  63 import org.testng.annotations.Test;
  64
  65 public class PopupMenuTest
  66 {
  67
  68   @BeforeClass(alwaysRun = true)
  69   public void setUpJvOptionPane()
  70   {
  71     JvOptionPane.setInteractiveMode(false);
  72     JvOptionPane.setMockResponse(JvOptionPane.CANCEL_OPTION);
  73   }
  74
  75   // 4 sequences x 13 positions
  76   final static String TEST_DATA = ">FER_CAPAA Ferredoxin\n"
  77           + "TIETHKEAELVG-\n"
  78           + ">FER_CAPAN Ferredoxin, chloroplast precursor\n"
  79           + "TIETHKEAELVG-\n"
  80           + ">FER1_SOLLC Ferredoxin-1, chloroplast precursor\n"
  81           + "TIETHKEEELTA-\n" + ">Q93XJ9_SOLTU Ferredoxin I precursor\n"
  82           + "TIETHKEEELTA-\n";
  83
  84   AlignmentI alignment;
  85
  86   AlignmentPanel parentPanel;
  87
  88   PopupMenu testee = null;
  89
  90   @BeforeMethod(alwaysRun = true)
  91   public void setUp() throws IOException
  92   {
  93     Cache.loadProperties("test/jalview/io/testProps.jvprops");
  94     Cache.initLogger();
  95
  96     String inMenuString = ("EMBL-EBI Search | http://www.ebi.ac.uk/ebisearch/search.ebi?db=allebi&query=$"
  97             + SEQUENCE_ID
  98             + "$"
  99             + "|"
 100             + "UNIPROT | http://www.uniprot.org/uniprot/$" + DB_ACCESSION + "$")
 101             + "|"
 102             + ("INTERPRO | http://www.ebi.ac.uk/interpro/entry/$"
 103                     + DB_ACCESSION + "$")
 104             + "|"
 105             +
 106             // Gene3D entry tests for case (in)sensitivity
 107             ("Gene3D | http://gene3d.biochem.ucl.ac.uk/Gene3D/search?sterm=$"
 108                     + DB_ACCESSION + "$&mode=protein");
 109
 110     UrlProviderFactoryI factory = new DesktopUrlProviderFactory(
 111             UrlConstants.DEFAULT_LABEL, inMenuString, "");
 112     Preferences.sequenceUrlLinks = factory.createUrlProvider();
 113
 114     alignment = new FormatAdapter().readFile(TEST_DATA,
 115             DataSourceType.PASTE, FileFormat.Fasta);
 116     AlignFrame af = new AlignFrame(alignment, 700, 500);
 117     parentPanel = new AlignmentPanel(af, af.getViewport());
 118     testee = new PopupMenu(parentPanel, alignment.getSequenceAt(0), null);
 119     int i = 0;
 120     for (SequenceI seq : alignment.getSequences())
 121     {
 122       final AlignmentAnnotation annotation = new AlignmentAnnotation(
 123               "label" + i, "desc" + i, i);
 124       annotation.setCalcId("calcId" + i);
 125       seq.addAlignmentAnnotation(annotation);
 126       annotation.setSequenceRef(seq);
 127     }
 128   }
 129
 130   @Test(groups = { "Functional" })
 131   public void testConfigureReferenceAnnotationsMenu_noSequenceSelected()
 132   {
 133     JMenuItem menu = new JMenuItem();
 134     List<SequenceI> seqs = new ArrayList<>();
 135     testee.configureReferenceAnnotationsMenu(menu, seqs);
 136     assertFalse(menu.isEnabled());
 137     // now try null list
 138     menu.setEnabled(true);
 139     testee.configureReferenceAnnotationsMenu(menu, null);
 140     assertFalse(menu.isEnabled());
 141   }
 142
 143   /**
 144    * Test building the 'add reference annotations' menu for the case where there
 145    * are no reference annotations to add to the alignment. The menu item should
 146    * be disabled.
 147    */
 148   @Test(groups = { "Functional" })
 149   public void testConfigureReferenceAnnotationsMenu_noReferenceAnnotations()
 150   {
 151     JMenuItem menu = new JMenuItem();
 152
 153     /*
 154      * Initial state is that sequences have annotations, and have dataset
 155      * sequences, but the dataset sequences have no annotations. Hence nothing
 156      * to add.
 157      */
 158     List<SequenceI> seqs = parentPanel.getAlignment().getSequences();
 159
 160     testee.configureReferenceAnnotationsMenu(menu, seqs);
 161     assertFalse(menu.isEnabled());
 162   }
 163
 164   /**
 165    * Test building the 'add reference annotations' menu for the case where all
 166    * reference annotations are already on the alignment. The menu item should be
 167    * disabled.
 168    */
 169   @Test(groups = { "Functional" })
 170   public void testConfigureReferenceAnnotationsMenu_alreadyAdded()
 171   {
 172     JMenuItem menu = new JMenuItem();
 173     List<SequenceI> seqs = parentPanel.getAlignment().getSequences();
 174
 175     // make up new annotations and add to dataset sequences, sequences and
 176     // alignment
 177     attachReferenceAnnotations(seqs, true, true);
 178
 179     testee.configureReferenceAnnotationsMenu(menu, seqs);
 180     assertFalse(menu.isEnabled());
 181   }
 182
 183   /**
 184    * Test building the 'add reference annotations' menu for the case where
 185    * several reference annotations are on the dataset but not on the sequences.
 186    * The menu item should be enabled, and acquire a tooltip which lists the
 187    * annotation sources (calcIds) and type (labels).
 188    */
 189   @Test(groups = { "Functional" })
 190   public void testConfigureReferenceAnnotationsMenu()
 191   {
 192     JMenuItem menu = new JMenuItem();
 193     List<SequenceI> seqs = parentPanel.getAlignment().getSequences();
 194
 195     // make up new annotations and add to dataset sequences
 196     attachReferenceAnnotations(seqs, false, false);
 197
 198     testee.configureReferenceAnnotationsMenu(menu, seqs);
 199     assertTrue(menu.isEnabled());
 200     String s = MessageManager.getString("label.add_annotations_for");
 201     String expected = "<html><style> p.ttip {width: 350; text-align: justify; word-wrap: break-word;}</style><p class=\"ttip\">"
 202             + s + "<br/>Jmol/secondary structure<br/>PDB/Temp</p></html>";
 203     assertEquals(expected, menu.getToolTipText());
 204   }
 205
 206   /**
 207    * Test building the 'add reference annotations' menu for the case where
 208    * several reference annotations are on the dataset and the sequences but not
 209    * on the alignment. The menu item should be enabled, and acquire a tooltip
 210    * which lists the annotation sources (calcIds) and type (labels).
 211    */
 212   @Test(groups = { "Functional" })
 213   public void testConfigureReferenceAnnotationsMenu_notOnAlignment()
 214   {
 215     JMenuItem menu = new JMenuItem();
 216     List<SequenceI> seqs = parentPanel.getAlignment().getSequences();
 217
 218     // make up new annotations and add to dataset sequences and sequences
 219     attachReferenceAnnotations(seqs, true, false);
 220
 221     testee.configureReferenceAnnotationsMenu(menu, seqs);
 222     assertTrue(menu.isEnabled());
 223     String s = MessageManager.getString("label.add_annotations_for");
 224     String expected = "<html><style> p.ttip {width: 350; text-align: justify; word-wrap: break-word;}</style><p class=\"ttip\">"
 225             + s + "<br/>Jmol/secondary structure<br/>PDB/Temp</p></html>";
 226     assertEquals(expected, menu.getToolTipText());
 227   }
 228
 229   /**
 230    * Generate annotations and add to dataset sequences and (optionally)
 231    * sequences and/or alignment
 232    *
 233    * @param seqs
 234    * @param addToSequence
 235    * @param addToAlignment
 236    */
 237   private void attachReferenceAnnotations(List<SequenceI> seqs,
 238           boolean addToSequence, boolean addToAlignment)
 239   {
 240     // PDB.secondary structure on Sequence0
 241     AlignmentAnnotation annotation = new AlignmentAnnotation(
 242             "secondary structure", "", 0);
 243     annotation.annotations = new Annotation[] { new Annotation(2f) };
 244     annotation.setCalcId("PDB");
 245     seqs.get(0).getDatasetSequence().addAlignmentAnnotation(annotation);
 246     if (addToSequence)
 247     {
 248       seqs.get(0).addAlignmentAnnotation(annotation);
 249     }
 250     if (addToAlignment)
 251     {
 252       this.alignment.addAnnotation(annotation);
 253     }
 254
 255     // PDB.Temp on Sequence1
 256     annotation = new AlignmentAnnotation("Temp", "", 0);
 257     annotation.setCalcId("PDB");
 258     annotation.annotations = new Annotation[] { new Annotation(2f) };
 259     seqs.get(1).getDatasetSequence().addAlignmentAnnotation(annotation);
 260     if (addToSequence)
 261     {
 262       seqs.get(1).addAlignmentAnnotation(annotation);
 263     }
 264     if (addToAlignment)
 265     {
 266       this.alignment.addAnnotation(annotation);
 267     }
 268
 269     // JMOL.secondary structure on Sequence0
 270     annotation = new AlignmentAnnotation("secondary structure", "", 0);
 271     annotation.setCalcId("Jmol");
 272     annotation.annotations = new Annotation[] { new Annotation(2f) };
 273     seqs.get(0).getDatasetSequence().addAlignmentAnnotation(annotation);
 274     if (addToSequence)
 275     {
 276       seqs.get(0).addAlignmentAnnotation(annotation);
 277     }
 278     if (addToAlignment)
 279     {
 280       this.alignment.addAnnotation(annotation);
 281     }
 282   }
 283
 284   /**
 285    * Test building the 'add reference annotations' menu for the case where there
 286    * are two alignment views:
 287    * <ul>
 288    * <li>in one view, reference annotations have been added (are on the
 289    * datasets, sequences and alignment)</li>
 290    * <li>in the current view, reference annotations are on the dataset and
 291    * sequence, but not the alignment</li>
 292    * </ul>
 293    * The menu item should be enabled, and acquire a tooltip which lists the
 294    * annotation sources (calcIds) and type (labels).
 295    */
 296   @Test(groups = { "Functional" })
 297   public void testConfigureReferenceAnnotationsMenu_twoViews()
 298   {
 299   }
 300
 301   /**
 302    * Test for building menu options including 'show' and 'hide' annotation
 303    * types.
 304    */
 305   @Test(groups = { "Functional" })
 306   public void testBuildAnnotationTypesMenus()
 307   {
 308     JMenu showMenu = new JMenu();
 309     JMenu hideMenu = new JMenu();
 310     List<SequenceI> seqs = parentPanel.getAlignment().getSequences();
 311
 312     // make up new annotations and add to sequences and to the alignment
 313
 314     // PDB.secondary structure on Sequence0
 315     AlignmentAnnotation annotation = new AlignmentAnnotation(
 316             "secondary structure", "", new Annotation[] {});
 317     annotation.setCalcId("PDB");
 318     annotation.visible = true;
 319     seqs.get(0).addAlignmentAnnotation(annotation);
 320     parentPanel.getAlignment().addAnnotation(annotation);
 321
 322     // JMOL.secondary structure on Sequence0 - hidden
 323     annotation = new AlignmentAnnotation("secondary structure", "",
 324             new Annotation[] {});
 325     annotation.setCalcId("JMOL");
 326     annotation.visible = false;
 327     seqs.get(0).addAlignmentAnnotation(annotation);
 328     parentPanel.getAlignment().addAnnotation(annotation);
 329
 330     // Jpred.SSP on Sequence0 - hidden
 331     annotation = new AlignmentAnnotation("SSP", "", new Annotation[] {});
 332     annotation.setCalcId("JPred");
 333     annotation.visible = false;
 334     seqs.get(0).addAlignmentAnnotation(annotation);
 335     parentPanel.getAlignment().addAnnotation(annotation);
 336
 337     // PDB.Temp on Sequence1
 338     annotation = new AlignmentAnnotation("Temp", "", new Annotation[] {});
 339     annotation.setCalcId("PDB");
 340     annotation.visible = true;
 341     seqs.get(1).addAlignmentAnnotation(annotation);
 342     parentPanel.getAlignment().addAnnotation(annotation);
 343
 344     /*
 345      * Expect menu options to show "secondary structure" and "SSP", and to hide
 346      * "secondary structure" and "Temp". Tooltip should be calcId.
 347      */
 348     testee.buildAnnotationTypesMenus(showMenu, hideMenu, seqs);
 349
 350     assertTrue(showMenu.isEnabled());
 351     assertTrue(hideMenu.isEnabled());
 352
 353     Component[] showOptions = showMenu.getMenuComponents();
 354     Component[] hideOptions = hideMenu.getMenuComponents();
 355
 356     assertEquals(4, showOptions.length); // includes 'All' and separator
 357     assertEquals(4, hideOptions.length);
 358     String all = MessageManager.getString("label.all");
 359     assertEquals(all, ((JMenuItem) showOptions[0]).getText());
 360     assertTrue(showOptions[1] instanceof JPopupMenu.Separator);
 361     assertEquals(JSeparator.HORIZONTAL,
 362             ((JSeparator) showOptions[1]).getOrientation());
 363     assertEquals("secondary structure",
 364             ((JMenuItem) showOptions[2]).getText());
 365     assertEquals("JMOL", ((JMenuItem) showOptions[2]).getToolTipText());
 366     assertEquals("SSP", ((JMenuItem) showOptions[3]).getText());
 367     assertEquals("JPred", ((JMenuItem) showOptions[3]).getToolTipText());
 368
 369     assertEquals(all, ((JMenuItem) hideOptions[0]).getText());
 370     assertTrue(hideOptions[1] instanceof JPopupMenu.Separator);
 371     assertEquals(JSeparator.HORIZONTAL,
 372             ((JSeparator) hideOptions[1]).getOrientation());
 373     assertEquals("secondary structure",
 374             ((JMenuItem) hideOptions[2]).getText());
 375     assertEquals("PDB", ((JMenuItem) hideOptions[2]).getToolTipText());
 376     assertEquals("Temp", ((JMenuItem) hideOptions[3]).getText());
 377     assertEquals("PDB", ((JMenuItem) hideOptions[3]).getToolTipText());
 378   }
 379
 380   /**
 381    * Test for building menu options with only 'hide' annotation types enabled.
 382    */
 383   @Test(groups = { "Functional" })
 384   public void testBuildAnnotationTypesMenus_showDisabled()
 385   {
 386     JMenu showMenu = new JMenu();
 387     JMenu hideMenu = new JMenu();
 388     List<SequenceI> seqs = parentPanel.getAlignment().getSequences();
 389
 390     // make up new annotations and add to sequences and to the alignment
 391
 392     // PDB.secondary structure on Sequence0
 393     AlignmentAnnotation annotation = new AlignmentAnnotation(
 394             "secondary structure", "", new Annotation[] {});
 395     annotation.setCalcId("PDB");
 396     annotation.visible = true;
 397     seqs.get(0).addAlignmentAnnotation(annotation);
 398     parentPanel.getAlignment().addAnnotation(annotation);
 399
 400     // PDB.Temp on Sequence1
 401     annotation = new AlignmentAnnotation("Temp", "", new Annotation[] {});
 402     annotation.setCalcId("PDB");
 403     annotation.visible = true;
 404     seqs.get(1).addAlignmentAnnotation(annotation);
 405     parentPanel.getAlignment().addAnnotation(annotation);
 406
 407     /*
 408      * Expect menu options to hide "secondary structure" and "Temp". Tooltip
 409      * should be calcId. 'Show' menu should be disabled.
 410      */
 411     testee.buildAnnotationTypesMenus(showMenu, hideMenu, seqs);
 412
 413     assertFalse(showMenu.isEnabled());
 414     assertTrue(hideMenu.isEnabled());
 415
 416     Component[] showOptions = showMenu.getMenuComponents();
 417     Component[] hideOptions = hideMenu.getMenuComponents();
 418
 419     assertEquals(2, showOptions.length); // includes 'All' and separator
 420     assertEquals(4, hideOptions.length);
 421     String all = MessageManager.getString("label.all");
 422     assertEquals(all, ((JMenuItem) showOptions[0]).getText());
 423     assertTrue(showOptions[1] instanceof JPopupMenu.Separator);
 424     assertEquals(JSeparator.HORIZONTAL,
 425             ((JSeparator) showOptions[1]).getOrientation());
 426
 427     assertEquals(all, ((JMenuItem) hideOptions[0]).getText());
 428     assertTrue(hideOptions[1] instanceof JPopupMenu.Separator);
 429     assertEquals(JSeparator.HORIZONTAL,
 430             ((JSeparator) hideOptions[1]).getOrientation());
 431     assertEquals("secondary structure",
 432             ((JMenuItem) hideOptions[2]).getText());
 433     assertEquals("PDB", ((JMenuItem) hideOptions[2]).getToolTipText());
 434     assertEquals("Temp", ((JMenuItem) hideOptions[3]).getText());
 435     assertEquals("PDB", ((JMenuItem) hideOptions[3]).getToolTipText());
 436   }
 437
 438   /**
 439    * Test for building menu options with only 'show' annotation types enabled.
 440    */
 441   @Test(groups = { "Functional" })
 442   public void testBuildAnnotationTypesMenus_hideDisabled()
 443   {
 444     JMenu showMenu = new JMenu();
 445     JMenu hideMenu = new JMenu();
 446     List<SequenceI> seqs = parentPanel.getAlignment().getSequences();
 447
 448     // make up new annotations and add to sequences and to the alignment
 449
 450     // PDB.secondary structure on Sequence0
 451     AlignmentAnnotation annotation = new AlignmentAnnotation(
 452             "secondary structure", "", new Annotation[] {});
 453     annotation.setCalcId("PDB");
 454     annotation.visible = false;
 455     seqs.get(0).addAlignmentAnnotation(annotation);
 456     parentPanel.getAlignment().addAnnotation(annotation);
 457
 458     // PDB.Temp on Sequence1
 459     annotation = new AlignmentAnnotation("Temp", "", new Annotation[] {});
 460     annotation.setCalcId("PDB2");
 461     annotation.visible = false;
 462     seqs.get(1).addAlignmentAnnotation(annotation);
 463     parentPanel.getAlignment().addAnnotation(annotation);
 464
 465     /*
 466      * Expect menu options to show "secondary structure" and "Temp". Tooltip
 467      * should be calcId. 'hide' menu should be disabled.
 468      */
 469     testee.buildAnnotationTypesMenus(showMenu, hideMenu, seqs);
 470
 471     assertTrue(showMenu.isEnabled());
 472     assertFalse(hideMenu.isEnabled());
 473
 474     Component[] showOptions = showMenu.getMenuComponents();
 475     Component[] hideOptions = hideMenu.getMenuComponents();
 476
 477     assertEquals(4, showOptions.length); // includes 'All' and separator
 478     assertEquals(2, hideOptions.length);
 479     String all = MessageManager.getString("label.all");
 480     assertEquals(all, ((JMenuItem) showOptions[0]).getText());
 481     assertTrue(showOptions[1] instanceof JPopupMenu.Separator);
 482     assertEquals(JSeparator.HORIZONTAL,
 483             ((JSeparator) showOptions[1]).getOrientation());
 484     assertEquals("secondary structure",
 485             ((JMenuItem) showOptions[2]).getText());
 486     assertEquals("PDB", ((JMenuItem) showOptions[2]).getToolTipText());
 487     assertEquals("Temp", ((JMenuItem) showOptions[3]).getText());
 488     assertEquals("PDB2", ((JMenuItem) showOptions[3]).getToolTipText());
 489
 490     assertEquals(all, ((JMenuItem) hideOptions[0]).getText());
 491     assertTrue(hideOptions[1] instanceof JPopupMenu.Separator);
 492     assertEquals(JSeparator.HORIZONTAL,
 493             ((JSeparator) hideOptions[1]).getOrientation());
 494   }
 495
 496   /**
 497    * Test for adding sequence id, dbref and feature links
 498    */
 499   @Test(groups = { "Functional" })
 500   public void testBuildLinkMenu()
 501   {
 502     List<SequenceI> seqs = parentPanel.getAlignment().getSequences();
 503     final SequenceI seq0 = seqs.get(0);
 504     final SequenceI seq1 = seqs.get(1);
 505     final List<SequenceFeature> noFeatures = Collections
 506             .<SequenceFeature> emptyList();
 507     final String linkText = MessageManager.getString("action.link");
 508
 509     seq0.addDBRef(new DBRefEntry(DBRefSource.UNIPROT, "1", "P83527"));
 510     seq0.addDBRef(new DBRefEntry("INTERPRO", "1", "IPR001041"));
 511     seq0.addDBRef(new DBRefEntry("INTERPRO", "1", "IPR012675"));
 512     seq0.addDBRef(new DBRefEntry("INTERPRO", "1", "IPR006058"));
 513     seq1.addDBRef(new DBRefEntry(DBRefSource.UNIPROT, "1", "Q9ZTS2"));
 514     seq1.addDBRef(new DBRefEntry("GENE3D", "1", "3.10.20.30"));
 515
 516     /*
 517      * check the Link Menu for the first sequence
 518      */
 519     JMenu linkMenu = PopupMenu.buildLinkMenu(seq0, noFeatures);
 520     assertEquals(linkText, linkMenu.getText());
 521     Component[] linkItems = linkMenu.getMenuComponents();
 522
 523     /*
 524      * menu items are ordered: SEQUENCE_ID search first, then dbrefs in order
 525      * of database name (and within that by order of dbref addition)
 526      */
 527     assertEquals(5, linkItems.length);
 528     assertEquals("EMBL-EBI Search", ((JMenuItem) linkItems[0]).getText());
 529     assertEquals("INTERPRO|IPR001041",
 530             ((JMenuItem) linkItems[1]).getText());
 531     assertEquals("INTERPRO|IPR012675",
 532             ((JMenuItem) linkItems[2]).getText());
 533     assertEquals("INTERPRO|IPR006058",
 534             ((JMenuItem) linkItems[3]).getText());
 535     assertEquals("UNIPROT|P83527", ((JMenuItem) linkItems[4]).getText());
 536
 537     /*
 538      * check the Link Menu for the second sequence
 539      * note dbref GENE3D is matched to link Gene3D, the latter is displayed
 540      */
 541     linkMenu = PopupMenu.buildLinkMenu(seq1, noFeatures);
 542     linkItems = linkMenu.getMenuComponents();
 543     assertEquals(3, linkItems.length);
 544     assertEquals("EMBL-EBI Search", ((JMenuItem) linkItems[0]).getText());
 545     assertEquals("Gene3D|3.10.20.30", ((JMenuItem) linkItems[1]).getText());
 546     assertEquals("UNIPROT|Q9ZTS2", ((JMenuItem) linkItems[2]).getText());
 547
 548     /*
 549      * if there are no valid links the Links submenu is still shown, but
 550      * reduced to the EMBL-EBI lookup only (inserted by
 551      * CustomUrlProvider.choosePrimaryUrl())
 552      */
 553     String unmatched = "NOMATCH|http://www.uniprot.org/uniprot/$"
 554             + DB_ACCESSION + "$";
 555     UrlProviderFactoryI factory = new DesktopUrlProviderFactory(null,
 556             unmatched, "");
 557     Preferences.sequenceUrlLinks = factory.createUrlProvider();
 558
 559     linkMenu = PopupMenu.buildLinkMenu(seq1, noFeatures);
 560     linkItems = linkMenu.getMenuComponents();
 561     assertEquals(1, linkItems.length);
 562     assertEquals("EMBL-EBI Search", ((JMenuItem) linkItems[0]).getText());
 563
 564     /*
 565      * if sequence is null, only feature links are shown (alignment popup submenu)
 566      */
 567     linkMenu = PopupMenu.buildLinkMenu(null, noFeatures);
 568     linkItems = linkMenu.getMenuComponents();
 569     assertEquals(0, linkItems.length);
 570
 571     List<SequenceFeature> features = new ArrayList<>();
 572     SequenceFeature sf = new SequenceFeature("type", "desc", 1, 20, null);
 573     features.add(sf);
 574     linkMenu = PopupMenu.buildLinkMenu(null, features);
 575     linkItems = linkMenu.getMenuComponents();
 576     assertEquals(0, linkItems.length); // feature has no links
 577
 578     sf.addLink("Pfam family|http://pfam.xfam.org/family/PF00111");
 579     linkMenu = PopupMenu.buildLinkMenu(null, features);
 580     linkItems = linkMenu.getMenuComponents();
 581     assertEquals(1, linkItems.length);
 582     JMenuItem item = (JMenuItem) linkItems[0];
 583     assertEquals("Pfam family", item.getText());
 584     // ? no way to verify URL, compiled into link's actionListener
 585   }
 586
 587   @Test(groups = { "Functional" })
 588   public void testHideInsertions()
 589   {
 590     // get sequences from the alignment
 591     List<SequenceI> seqs = parentPanel.getAlignment().getSequences();
 592
 593     // add our own seqs to avoid problems with changes to existing sequences
 594     // (gap at end of sequences varies depending on how tests are run!)
 595     Sequence seqGap1 = new Sequence("GappySeq",
 596             "AAAA----AA-AAAAAAA---AAA-----------AAAAAAAAAA--");
 597     seqGap1.createDatasetSequence();
 598     seqs.add(seqGap1);
 599     Sequence seqGap2 = new Sequence("LessGappySeq",
 600             "AAAAAA-AAAAA---AAA--AAAAA--AAAAAAA-AAAAAA");
 601     seqGap2.createDatasetSequence();
 602     seqs.add(seqGap2);
 603     Sequence seqGap3 = new Sequence("AnotherGapSeq",
 604             "AAAAAA-AAAAAA--AAAAAA-AAAAAAAAAAA---AAAAAAAA");
 605     seqGap3.createDatasetSequence();
 606     seqs.add(seqGap3);
 607     Sequence seqGap4 = new Sequence("NoGaps",
 608             "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA");
 609     seqGap4.createDatasetSequence();
 610     seqs.add(seqGap4);
 611
 612     ColumnSelection sel = new ColumnSelection();
 613     parentPanel.av.getAlignment().getHiddenColumns()
 614             .revealAllHiddenColumns(sel);
 615
 616     // get the Popup Menu for 7th sequence - no insertions
 617     testee = new PopupMenu(parentPanel, seqs.get(7), null);
 618     testee.hideInsertions_actionPerformed(null);
 619
 620     HiddenColumns hidden = parentPanel.av.getAlignment().getHiddenColumns();
 621     Iterator<int[]> it = hidden.iterator();
 622     assertFalse(it.hasNext());
 623
 624     // get the Popup Menu for GappySeq - this time we have insertions
 625     testee = new PopupMenu(parentPanel, seqs.get(4), null);
 626     testee.hideInsertions_actionPerformed(null);
 627     hidden = parentPanel.av.getAlignment().getHiddenColumns();
 628     it = hidden.iterator();
 629
 630     assertTrue(it.hasNext());
 631     int[] region = it.next();
 632     assertEquals(region[0], 4);
 633     assertEquals(region[1], 7);
 634
 635     assertTrue(it.hasNext());
 636     region = it.next();
 637     assertEquals(region[0], 10);
 638     assertEquals(region[1], 10);
 639
 640     assertTrue(it.hasNext());
 641     region = it.next();
 642     assertEquals(region[0], 18);
 643     assertEquals(region[1], 20);
 644
 645     assertTrue(it.hasNext());
 646     region = it.next();
 647     assertEquals(region[0], 24);
 648     assertEquals(region[1], 34);
 649
 650     assertTrue(it.hasNext());
 651     region = it.next();
 652     assertEquals(region[0], 45);
 653     assertEquals(region[1], 46);
 654
 655     assertFalse(it.hasNext());
 656
 657     sel = new ColumnSelection();
 658     hidden.revealAllHiddenColumns(sel);
 659
 660     // make a sequence group and hide insertions within the group
 661     SequenceGroup sg = new SequenceGroup();
 662     sg.setStartRes(8);
 663     sg.setEndRes(42);
 664     sg.addSequence(seqGap2, false);
 665     sg.addSequence(seqGap3, false);
 666     parentPanel.av.setSelectionGroup(sg);
 667
 668     // hide columns outside and within selection
 669     // only hidden columns outside the collection will be retained (unless also
 670     // gaps in the selection)
 671     hidden.hideColumns(1, 10);
 672     hidden.hideColumns(31, 40);
 673
 674     // get the Popup Menu for LessGappySeq in the sequence group
 675     testee = new PopupMenu(parentPanel, seqs.get(5), null);
 676     testee.hideInsertions_actionPerformed(null);
 677     hidden = parentPanel.av.getAlignment().getHiddenColumns();
 678     it = hidden.iterator();
 679
 680     assertTrue(it.hasNext());
 681     region = it.next();
 682     assertEquals(region[0], 1);
 683     assertEquals(region[1], 7);
 684
 685     assertTrue(it.hasNext());
 686     region = it.next();
 687     assertEquals(region[0], 13);
 688     assertEquals(region[1], 14);
 689
 690     assertTrue(it.hasNext());
 691     region = it.next();
 692     assertEquals(region[0], 34);
 693     assertEquals(region[1], 34);
 694   }
 695
 696 }