JAL-1610 check reference annotations against alignment, not sequence
[jalview.git] / test / jalview / gui / PopupMenuTest.java
index 1d219df..f7b1482 100644 (file)
@@ -7,6 +7,7 @@ import jalview.datamodel.AlignmentAnnotation;
 import jalview.datamodel.AlignmentI;
 import jalview.datamodel.SequenceI;
 import jalview.io.AppletFormatAdapter;
+import jalview.io.FormatAdapter;
 import jalview.util.MessageManager;
 
 import java.awt.Component;
@@ -42,7 +43,7 @@ public class PopupMenuTest
   @Before
   public void setUp() throws IOException
   {
-    alignment = new jalview.io.FormatAdapter().readFile(TEST_DATA,
+    alignment = new FormatAdapter().readFile(TEST_DATA,
             AppletFormatAdapter.PASTE, "FASTA");
     AlignFrame af = new AlignFrame(alignment, 700, 500);
     parentPanel = new AlignmentPanel(af, af.getViewport());
@@ -83,14 +84,13 @@ public class PopupMenuTest
   public void testConfigureReferenceAnnotationsMenu_noReferenceAnnotations()
   {
     JMenuItem menu = new JMenuItem();
-    List<SequenceI> seqs = new ArrayList<SequenceI>();
 
     /*
      * Initial state is that sequences have annotations, and have dataset
      * sequences, but the dataset sequences have no annotations. Hence nothing
      * to add.
      */
-    seqs = parentPanel.getAlignment().getSequences();
+    List<SequenceI> seqs = parentPanel.getAlignment().getSequences();
 
     testee.configureReferenceAnnotationsMenu(menu, seqs);
     assertFalse(menu.isEnabled());
@@ -105,12 +105,12 @@ public class PopupMenuTest
   public void testConfigureReferenceAnnotationsMenu_alreadyAdded()
   {
     JMenuItem menu = new JMenuItem();
-    List<SequenceI> seqs = new ArrayList<SequenceI>();
+    List<SequenceI> seqs = parentPanel.getAlignment().getSequences();
+
+    // make up new annotations and add to dataset sequences, sequences and
+    // alignment
+    attachReferenceAnnotations(seqs, true, true);
 
-    seqs = parentPanel.getAlignment().getSequences();
-    // copy annotation from sequence to dataset
-    seqs.get(1).getDatasetSequence()
-            .addAlignmentAnnotation(seqs.get(1).getAnnotation()[0]);
     testee.configureReferenceAnnotationsMenu(menu, seqs);
     assertFalse(menu.isEnabled());
   }
@@ -126,28 +126,104 @@ public class PopupMenuTest
   {
     JMenuItem menu = new JMenuItem();
     List<SequenceI> seqs = parentPanel.getAlignment().getSequences();
+
     // make up new annotations and add to dataset sequences
+    attachReferenceAnnotations(seqs, false, false);
+
+    testee.configureReferenceAnnotationsMenu(menu, seqs);
+    assertTrue(menu.isEnabled());
+    String expected = "<html><table width=350 border=0><tr><td>Add annotations for<br/>JMOL/secondary structure<br/>PBD/Temp</td></tr></table></html>";
+    assertEquals(expected, menu.getToolTipText());
+  }
+
+  /**
+   * Test building the 'add reference annotations' menu for the case where
+   * several reference annotations are on the dataset and the sequences but not
+   * on the alignment. The menu item should be enabled, and acquire a tooltip
+   * which lists the annotation sources (calcIds) and type (labels).
+   */
+  @Test
+  public void testConfigureReferenceAnnotationsMenu_notOnAlignment()
+  {
+    JMenuItem menu = new JMenuItem();
+    List<SequenceI> seqs = parentPanel.getAlignment().getSequences();
+
+    // make up new annotations and add to dataset sequences and sequences
+    attachReferenceAnnotations(seqs, true, false);
+
+    testee.configureReferenceAnnotationsMenu(menu, seqs);
+    assertTrue(menu.isEnabled());
+    String expected = "<html><table width=350 border=0><tr><td>Add annotations for<br/>JMOL/secondary structure<br/>PBD/Temp</td></tr></table></html>";
+    assertEquals(expected, menu.getToolTipText());
+  }
 
+  /**
+   * Generate annotations and add to dataset sequences and (optionally)
+   * sequences and/or alignment
+   * 
+   * @param seqs
+   * @param addToSequence
+   * @param addToAlignment
+   */
+  private void attachReferenceAnnotations(List<SequenceI> seqs,
+          boolean addToSequence, boolean addToAlignment)
+  {
     // PDB.secondary structure on Sequence0
     AlignmentAnnotation annotation = new AlignmentAnnotation(
             "secondary structure", "", 0);
     annotation.setCalcId("PBD");
     seqs.get(0).getDatasetSequence().addAlignmentAnnotation(annotation);
+    if (addToSequence)
+    {
+      seqs.get(0).addAlignmentAnnotation(annotation);
+    }
+    if (addToAlignment)
+    {
+      this.alignment.addAnnotation(annotation);
+    }
 
     // PDB.Temp on Sequence1
     annotation = new AlignmentAnnotation("Temp", "", 0);
     annotation.setCalcId("PBD");
     seqs.get(1).getDatasetSequence().addAlignmentAnnotation(annotation);
+    if (addToSequence)
+    {
+      seqs.get(1).addAlignmentAnnotation(annotation);
+    }
+    if (addToAlignment)
+    {
+      this.alignment.addAnnotation(annotation);
+    }
 
     // JMOL.secondary structure on Sequence0
     annotation = new AlignmentAnnotation("secondary structure", "", 0);
     annotation.setCalcId("JMOL");
     seqs.get(0).getDatasetSequence().addAlignmentAnnotation(annotation);
+    if (addToSequence)
+    {
+      seqs.get(0).addAlignmentAnnotation(annotation);
+    }
+    if (addToAlignment)
+    {
+      this.alignment.addAnnotation(annotation);
+    }
+  }
 
-    testee.configureReferenceAnnotationsMenu(menu, seqs);
-    assertTrue(menu.isEnabled());
-    String expected = "<html><table width=350 border=0><tr><td>Add annotations for<br/>JMOL/secondary structure<br/>PBD/Temp</td></tr></table></html>";
-    assertEquals(expected, menu.getToolTipText());
+  /**
+   * Test building the 'add reference annotations' menu for the case where there
+   * are two alignment views:
+   * <ul>
+   * <li>in one view, reference annotations have been added (are on the
+   * datasets, sequences and alignment)</li>
+   * <li>in the current view, reference annotations are on the dataset and
+   * sequence, but not the alignment</li>
+   * </ul>
+   * The menu item should be enabled, and acquire a tooltip which lists the
+   * annotation sources (calcIds) and type (labels).
+   */
+  @Test
+  public void testConfigureReferenceAnnotationsMenu_twoViews()
+  {
   }
 
   /**