excluded methods related to broken Jmol applet binding mechanism (JAL-621)
[jalview.git] / src / jalview / bin / JalviewLite.java
index 7ae85dc..0e77f02 100755 (executable)
@@ -1,32 +1,51 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer (Development Version 2.4.1)
- * Copyright (C) 2009 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.5)
+ * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
  * 
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; either version 2
- * of the License, or (at your option) any later version.
+ * This file is part of Jalview.
  * 
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
+ * Jalview is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License 
+ * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
  * 
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
+ * Jalview is distributed in the hope that it will be useful, but 
+ * WITHOUT ANY WARRANTY; without even the implied warranty 
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
+ * PURPOSE.  See the GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  */
 package jalview.bin;
 
-import java.applet.*;
-
-import java.awt.*;
-import java.awt.event.*;
-import java.util.*;
-
-import jalview.appletgui.*;
-import jalview.datamodel.*;
-import jalview.io.*;
+import jalview.api.SequenceStructureBinding;
+import jalview.appletgui.AlignFrame;
+import jalview.appletgui.EmbmenuFrame;
+import jalview.appletgui.FeatureSettings;
+import jalview.datamodel.Alignment;
+import jalview.datamodel.PDBEntry;
+import jalview.datamodel.Sequence;
+import jalview.datamodel.SequenceI;
+import jalview.io.AnnotationFile;
+import jalview.io.AppletFormatAdapter;
+import jalview.io.FileParse;
+import jalview.io.IdentifyFile;
+import jalview.io.JnetAnnotationMaker;
+
+import java.applet.Applet;
+import java.awt.Button;
+import java.awt.Color;
+import java.awt.Font;
+import java.awt.Frame;
+import java.awt.Graphics;
+import java.awt.event.ActionEvent;
+import java.awt.event.WindowAdapter;
+import java.awt.event.WindowEvent;
+import java.io.BufferedReader;
+import java.io.InputStreamReader;
+import java.lang.reflect.Method;
+import java.util.Enumeration;
+import java.util.StringTokenizer;
+import java.util.Vector;
 
 /**
  * Jalview Applet. Runs in Java 1.18 runtime
@@ -51,7 +70,7 @@ public class JalviewLite extends Applet
 
   /**
    * @param sep
-   *                separator string or null for default
+   *          separator string or null for default
    * @return String list of selected sequence IDs, each terminated by sep or
    *         ("¬" as default)
    */
@@ -62,7 +81,7 @@ public class JalviewLite extends Applet
 
   /**
    * @param alf
-   *                alignframe containing selection
+   *          alignframe containing selection
    * @return String list of selected sequence IDs, each terminated by "¬"
    * 
    */
@@ -75,9 +94,9 @@ public class JalviewLite extends Applet
    * get list of selected sequence IDs separated by given separator
    * 
    * @param alf
-   *                window containing selection
+   *          window containing selection
    * @param sep
-   *                separator string to use - default is "¬"
+   *          separator string to use - default is "¬"
    * @return String list of selected sequence IDs, each terminated by the given
    *         separator
    */
@@ -107,12 +126,12 @@ public class JalviewLite extends Applet
    * get sequences selected in current alignFrame and return their alignment in
    * format 'format' either with or without suffix
    * 
-   * @param alf -
-   *                where selection is
-   * @param format -
-   *                format of alignment file
-   * @param suffix -
-   *                "true" to append /start-end string to each sequence ID
+   * @param alf
+   *          - where selection is
+   * @param format
+   *          - format of alignment file
+   * @param suffix
+   *          - "true" to append /start-end string to each sequence ID
    * @return selected sequences as flat file or empty string if there was no
    *         current selection
    */
@@ -126,12 +145,12 @@ public class JalviewLite extends Applet
    * get sequences selected in alf and return their alignment in format 'format'
    * either with or without suffix
    * 
-   * @param alf -
-   *                where selection is
-   * @param format -
-   *                format of alignment file
-   * @param suffix -
-   *                "true" to append /start-end string to each sequence ID
+   * @param alf
+   *          - where selection is
+   * @param format
+   *          - format of alignment file
+   * @param suffix
+   *          - "true" to append /start-end string to each sequence ID
    * @return selected sequences as flat file or empty string if there was no
    *         current selection
    */
