JAL-2874 added filtering when a subtree is selected
[jalview.git] / src / jalview / ext / archaeopteryx / AptxInit.java
index b9a7ae2..9d248d0 100644 (file)
@@ -9,21 +9,27 @@ import jalview.gui.JvOptionPane;
 import jalview.util.MessageManager;
 import jalview.viewmodel.AlignmentViewport;
 
+import java.awt.Component;
 import java.awt.Dimension;
 import java.io.File;
 import java.io.FileNotFoundException;
 import java.io.IOException;
 import java.net.MalformedURLException;
 import java.net.URL;
+import java.util.HashMap;
 import java.util.Map;
 
+import javax.swing.JMenu;
+import javax.swing.JMenuBar;
+import javax.swing.JMenuItem;
+import javax.swing.JSeparator;
+
 import org.forester.archaeopteryx.AptxUtil;
 import org.forester.archaeopteryx.Archaeopteryx;
 import org.forester.archaeopteryx.Configuration;
 import org.forester.archaeopteryx.MainFrame;
 import org.forester.archaeopteryx.webservices.PhylogeniesWebserviceClient;
 import org.forester.archaeopteryx.webservices.WebserviceUtil;
-import org.forester.archaeopteryx.webservices.WebservicesManager;
 import org.forester.io.parsers.PhylogenyParser;
 import org.forester.io.parsers.nexus.NexusPhylogeniesParser;
 import org.forester.io.parsers.nhx.NHXParser;
@@ -46,9 +52,9 @@ import org.forester.util.ForesterUtil;
  */
 public final class AptxInit
 {
-
   private final static Configuration APTX_CONFIG = new Configuration(
-          "_aptx_jalview_configuration_file", false, false, false);
+          "_aptx_jalview_configuration_file",
+            false, false, false);
 
   private final static boolean VALIDATE_PHYLOXML_XSD = APTX_CONFIG
           .isValidatePhyloXmlAgainstSchema();
@@ -65,6 +71,8 @@ public final class AptxInit
   private final static NHXParser.TAXONOMY_EXTRACTION TAXONOMY_EXTRACTION = APTX_CONFIG
           .getTaxonomyExtraction();
 
+  private static Map<MainFrame, JalviewBinding> activeAptx = new HashMap<>();
+
 
 
   public static MainFrame createInstanceFromCalculation(
@@ -125,13 +133,19 @@ public final class AptxInit
       nex.setReplaceUnderscores(REPLACE_NHX_UNDERSCORES);
       nex.setIgnoreQuotes(false);
     }
-//    else if (p instanceof PhyloXmlParser)
-//    {
-//      MainFrameApplication.warnIfNotPhyloXmlValidation(APTX_CONFIG);
-//    }
+    else if (parser instanceof PhyloXmlParser)
+    {
+      if (VALIDATE_PHYLOXML_XSD == false)
+      {
+        JvOptionPane.showInternalMessageDialog(Desktop.desktop,
+                MessageManager.getString("error.phyloxml_validation"),
+                MessageManager.getString("label.file_open_error"),
+                                       JvOptionPane.WARNING_MESSAGE );
+      }
+    }
     Phylogeny[] trees = PhylogenyMethods.readPhylogenies(parser, treeFile);
     MainFrame[] aptxFrames = new MainFrame[trees.length];
-    String treeTitle = treeFile.getName();
+
 
     for (int i = 0; i < trees.length; i++)
       {
@@ -141,6 +155,8 @@ public final class AptxInit
       {
         PhylogenyMethods.transferInternalNodeNamesToConfidence(tree, "");
       }
+      String treeTitle = treeFile.getName() + "[" + i + "]";
+      tree.setName(treeTitle);
       aptxFrames[i] = createAptxFrame(tree, viewport, treeTitle);
 
     }
@@ -190,21 +206,13 @@ public final class AptxInit
    * @param viewport
    * @return
    */
