JAL-1942 JAL-1479 DBRefFetcher refactor
[jalview.git] / src / jalview / gui / PopupMenu.java
index 1263b71..e86b2c5 100644 (file)
  */
 package jalview.gui;
 
-import java.awt.Color;
-import java.awt.event.ActionEvent;
-import java.awt.event.ActionListener;
-import java.util.Arrays;
-import java.util.Collections;
-import java.util.Hashtable;
-import java.util.LinkedHashMap;
-import java.util.List;
-import java.util.Map;
-import java.util.TreeMap;
-import java.util.Vector;
-
-import javax.swing.ButtonGroup;
-import javax.swing.JCheckBoxMenuItem;
-import javax.swing.JColorChooser;
-import javax.swing.JMenu;
-import javax.swing.JMenuItem;
-import javax.swing.JOptionPane;
-import javax.swing.JPopupMenu;
-import javax.swing.JRadioButtonMenuItem;
-
 import jalview.analysis.AAFrequency;
 import jalview.analysis.AlignmentAnnotationUtils;
 import jalview.analysis.AlignmentUtils;
@@ -80,6 +59,27 @@ import jalview.util.GroupUrlLink.UrlStringTooLongException;
 import jalview.util.MessageManager;
 import jalview.util.UrlLink;
 
+import java.awt.Color;
+import java.awt.event.ActionEvent;
+import java.awt.event.ActionListener;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.Hashtable;
+import java.util.LinkedHashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.TreeMap;
+import java.util.Vector;
+
+import javax.swing.ButtonGroup;
+import javax.swing.JCheckBoxMenuItem;
+import javax.swing.JColorChooser;
+import javax.swing.JMenu;
+import javax.swing.JMenuItem;
+import javax.swing.JOptionPane;
+import javax.swing.JPopupMenu;
+import javax.swing.JRadioButtonMenuItem;
+
 /**
  * DOCUMENT ME!
  * 
@@ -137,7 +137,7 @@ public class PopupMenu extends JPopupMenu
   JMenuItem sequenceDetails = new JMenuItem();
 
   JMenuItem sequenceSelDetails = new JMenuItem();
-  
+
   JMenuItem makeReferenceSeq = new JMenuItem();
 
   JMenuItem chooseAnnotations = new JMenuItem();
@@ -204,9 +204,9 @@ public class PopupMenu extends JPopupMenu
 
   JMenu jMenu1 = new JMenu();
 
-  JMenuItem structureMenu = new JMenuItem();
+  JMenuItem pdbStructureDialog = new JMenuItem();
 
-  JMenu viewStructureMenu = new JMenu();
+  JMenu rnaStructureMenu = new JMenu();
 
   JMenuItem editSequence = new JMenuItem();
 
@@ -317,115 +317,86 @@ public class PopupMenu extends JPopupMenu
       sequenceMenu.setText(sequence.getName());
       if (seq == ap.av.getAlignment().getSeqrep())
       {
-        makeReferenceSeq.setText("Unmark representative");
-      } else {
-        makeReferenceSeq.setText("Mark as representative");
+        makeReferenceSeq.setText(MessageManager
+                .getString("action.unmark_as_reference"));
       }
-
-      if (seq.getDatasetSequence().getPDBId() != null
-              && seq.getDatasetSequence().getPDBId().size() > 0)
+      else
       {
-        java.util.Enumeration e = seq.getDatasetSequence().getPDBId()
-                .elements();
-
-        while (e.hasMoreElements())
-        {
-          final PDBEntry pdb = (PDBEntry) e.nextElement();
-
-          menuItem = new JMenuItem();
-          menuItem.setText(pdb.getId());
-          menuItem.addActionListener(new ActionListener()
-          {
-            @Override
-            public void actionPerformed(ActionEvent e)
-            {
-              // TODO re JAL-860: optionally open dialog or provide a menu entry
-              // allowing user to open just one structure per sequence
-              // new AppJmol(pdb, ap.av.collateForPDB(new PDBEntry[]
-              // { pdb })[0], null, ap);
-              new StructureViewer(ap.getStructureSelectionManager())
-                      .viewStructures(pdb,
-                              ap.av.collateForPDB(new PDBEntry[]
-                              { pdb })[0], null, ap);
-            }
-          });
-          viewStructureMenu.add(menuItem);
-
-          /*
-           * menuItem = new JMenuItem(); menuItem.setText(pdb.getId());
-           * menuItem.addActionListener(new java.awt.event.ActionListener() {
-           * public void actionPerformed(ActionEvent e) {
-           * colourByStructure(pdb.getId()); } });
-           * colStructureMenu.add(menuItem);
-           */
-        }
+        makeReferenceSeq.setText(MessageManager
+                .getString("action.set_as_reference"));
       }