@@ -250,15 +269,15 @@ public class JalviewLite extends Applet
   /**
    * 
    * @param text
-   *                alignment file as a string
+   *          alignment file as a string
    * @param title
-   *                window title
+   *          window title
    * @return null or new alignment frame
    */
   public AlignFrame loadAlignment(String text, String title)
   {
     Alignment al = null;
-    
+
     String format = new IdentifyFile().Identify(text,
             AppletFormatAdapter.PASTE);
     try
@@ -279,9 +298,9 @@ public class JalviewLite extends Applet
   // //////////////////////////////////////////////
   // //////////////////////////////////////////////
 
-  static int lastFrameX = 200;
+  public static int lastFrameX = 200;
 
-  static int lastFrameY = 200;
+  public static int lastFrameY = 200;
 
   boolean fileFound = true;
 
@@ -295,29 +314,80 @@ public class JalviewLite extends Applet
    * AlignFrame if the applet is started as embedded on the page and then
    * afterwards a new view is created.
    */
-  public static AlignFrame currentAlignFrame=null;
+  public static AlignFrame currentAlignFrame = null;
 
   /**
    * This is the first frame to be displayed, and does not change. API calls
    * will default to this instance if currentAlignFrame is null.
    */
-  AlignFrame initialAlignFrame=null;
+  AlignFrame initialAlignFrame = null;
 
   boolean embedded = false;
 
   private boolean checkForJmol = true;
-  private boolean checkedForJmol = false; // ensure we don't check for jmol every time the app is re-inited
+
+  private boolean checkedForJmol = false; // ensure we don't check for jmol
+
+  // every time the app is re-inited
 
   public boolean jmolAvailable = false;
 
-  public static boolean debug=false;
+  public static boolean debug = false;
+
+  static String builddate = null, version = null;
+
+  private static void initBuildDetails()
+  {
+    if (builddate == null)
+    {
+      builddate = "unknown";
+      version = "test";
+      java.net.URL url = JalviewLite.class
+              .getResource("/.build_properties");
+      if (url != null)
+      {
+        try
+        {
+          BufferedReader reader = new BufferedReader(new InputStreamReader(
+                  url.openStream()));
+          String line;
+          while ((line = reader.readLine()) != null)
+          {
+            if (line.indexOf("VERSION") > -1)
+            {
+              version = line.substring(line.indexOf("=") + 1);
+            }
+            if (line.indexOf("BUILD_DATE") > -1)
+            {
+              builddate = line.substring(line.indexOf("=") + 1);
+            }
+          }
+        } catch (Exception ex)
+        {
+          ex.printStackTrace();
+        }
+      }
+    }
+  }
+
+  public static String getBuildDate()
+  {
+    initBuildDetails();
+    return builddate;
+  }
+
+  public static String getVersion()
+  {
+    initBuildDetails();
+    return version;
+  }
 
   /**
    * init method for Jalview Applet
    */
   public void init()
   {
-    
+
     /**
      * turn on extra applet debugging
      */
@@ -326,6 +396,13 @@ public class JalviewLite extends Applet
     {
       debug = dbg.toLowerCase().equals("true");
     }
+    if (debug)
+    {
+
+      System.err.println("JalviewLite Version " + getVersion());
+      System.err.println("Build Date : " + getBuildDate());
+
+    }
     /**
      * if true disable the check for jmol
      */
@@ -445,13 +522,13 @@ public class JalviewLite extends Applet
    * Initialises and displays a new java.awt.Frame
    * 
    * @param frame
-   *                java.awt.Frame to be displayed
+   *          java.awt.Frame to be displayed
    * @param title
-   *                title of new frame
+   *          title of new frame
    * @param width
-   *                width if new frame
+   *          width if new frame
    * @param height
-   *                height of new frame
+   *          height of new frame
    */
   public static void addFrame(final Frame frame, String title, int width,
           int height)
@@ -499,7 +576,9 @@ public class JalviewLite extends Applet
       /*
        * Probably not necessary to do this - see TODO above. (non-Javadoc)
        * 
-       * @see java.awt.event.WindowAdapter#windowDeactivated(java.awt.event.WindowEvent)
+       * @see
+       * java.awt.event.WindowAdapter#windowDeactivated(java.awt.event.WindowEvent
+       * )
        * 
        * public void windowDeactivated(WindowEvent e) { if (currentAlignFrame ==
        * frame) { currentAlignFrame = null; if (debug) {
@@ -516,7 +595,7 @@ public class JalviewLite extends Applet
    * If file given in parameter not found, displays error message
    * 
    * @param g
-   *                graphics context
+   *          graphics context
    */
   public void paint(Graphics g)
   {
@@ -540,14 +619,15 @@ public class JalviewLite extends Applet
 
   class LoadJmolThread extends Thread
   {
-    private boolean running=false;
+    private boolean running = false;
 
     public void run()
     {
-      if (running || checkedForJmol) {
+      if (running || checkedForJmol)
+      {
         return;
       }
-      running=true;
+      running = true;
       if (checkForJmol)
       {
         try
@@ -575,8 +655,8 @@ public class JalviewLite extends Applet
                   .println("Skipping Jmol check. Will use MCView (probably)");
         }
       }
-      checkedForJmol=true;
-      running=false;
+      checkedForJmol = true;
+      running = false;
     }
 
     public boolean notFinished()
@@ -601,8 +681,11 @@ public class JalviewLite extends Applet
      * State variable: format of file source
      */
     String format;
+
     String _file;
+
     JalviewLite applet;
+
     private void dbgMsg(String msg)
     {
       if (applet.debug)
@@ -637,10 +720,10 @@ public class JalviewLite extends Applet
       dbgMsg("Protocol identified as '" + protocol + "'");
       return file;
     }
-    
+
     public LoadingThread(String _file, JalviewLite _applet)
     {
-      this._file=_file;
+      this._file = _file;
       applet = _applet;
     }
 
@@ -651,7 +734,13 @@ public class JalviewLite extends Applet
       while (jmolchecker.notFinished())
       {
         // wait around until the Jmol check is complete.
-        try { Thread.sleep(2); } catch (Exception e) {};
+        try
+        {
+          Thread.sleep(2);
+        } catch (Exception e)
+        {
+        }
+        ;
       }
       startLoading();
     }
@@ -673,18 +762,23 @@ public class JalviewLite extends Applet
       {
         dbgMsg("File load exception.");
         ex.printStackTrace();
-        if (debug) {
-          try {
+        if (debug)
+        {
+          try
+          {
             FileParse fp = new FileParse(file, protocol);
             String ln = null;
-            dbgMsg(">>>Dumping contents of '"+file+"' "+"("+protocol+")");
-            while ((ln=fp.nextLine())!=null) {
+            dbgMsg(">>>Dumping contents of '" + file + "' " + "("
+                    + protocol + ")");
+            while ((ln = fp.nextLine()) != null)
+            {
               dbgMsg(ln);
             }
             dbgMsg(">>>Dump finished.");
           } catch (Exception e)
           {
-            System.err.println("Exception when trying to dump the content of the file parameter.");
+            System.err
+                    .println("Exception when trying to dump the content of the file parameter.");
             e.printStackTrace();
           }
         }
@@ -693,7 +787,7 @@ public class JalviewLite extends Applet
       {
         dbgMsg("Successfully loaded file.");
         newAlignFrame = new AlignFrame(al, applet, file, embedded);
-        if (initialAlignFrame==null)
+        if (initialAlignFrame == null)
         {
           initialAlignFrame = newAlignFrame;
         }
@@ -705,8 +799,7 @@ public class JalviewLite extends Applet
           newAlignFrame.setTitle("Sequences from " + getDocumentBase());
         }
 
-        newAlignFrame.statusBar.setText("Successfully loaded file "
-                + file);
+        newAlignFrame.statusBar.setText("Successfully loaded file " + file);
 
         String treeFile = applet.getParameter("tree");
         if (treeFile == null)
@@ -765,8 +858,7 @@ public class JalviewLite extends Applet
           param = setProtocolState(param);
 
           if (new AnnotationFile().readAnnotationFile(
-                  newAlignFrame.viewport.getAlignment(), param,
-                  protocol))
+                  newAlignFrame.viewport.getAlignment(), param, protocol))
           {
             newAlignFrame.alignPanel.fontChanged();
             newAlignFrame.alignPanel.setScrollValues(0, 0);
@@ -857,9 +949,8 @@ public class JalviewLite extends Applet
                   tmp2.addElement(st2.nextToken());
                   seqstring = st2.nextToken();
                 }
-                tmp.addElement((Sequence) newAlignFrame
-                        .getAlignViewport().getAlignment().findName(
-                                seqstring));
+                tmp.addElement((Sequence) newAlignFrame.getAlignViewport()
+                        .getAlignment().findName(seqstring));
               }
 
               seqs = new SequenceI[tmp.size()];
@@ -882,7 +973,7 @@ public class JalviewLite extends Applet
               // the local pdb file was identified in the class loader
               protocol = AppletFormatAdapter.URL; // this is probably NOT
               // CORRECT!
-              param = addProtocol(param); // 
+              param = addProtocol(param); //
             }
 
             pdb.setFile(param);
@@ -908,16 +999,9 @@ public class JalviewLite extends Applet
                 }
               }
 
-              if (jmolAvailable)
-              {
-                new jalview.appletgui.AppletJmol(pdb, seqs, chains,
-                        newAlignFrame.alignPanel, protocol);
-                lastFrameX += 40;
-                lastFrameY += 40;
-              }
-              else
-                new MCview.AppletPDBViewer(pdb, seqs, chains,
-                        newAlignFrame.alignPanel, protocol);
+              newAlignFrame.newStructureView(applet, pdb, seqs, chains,
+                      protocol);
+
             }
           }
 