-  public static MainFrame[] createInstancesFromDb(int databaseIndex,
+  public static MainFrame[] createInstancesFromDb(
+          PhylogeniesWebserviceClient treeDbClient, String identifier,
           AlignmentViewport viewport)
   {
 
     URL url = null;
     Phylogeny[] trees = null;
-    final WebservicesManager webservices_manager = WebservicesManager
-            .getInstance();
-    final PhylogeniesWebserviceClient client = webservices_manager
-            .getAvailablePhylogeniesWebserviceClient(databaseIndex);
-    String identifier = JvOptionPane.showInternalInputDialog(
-            Desktop.desktop,
-            client.getInstructions() + "\n(Reference: "
-                    + client.getReference() + ")",
-            client.getDescription(), JvOptionPane.QUESTION_MESSAGE);
 
     if ((identifier != null) && (identifier.trim().length() > 0))
     {
@@ -214,7 +222,7 @@ public final class AptxInit
       }
 
       identifier = identifier.trim();
-      if (client.isQueryInteger())
+      if (treeDbClient.isQueryInteger())
       {
         identifier = identifier.replaceAll("^\\D+", "");
 
@@ -225,8 +233,11 @@ public final class AptxInit
         } catch (final NumberFormatException e)
         {
           JvOptionPane.showInternalMessageDialog(Desktop.desktop,
-                  "Identifier is expected to be a number",
-                  "Can not open URL", JvOptionPane.ERROR_MESSAGE);
+                  MessageManager.formatMessage(
+                          "error.database_id_has_letters", new String[]
+                          { identifier }),
+                  MessageManager.getString("label.invalid_url"),
+                  JvOptionPane.ERROR_MESSAGE);
           return new MainFrame[0];
         }
         identifier = id + "";
@@ -234,12 +245,12 @@ public final class AptxInit
       boolean exception = false;
       try
       {
-        String url_str = client.getUrl();
+        String url_str = treeDbClient.getUrl();
         url_str = url_str.replaceFirst(
                 PhylogeniesWebserviceClient.QUERY_PLACEHOLDER, identifier);
         url = new URL(url_str);
         PhylogenyParser parser = null;
-        switch (client.getReturnFormat())
+        switch (treeDbClient.getReturnFormat())
         {
         case TOL_XML_RESPONSE:
           parser = new TolParser();
@@ -293,7 +304,7 @@ public final class AptxInit
           break;
         default:
           throw new IllegalArgumentException(
-                  "unknown format: " + client.getReturnFormat());
+                  "unknown format: " + treeDbClient.getReturnFormat());
         }
         //
         // if (_main_frame.getMainPanel().getCurrentTreePanel() != null)
@@ -309,26 +320,32 @@ public final class AptxInit
       {
         exception = true;
         JvOptionPane.showInternalMessageDialog(Desktop.desktop,
-                "Malformed URL: " + url + "\n" + e.getLocalizedMessage(),
-                "Malformed URL", JvOptionPane.ERROR_MESSAGE);
+                MessageManager.formatMessage(
+                        "exception.unable_to_launch_url", new String[]
+                        { url.toString() }),
+                MessageManager.getString("label.invalid_url"),
+                JvOptionPane.ERROR_MESSAGE);
+        System.err.println(e.getLocalizedMessage());
       } catch (final IOException e)
       {
         exception = true;
         JvOptionPane.showInternalMessageDialog(Desktop.desktop,
                 "Could not read from " + url + "\n"
                         + e.getLocalizedMessage(),
-                "Failed to read tree from " + client.getName() + " for "
+                "Failed to read tree from " + treeDbClient.getName() + " for "
                         + identifier,
                 JvOptionPane.ERROR_MESSAGE);
+        System.err.println(e.getLocalizedMessage());
       } catch (final NumberFormatException e)
       {
         exception = true;
         JvOptionPane.showInternalMessageDialog(Desktop.desktop,
                 "Could not read from " + url + "\n"
                         + e.getLocalizedMessage(),
-                "Failed to read tree from " + client.getName() + " for "
+                "Failed to read tree from " + treeDbClient.getName() + " for "
                         + identifier,
                 JvOptionPane.ERROR_MESSAGE);
+        System.err.println(e.getLocalizedMessage());
       } catch (final Exception e)
       {
         exception = true;
@@ -336,16 +353,7 @@ public final class AptxInit
         JvOptionPane.showInternalMessageDialog(Desktop.desktop,
                 e.getLocalizedMessage(), "Unexpected Exception",
                 JvOptionPane.ERROR_MESSAGE);
-      } finally
-      {
-        // if (_main_frame.getCurrentTreePanel() != null)
-        // {
-        // _main_frame.getCurrentTreePanel().setArrowCursor();
-        // }
-        // else
-        // {
-        // _main_frame.getMainPanel().setArrowCursor();
-        // }
+        System.err.println(e.getLocalizedMessage());
       }
       if ((trees != null) && (trees.length > 0))
       {
@@ -353,16 +361,16 @@ public final class AptxInit
         {
           if (!phylogeny.isEmpty())
           {
-            if (client.getName().equals(WebserviceUtil.TREE_FAM_NAME))
+            if (treeDbClient.getName().equals(WebserviceUtil.TREE_FAM_NAME))
             {
               phylogeny.setRerootable(false);
               phylogeny.setRooted(true);
             }
-            if (client.getProcessingInstructions() != null)
+            if (treeDbClient.getProcessingInstructions() != null)
             {
               try
               {
-                WebserviceUtil.processInstructions(client, phylogeny);
+                WebserviceUtil.processInstructions(treeDbClient, phylogeny);
               } catch (final PhyloXmlDataFormatException e)
               {
                 JvOptionPane.showInternalMessageDialog(Desktop.desktop,
@@ -370,12 +378,12 @@ public final class AptxInit
                         JvOptionPane.ERROR_MESSAGE);
               }
             }
-            if (client.getNodeField() != null)
+            if (treeDbClient.getNodeField() != null)
             {
               try
               {
                 PhylogenyMethods.transferNodeNameToField(phylogeny,
-                        client.getNodeField(), false);
+                        treeDbClient.getNodeField(), false);
               } catch (final PhyloXmlDataFormatException e)
               {
                 JvOptionPane.showInternalMessageDialog(Desktop.desktop,
@@ -384,7 +392,7 @@ public final class AptxInit
               }
             }
             phylogeny.setIdentifier(
-                    new Identifier(identifier, client.getName()));
+                    new Identifier(identifier, treeDbClient.getName()));
             // _main_frame.getJMenuBar().remove(_main_frame.getHelpMenu());
             // _main_frame.getMenuBarOfMainFrame()
             // .add(_main_frame.getHelpMenu());
@@ -413,8 +421,8 @@ public final class AptxInit
               my_name_for_file = new String(
                       sb.toString().replaceAll(" ", "_"));
             }
-            // _main_frame.getMainPanel().getCurrentTreePanel()
-            // .setTreeFile(new File(my_name_for_file));
+            aptxApp.getMainPanel().getCurrentTreePanel()
+                    .setTreeFile(new File(my_name_for_file));
             AptxUtil.lookAtSomeTreePropertiesForAptxControlSettings(
                     phylogeny, aptxApp.getMainPanel().getControlPanel(),
                     APTX_CONFIG);
@@ -424,7 +432,7 @@ public final class AptxInit
           }
         }
       }