-      else
+
+      if (!ap.av.getAlignment().isNucleotide())
       {
-        if (ap.av.getAlignment().isNucleotide() == false)
-        {
-          structureMenu.remove(viewStructureMenu);
-        }
+        remove(rnaStructureMenu);
       }
-      if (ap.av.getAlignment().isNucleotide() == true)
+      else
       {
-        AlignmentAnnotation[] aa = ap.av.getAlignment()
+        int origCount = rnaStructureMenu.getItemCount();
+        /*
+         * add menu items to 2D-render any alignment or sequence secondary
+         * structure annotation
+         */
+        AlignmentAnnotation[] aas = ap.av.getAlignment()
                 .getAlignmentAnnotation();
-        for (int i = 0; aa != null && i < aa.length; i++)
+        if (aas != null)
         {
-          if (aa[i].isValidStruc() && aa[i].sequenceRef == null)
+          for (final AlignmentAnnotation aa : aas)
           {
-            final String rnastruc = aa[i].getRNAStruc();
-            final String structureLine = aa[i].label + " (alignment)";
-            menuItem = new JMenuItem();
-            menuItem.setText(MessageManager.formatMessage(
-                    "label.2d_rna_structure_line", new Object[]
-                    { structureLine }));
-            menuItem.addActionListener(new java.awt.event.ActionListener()
+            if (aa.isValidStruc() && aa.sequenceRef == null)
             {
-              @Override
-              public void actionPerformed(ActionEvent e)
+              /*
+               * valid alignment RNA secondary structure annotation
+               */
+              menuItem = new JMenuItem();
+              menuItem.setText(MessageManager.formatMessage(
+                      "label.2d_rna_structure_line",
+                      new Object[] { aa.label }));
+              menuItem.addActionListener(new java.awt.event.ActionListener()
               {
-                new AppVarna(structureLine, seq, seq.getSequenceAsString(),
-                        rnastruc, seq.getName(), ap);
-                System.out.println("end");
-              }
-            });
-            viewStructureMenu.add(menuItem);
+                @Override
+                public void actionPerformed(ActionEvent e)
+                {
+                  new AppVarna(seq, aa, ap);
+                }
+              });
+              rnaStructureMenu.add(menuItem);
+            }
           }
         }
 
-
         if (seq.getAnnotation() != null)
         {
-          AlignmentAnnotation seqAnno[] = seq.getAnnotation();
-          for (int i = 0; i < seqAnno.length; i++)
+          AlignmentAnnotation seqAnns[] = seq.getAnnotation();
+          for (final AlignmentAnnotation aa : seqAnns)
           {
-            if (seqAnno[i].isValidStruc())
+            if (aa.isValidStruc())
             {
-              final String rnastruc = seqAnno[i].getRNAStruc();
-
+              /*
+               * valid sequence RNA secondary structure annotation
+               */
               // TODO: make rnastrucF a bit more nice
               menuItem = new JMenuItem();
               menuItem.setText(MessageManager.formatMessage(
-                      "label.2d_rna_sequence_name", new Object[]
-                      { seq.getName() }));
+                      "label.2d_rna_sequence_name",
+                      new Object[] { seq.getName() }));
               menuItem.addActionListener(new java.awt.event.ActionListener()
               {
                 @Override
                 public void actionPerformed(ActionEvent e)
                 {
                   // TODO: VARNA does'nt print gaps in the sequence
-
-                  new AppVarna(seq.getName() + " structure", seq, seq
-                          .getSequenceAsString(), rnastruc, seq.getName(),
-                          ap);
+                  new AppVarna(seq, aa, ap);
                 }
               });
-              viewStructureMenu.add(menuItem);
+              rnaStructureMenu.add(menuItem);
             }
           }
         }