@@ -931,13 +1015,13 @@ public class JalviewLite extends Applet
         param = getParameter("hidefeaturegroups");
         if (param != null)
         {
-          applet.setFeatureGroupStateOn(newAlignFrame,param, false);
+          applet.setFeatureGroupStateOn(newAlignFrame, param, false);
         }
         // show specific groups
         param = getParameter("showfeaturegroups");
         if (param != null)
         {
-          applet.setFeatureGroupStateOn(newAlignFrame,param, true);
+          applet.setFeatureGroupStateOn(newAlignFrame, param, true);
         }
       }
       else
@@ -952,7 +1036,7 @@ public class JalviewLite extends Applet
      * Discovers whether the given file is in the Applet Archive
      * 
      * @param file
-     *                String
+     *          String
      * @return boolean
      */
     boolean inArchive(String file)
@@ -1120,7 +1204,7 @@ public class JalviewLite extends Applet
 
   /**
    * @param alf
-   *                alignframe to get feature groups on
+   *          alignframe to get feature groups on
    * @return
    * @see jalview.appletgui.AlignFrame#getFeatureGroups()
    */
@@ -1143,7 +1227,7 @@ public class JalviewLite extends Applet
 
   /**
    * @param alf
-   *                align frame to get groups of state visible
+   *          align frame to get groups of state visible
    * @param visible
    * @return
    * @see jalview.appletgui.AlignFrame#getFeatureGroupsOfState(boolean)
@@ -1155,9 +1239,9 @@ public class JalviewLite extends Applet
 
   /**
    * @param groups
-   *                tab separated list of group names
+   *          tab separated list of group names
    * @param state
-   *                true or false
+   *          true or false
    * @see jalview.appletgui.AlignFrame#setFeatureGroupState(java.lang.String[],
    *      boolean)
    */