-      else if (!exception)
+      else if (!exception) // ..what?
       {
         JvOptionPane.showMessageDialog(null,
                 ForesterUtil.wordWrap(
@@ -468,9 +476,27 @@ public final class AptxInit
           final Phylogeny aptxTree,
           final AlignmentViewport jalviewAlignport, String treeTitle)
   {
+    if (APTX_CONFIG == null || APTX_CONFIG.isCouldReadConfigFile() == false)
+    {
+      int keepGoing = JvOptionPane.showConfirmDialog(Desktop.desktop,
+              MessageManager.getString("label.aptx_config_not_found"),
+              MessageManager.formatMessage("label.couldnt_locate",
+                      new String[]
+                      { "_aptx_jalview_configuration_file" }),
+              JvOptionPane.YES_NO_CANCEL_OPTION);
+
+      if (keepGoing == JvOptionPane.CANCEL_OPTION
+              || keepGoing == JvOptionPane.CLOSED_OPTION
+              || keepGoing == JvOptionPane.NO_OPTION)
+      {
+        return null;
+      }
+
+    }
     MainFrame aptxApp = Archaeopteryx.createApplication(aptxTree,
             APTX_CONFIG, treeTitle);
 
+
     LoadedTreeSequenceAssociation bindAptxNodes = new LoadedTreeSequenceAssociation(
             jalviewAlignport.getAlignment().getSequencesArray(), aptxTree);
     bindAptxNodes.associateLeavesToSequences();
@@ -480,15 +506,10 @@ public final class AptxInit
             bindAptxNodes.getNodesWithAlignment());
     bindTreeViewFrameToJalview(aptxApp);
 
+    adaptAptxGui(aptxApp);
     return aptxApp;
   }
 
-  // private static void addPartitioningSlider(MainFrame aptxFrame)
-  // {
-  // JSlider slider = new JSlider();
-  //
-  //
-  // }
 
   public static ExternalTreeViewerBindingI<?> bindNodesToJalviewSequences(
           final MainFrame aptxApp,
@@ -496,8 +517,11 @@ public final class AptxInit
           final Map<SequenceI, PhylogenyNode> alignMappedToNodes,
           final Map<PhylogenyNode, SequenceI> nodesMappedToAlign)
   {
-    return new JalviewBinding(aptxApp, jalviewAlignViewport,
+    JalviewBinding treeBinding = new JalviewBinding(aptxApp,
+            jalviewAlignViewport,
             alignMappedToNodes, nodesMappedToAlign);
+    activeAptx.put(aptxApp, treeBinding);
+    return treeBinding;
   }
 
 
@@ -509,14 +533,92 @@ public final class AptxInit
     aptxApp.setMinimumSize(new Dimension(width, height));
     // aptxApp.setFont(Desktop.instance.getFont());
     // aptxApp.getMainPanel().setFont(Desktop.instance.getFont());
+    String frameTitle = MessageManager.getString("label.aptx_title");
+    File treeFile = aptxApp.getMainPanel().getCurrentTreePanel()
+            .getTreeFile();
+    if (treeFile != null)
+    {
+      frameTitle += MessageManager.formatMessage("label.aptx_title_append",
+              new String[]
+              { treeFile.getAbsolutePath() });
+    }
+    Desktop.addInternalFrame(aptxApp, frameTitle, true, width, height, true,
+            true);
+    return aptxApp;
 
-    Desktop.addInternalFrame(aptxApp, "Archaeopteryx Tree View", true,
-            width, height, true, true);
+  }
 
-    return aptxApp;
+  /**
+   * Hides certain redundant Archaeopteryx GUI elements such as the menu items
+   * for reading in trees and adds extra items related to Jalview such as the
+   * tree sorting item.
+   * 
+   * 
+   * @param aptxFrame
+   */
+  private static void adaptAptxGui(MainFrame aptxFrame)
+  {
+    JMenuBar frameBar = aptxFrame.getJMenuBar();
+
+    for (int i = 0; i < frameBar.getMenuCount();i++) {
+      JMenu menu = frameBar.getMenu(i);
+
+      if (menu.getText().contains("File"))
+      {
+        // hide all "Read from ..." and "New" menu items and any Separators that
+        // come directly after them
+        Component previousMenuItem = null;
+        for (Component menuItem : menu.getMenuComponents()) {
+          if (previousMenuItem instanceof JMenuItem)
+          {
+            if (((JMenuItem) previousMenuItem).getText().startsWith("Read")
+                    || ((JMenuItem) previousMenuItem).getText()
+                            .startsWith("New"))
+            {
+              previousMenuItem.setVisible(false);
+
+              if (menuItem instanceof JSeparator)
+              {
+                menuItem.setVisible(false);
+              }
+            }
+          }
+          previousMenuItem = menuItem;
+        }
+      }
+      else if (menu.getText().contains("Inference"))
+      {
+        menu.setVisible(false);
+      }
+      else if (menu.getText().contains("View"))
+      {
+        menu.addSeparator();
+        JMenuItem sortByTree = new JMenuItem("Sort alignment by tree");
+        JMenuItem refreshJalview = new JMenuItem(
+                "Filter alignment to show only currently visible sequences");
+
+        refreshJalview.setFont(menu.getFont());
+
+        menu.add(sortByTree);
+        menu.add(refreshJalview);
+
+        sortByTree.setFont(menu.getFont());
+        sortByTree.setVisible(false); // don't show unless it's actually
+        // possible
 
+        refreshJalview.addActionListener(activeAptx.get(aptxFrame));
+
+
+      }
+
+    }
+    aptxFrame.validate();
   }
 
+  public static Map<MainFrame, JalviewBinding> getAllAptxFrames()
+  {
+    return activeAptx;
+  }
 
 
 }