+        if (rnaStructureMenu.getItemCount() == origCount)
+        {
+          remove(rnaStructureMenu);
+        }
       }
 
       menuItem = new JMenuItem(
@@ -444,8 +415,8 @@ public class PopupMenu extends JPopupMenu
               && ap.av.getSelectionGroup().getSize() > 1)
       {
         menuItem = new JMenuItem(MessageManager.formatMessage(
-                "label.represent_group_with", new Object[]
-                { seq.getName() }));
+                "label.represent_group_with",
+                new Object[] { seq.getName() }));
         menuItem.addActionListener(new java.awt.event.ActionListener()
         {
           @Override
@@ -513,8 +484,7 @@ public class PopupMenu extends JPopupMenu
     if (sg != null && sg.getSize() > 0)
     {
       groupName.setText(MessageManager.formatMessage("label.name_param",
-              new Object[]
-              { sg.getName() }));
+              new Object[] { sg.getName() }));
       groupName.setText(MessageManager
               .getString("label.edit_name_and_description_current_group"));
 
@@ -594,7 +564,7 @@ public class PopupMenu extends JPopupMenu
       SequenceI sqass = null;
       for (SequenceI sq : ap.av.getSequenceSelection())
       {
-        Vector<PDBEntry> pes = sq.getDatasetSequence().getPDBId();
+        Vector<PDBEntry> pes = sq.getDatasetSequence().getAllPDBEntries();
         if (pes != null && pes.size() > 0)
         {
           reppdb.put(pes.get(0).getId(), pes.get(0));
@@ -638,7 +608,8 @@ public class PopupMenu extends JPopupMenu
     if (seq == null)
     {
       sequenceMenu.setVisible(false);
-      structureMenu.setVisible(false);
+      pdbStructureDialog.setVisible(false);
+      rnaStructureMenu.setVisible(false);
     }
 
     if (links != null && links.size() > 0)
@@ -671,8 +642,7 @@ public class PopupMenu extends JPopupMenu
 
           // collect matching db-refs
           DBRefEntry[] dbr = jalview.util.DBRefUtils.selectRefs(
-                  seq.getDBRef(), new String[]
-                  { urlLink.getTarget() });
+                  seq.getDBRefs(), new String[] { urlLink.getTarget() });
           // collect id string too
           String id = seq.getName();
           String descr = seq.getDescription();
@@ -803,17 +773,15 @@ public class PopupMenu extends JPopupMenu
      */
     Map<String, List<List<String>>> shownTypes = new LinkedHashMap<String, List<List<String>>>();
     Map<String, List<List<String>>> hiddenTypes = new LinkedHashMap<String, List<List<String>>>();
-    AlignmentAnnotationUtils.getShownHiddenTypes(shownTypes,
-            hiddenTypes,
-            AlignmentAnnotationUtils.asList(annotations),
-            forSequences);
+    AlignmentAnnotationUtils.getShownHiddenTypes(shownTypes, hiddenTypes,
+            AlignmentAnnotationUtils.asList(annotations), forSequences);
 
     for (String calcId : hiddenTypes.keySet())
     {
       for (List<String> type : hiddenTypes.get(calcId))
       {
-        addAnnotationTypeToShowHide(showMenu, forSequences,
-                calcId, type, false, true);
+        addAnnotationTypeToShowHide(showMenu, forSequences, calcId, type,
+                false, true);
       }
     }
     // grey out 'show annotations' if none are hidden
@@ -823,8 +791,8 @@ public class PopupMenu extends JPopupMenu
     {
       for (List<String> type : shownTypes.get(calcId))
       {
-        addAnnotationTypeToShowHide(hideMenu, forSequences,
-                calcId, type, false, false);
+        addAnnotationTypeToShowHide(hideMenu, forSequences, calcId, type,
+                false, false);
       }
     }
     // grey out 'hide annotations' if none are shown
@@ -885,8 +853,8 @@ public class PopupMenu extends JPopupMenu
       @Override
       public void actionPerformed(ActionEvent e)
       {
-        AlignmentUtils.showOrHideSequenceAnnotations(ap.getAlignment(), types,
-                forSequences, allTypes, actionIsShow);
+        AlignmentUtils.showOrHideSequenceAnnotations(ap.getAlignment(),
+                types, forSequences, allTypes, actionIsShow);
         refresh();
       }
     });