@@ -1188,10 +1272,83 @@ public class JalviewLite extends Applet
    * List separator string
    * 
    * @param separator
-   *                the separator to set
+   *          the separator to set
    */
   public void setSeparator(String separator)
   {
     this.separator = separator;
   }
+
+  /**
+   * get boolean value of applet parameter 'name' and return default if
+   * parameter is not set
+   * 
+   * @param name
+   *          name of paremeter
+   * @param def
+   *          the value to return otherwise
+   * @return true or false
+   */
+  public boolean getDefaultParameter(String name, boolean def)
+  {
+    String stn;
+    if ((stn = getParameter(name)) == null)
+    {
+      return def;
+    }
+    if (stn.toLowerCase().equals("true"))
+    {
+      return true;
+    }
+    return false;
+  }
+
+  /**
+   * bind a pdb file to a sequence in the given alignFrame.
+   * 
+   * @param alFrame
+   *          - null or specific alignFrame. This specifies the dataset that
+   *          will be searched for a seuqence called sequenceId
+   * @param sequenceId
+   *          - sequenceId within the dataset.
+   * @param pdbEntryString
+   *          - the short name for the PDB file
+   * @param pdbFile
+   *          - pdb file - either a URL or a valid PDB file.
+   * @return true if binding was as success TODO: consider making an exception
+   *         structure for indicating when PDB parsing or seqeunceId location
+   *         fails.
+   */
+  public boolean addPdbFile(AlignFrame alFrame, String sequenceId,
+          String pdbEntryString, String pdbFile)
+  {
+    return alFrame.addPdbFile(sequenceId, pdbEntryString, pdbFile);
+  }
+
+
+  /**
+   * bind structures in a viewer to any matching sequences in an alignFrame (use
+   * sequenceIds to limit scope of search to specific sequences)
+   * 
+   * @param alFrame
+   * @param viewer
+   * @param sequenceIds
+   * @return TODO: consider making an exception structure for indicating when
+   *         binding fails
+  public SequenceStructureBinding addStructureViewInstance(
+          AlignFrame alFrame, Object viewer, String sequenceIds)
+  {
+
+    if (sequenceIds != null && sequenceIds.length() > 0)
+    {
+      return alFrame.addStructureViewInstance(viewer,
+              separatorListToArray(sequenceIds));
+    }
+    else
+    {
+      return alFrame.addStructureViewInstance(viewer, null);
+    }
+    // return null;
+  }
+   */
 }