JAL-3210 Improvements to eclipse detection. New src tree and SwingJS updated from...
[jalview.git] / src / jalview / gui / AssociatePdbFileWithSeq.java
index fdc95dd..1f540da 100644 (file)
@@ -1,30 +1,34 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.0b1)
- * Copyright (C) 2014 The Jalview Authors
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
  * 
  * This file is part of Jalview.
  * 
  * 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.
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
  *  
  * 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/>.
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  * The Jalview Authors are detailed in the 'AUTHORS' file.
  */
 package jalview.gui;
 
-import javax.swing.JOptionPane;
-
 import jalview.datamodel.PDBEntry;
 import jalview.datamodel.SequenceI;
+import jalview.io.DataSourceType;
+import jalview.io.StructureFile;
+import jalview.util.MessageManager;
 
 /**
- * GUI related routines for associating PDB files with sequences
+ * GUI related routines for associating PDB files with sequences. A single
+ * static method.
  * 
  * @author JimP
  * 
@@ -32,52 +36,56 @@ import jalview.datamodel.SequenceI;
 public class AssociatePdbFileWithSeq
 {
 
+  private AssociatePdbFileWithSeq()
+  {
+    // inaccessible
+  }
+
   /**
-   * assocate the given PDB file with
+   * Associate the given PDB file name or URL with a sequence. Do not map
+   * mouse-over events.
    * 
-   * @param choice
+   * @param fileName
+   *          or URL
+   * @param type
+   *          will be DataType.FILE or DataType.URL
    * @param sequence
+   *          to associate
+   * @param prompt
+   *          true if the user should be asked what to do if the specified file
+   *          does not seem to contain PDB information (StructureChooser only)
+   * @return null if file is not found
    */
-  public PDBEntry associatePdbWithSeq(String choice, String protocol,
-          SequenceI sequence, boolean prompt)
+  public static PDBEntry associatePdbWithSeq(String fileName,
+          DataSourceType type, SequenceI sequence, boolean prompt)
   {
     PDBEntry entry = new PDBEntry();
-    try
+    StructureFile pdbfile = null;
+    pdbfile = Desktop.getStructureSelectionManager()
+            .setMapping(false, new SequenceI[]
+            { sequence }, null, fileName, type);
+    if (pdbfile == null)
     {
-      MCview.PDBfile pdbfile = new MCview.PDBfile(choice, protocol);
-
-      if (pdbfile.id == null)
-      {
-        String reply = null;
-
-        if (prompt)
-        {
-          reply = JOptionPane
-                  .showInternalInputDialog(
-                          Desktop.desktop,
-                          "Couldn't find a PDB id in the file supplied."
-                                  + "Please enter an Id to identify this structure.",
-                          "No PDB Id in File", JOptionPane.QUESTION_MESSAGE);
-        }
-        if (reply == null)
-        {
-          return null;
-        }
-
-        entry.setId(reply);
-      }
-      else
-      {
-        entry.setId(pdbfile.id);
-      }
-    } catch (java.io.IOException ex)
+      // stacktrace already thrown so just return
+      return null;
+    }
+    String id = pdbfile.getId();
+    if (id == null && (id = (prompt
+            ? JvOptionPane.showInternalInputDialog(Desktop.getDesktopPane(),
+                    MessageManager
+                            .getString("label.couldnt_find_pdb_id_in_file"),
+                    MessageManager.getString("label.no_pdb_id_in_file"),
+                    JvOptionPane.QUESTION_MESSAGE)
+            : null)) == null)
     {
-      ex.printStackTrace();
+      return null;
     }
-
-    entry.setFile(choice);
+    entry.setId(id);
+    entry.setType(PDBEntry.Type.FILE);
+    entry.setFile(fileName);
     sequence.getDatasetSequence().addPDBId(entry);
+    Desktop.getInstance().getStructureSelectionManager()
+            .registerPDBEntry(entry);
     return entry;
   }
-
 }