@@ -902,8 +870,8 @@ public class PopupMenu extends JPopupMenu
     // ID/regex match URLs
     groupLinksMenu = new JMenu(
             MessageManager.getString("action.group_link"));
-    JMenu[] linkMenus = new JMenu[]
-    { null, new JMenu(MessageManager.getString("action.ids")),
+    JMenu[] linkMenus = new JMenu[] { null,
+        new JMenu(MessageManager.getString("action.ids")),
         new JMenu(MessageManager.getString("action.sequences")),
         new JMenu(MessageManager.getString("action.ids_sequences")) }; // three
                                                                        // types
@@ -928,7 +896,7 @@ public class PopupMenu extends JPopupMenu
       {
         sqi = sqi.getDatasetSequence();
       }
-      DBRefEntry[] dbr = sqi.getDBRef();
+      DBRefEntry[] dbr = sqi.getDBRefs();
       if (dbr != null && dbr.length > 0)
       {
         for (int d = 0; d < dbr.length; d++)
@@ -938,8 +906,7 @@ public class PopupMenu extends JPopupMenu
           if (sarray == null)
           {
             sarray = new Object[2];
-            sarray[0] = new int[]
-            { 0 };
+            sarray[0] = new int[] { 0 };
             sarray[1] = new String[seqs.length];
 
             commonDbrefs.put(src, sarray);
@@ -1059,8 +1026,7 @@ public class PopupMenu extends JPopupMenu
   {
     JMenuItem item = new JMenuItem(label);
     item.setToolTipText(MessageManager.formatMessage(
-            "label.open_url_param", new Object[]
-            { url }));
+            "label.open_url_param", new Object[] { url }));
     item.addActionListener(new java.awt.event.ActionListener()
     {
       @Override
@@ -1099,8 +1065,7 @@ public class PopupMenu extends JPopupMenu
     JMenuItem item = new JMenuItem(label);
     item.setToolTipText(MessageManager.formatMessage(
             "label.open_url_seqs_param",
-            new Object[]
-            { urlgenerator.getUrl_prefix(),
+            new Object[] { urlgenerator.getUrl_prefix(),
                 urlgenerator.getNumberInvolved(urlstub) }));
     // TODO: put in info about what is being sent.
     item.addActionListener(new java.awt.event.ActionListener()
@@ -1160,7 +1125,7 @@ public class PopupMenu extends JPopupMenu
       }
     });
     chooseAnnotations.setText(MessageManager
-            .getString("label.choose_annotations") + "...");
+            .getString("action.choose_annotations"));
     chooseAnnotations.addActionListener(new java.awt.event.ActionListener()
     {
       @Override
@@ -1170,7 +1135,7 @@ public class PopupMenu extends JPopupMenu
       }
     });
     sequenceDetails.setText(MessageManager
-            .getString("label.sequence_details") + "...");
+            .getString("label.sequence_details"));
     sequenceDetails.addActionListener(new java.awt.event.ActionListener()
     {
       @Override
@@ -1180,7 +1145,7 @@ public class PopupMenu extends JPopupMenu
       }
     });
     sequenceSelDetails.setText(MessageManager
-            .getString("label.sequence_details") + "...");
+            .getString("label.sequence_details"));
     sequenceSelDetails
             .addActionListener(new java.awt.event.ActionListener()
             {
@@ -1379,14 +1344,14 @@ public class PopupMenu extends JPopupMenu
       }
     });
     jMenu1.setText(MessageManager.getString("label.group"));
-    structureMenu.setText(MessageManager.getString("label.view_structure"));
-    structureMenu.addActionListener(new ActionListener()
+    pdbStructureDialog.setText(MessageManager
+            .getString("label.show_pdbstruct_dialog"));
+    pdbStructureDialog.addActionListener(new ActionListener()
     {
       @Override
       public void actionPerformed(ActionEvent actionEvent)
       {
-        SequenceI[] selectedSeqs = new SequenceI[]
-        { sequence };
+        SequenceI[] selectedSeqs = new SequenceI[] { sequence };
         if (ap.av.getSelectionGroup() != null)
         {
           selectedSeqs = ap.av.getSequenceSelection();
@@ -1395,8 +1360,9 @@ public class PopupMenu extends JPopupMenu
       }
     });
 
-    viewStructureMenu.setText(MessageManager
-            .getString("label.view_structure"));
+    rnaStructureMenu.setText(MessageManager
+            .getString("label.view_rna_structure"));
+
     // colStructureMenu.setText("Colour By Structure");
     editSequence.setText(MessageManager.getString("label.edit_sequence")
             + "...");
@@ -1412,15 +1378,16 @@ public class PopupMenu extends JPopupMenu
             .getString("label.mark_as_representative"));
     makeReferenceSeq.addActionListener(new ActionListener()
     {
-      
+
       @Override
       public void actionPerformed(ActionEvent actionEvent)
       {
         makeReferenceSeq_actionPerformed(actionEvent);
-        
+
       }
     });
-    hideInsertions.setText(MessageManager.getString("label.hide_insertions"));
+    hideInsertions.setText(MessageManager
+            .getString("label.hide_insertions"));
     hideInsertions.addActionListener(new ActionListener()
     {
 
@@ -1439,8 +1406,9 @@ public class PopupMenu extends JPopupMenu
     groupMenu.add(sequenceSelDetails);
     add(groupMenu);
     add(sequenceMenu);
-    add(structureMenu);
-    if (sequence!=null)
+    add(rnaStructureMenu);
+    add(pdbStructureDialog);
+    if (sequence != null)
     {
       add(hideInsertions);
     }
@@ -1698,8 +1666,8 @@ public class PopupMenu extends JPopupMenu
    * @param menuItem
    * @param forSequences
    */
-  protected void configureReferenceAnnotationsMenu(
-          JMenuItem menuItem, List<SequenceI> forSequences)
+  protected void configureReferenceAnnotationsMenu(JMenuItem menuItem,
+          List<SequenceI> forSequences)
   {
     menuItem.setEnabled(false);
 
@@ -1795,6 +1763,7 @@ public class PopupMenu extends JPopupMenu
     }
     refresh();
   }
+
   protected void sequenceSelectionDetails_actionPerformed()
   {
     createSequenceDetailsReport(ap.av.getSequenceSelection());
@@ -1802,8 +1771,7 @@ public class PopupMenu extends JPopupMenu
 
   protected void sequenceDetails_actionPerformed()
   {
-    createSequenceDetailsReport(new SequenceI[]
-    { sequence });
+    createSequenceDetailsReport(new SequenceI[] { sequence });
   }
 
   public void createSequenceDetailsReport(SequenceI[] sequences)
@@ -1816,8 +1784,8 @@ public class PopupMenu extends JPopupMenu
               + MessageManager
                       .formatMessage(
                               "label.create_sequence_details_report_annotation_for",
-                              new Object[]
-                              { seq.getDisplayId(true) }) + "</h2></p><p>");
+                              new Object[] { seq.getDisplayId(true) })
+              + "</h2></p><p>");
       new SequenceAnnotationReport(null)
               .createSequenceAnnotationReport(
                       contents,
@@ -1826,8 +1794,7 @@ public class PopupMenu extends JPopupMenu
                       true,
                       false,
                       (ap.getSeqPanel().seqCanvas.fr != null) ? ap
-                              .getSeqPanel().seqCanvas.fr
-                              .getMinMax()
+                              .getSeqPanel().seqCanvas.fr.getMinMax()
                               : null);
       contents.append("</p>");
     }
@@ -1835,9 +1802,9 @@ public class PopupMenu extends JPopupMenu
 
     Desktop.addInternalFrame(cap, MessageManager.formatMessage(
             "label.sequence_details_for",
-            (sequences.length == 1 ? new Object[]
-            { sequences[0].getDisplayId(true) } : new Object[]
-            { MessageManager.getString("label.selection") })), 500, 400);
+            (sequences.length == 1 ? new Object[] { sequences[0]
+                    .getDisplayId(true) } : new Object[] { MessageManager
+                    .getString("label.selection") })), 500, 400);
 
   }
 
@@ -2343,8 +2310,7 @@ public class PopupMenu extends JPopupMenu
     SequenceGroup sg = ap.av.getSelectionGroup();
     if (sg == null || sg.getSize() < 1)
     {
-      ap.av.hideSequence(new SequenceI[]
-      { sequence });
+      ap.av.hideSequence(new SequenceI[] { sequence });
       return;
     }
 
@@ -2383,8 +2349,7 @@ public class PopupMenu extends JPopupMenu
     if (sg != null)
     {
       List<int[]> startEnd = ap.av.getVisibleRegionBoundaries(
-              sg.getStartRes(),
-              sg.getEndRes() + 1);
+              sg.getStartRes(), sg.getEndRes() + 1);
 
       String description;
       int caseChange;
@@ -2422,8 +2387,8 @@ public class PopupMenu extends JPopupMenu
     CutAndPasteTransfer cap = new CutAndPasteTransfer();
     cap.setForInput(null);
     Desktop.addInternalFrame(cap, MessageManager.formatMessage(
-            "label.alignment_output_command", new Object[]
-            { e.getActionCommand() }), 600, 500);
+            "label.alignment_output_command",
+            new Object[] { e.getActionCommand() }), 600, 500);
 
     String[] omitHidden = null;
 
@@ -2431,8 +2396,8 @@ public class PopupMenu extends JPopupMenu
     // or we simply trust the user wants
     // wysiwig behaviour
 
-    cap.setText(new FormatAdapter().formatSequences(e.getActionCommand(),
-            ap.av, true));
+    cap.setText(new FormatAdapter(ap).formatSequences(e.getActionCommand(),
+            ap, true));
   }
 
   public void pdbFromFile_actionPerformed()
@@ -2441,11 +2406,11 @@ public class PopupMenu extends JPopupMenu
             jalview.bin.Cache.getProperty("LAST_DIRECTORY"));
     chooser.setFileView(new jalview.io.JalviewFileView());
     chooser.setDialogTitle(MessageManager.formatMessage(
-            "label.select_pdb_file_for", new Object[]
-            { sequence.getDisplayId(false) }));
+            "label.select_pdb_file_for",
+            new Object[] { sequence.getDisplayId(false) }));
     chooser.setToolTipText(MessageManager.formatMessage(
-            "label.load_pdb_file_associate_with_sequence", new Object[]
-            { sequence.getDisplayId(false) }));
+            "label.load_pdb_file_associate_with_sequence",
+            new Object[] { sequence.getDisplayId(false) }));
 
     int value = chooser.showOpenDialog(null);
 
@@ -2460,7 +2425,6 @@ public class PopupMenu extends JPopupMenu
 
   }
 
-
   public void enterPDB_actionPerformed()
   {
     String id = JOptionPane.showInternalInputDialog(Desktop.desktop,
@@ -2487,9 +2451,13 @@ public class PopupMenu extends JPopupMenu
       @Override
       public void run()
       {
+        boolean isNuclueotide = ap.alignFrame.getViewport().getAlignment()
+                .isNucleotide();
 
-        new jalview.ws.DBRefFetcher(sequences, ap.alignFrame)
+        new jalview.ws.DBRefFetcher(sequences, ap.alignFrame, null,
+                ap.alignFrame.featureSettings, isNuclueotide)
                 .fetchDBRefs(false);
+
       }
 
     });