stores reference to dataset sequence if present
[jalview.git] / src / jalview / analysis / SeqsetUtils.java
index cdcecc0..06a8192 100755 (executable)
-package jalview.analysis;
-
-import jalview.datamodel.SequenceI;
-import java.util.Hashtable;
-
-/**
- * <p>Title: </p>
- *
- * <p>Description: </p>
- *
- * <p>Copyright: Copyright (c) 2004</p>
- *
- * <p>Company: Dundee University</p>
- *
- * @author not attributable
- * @version 1.0
- */
-public class SeqsetUtils
-{
-  public static Hashtable uniquify(SequenceI[] sequences)
-  {
-    // Generate a safely named sequence set and a hash to recover the sequence names
-    Hashtable map = new Hashtable();
-    for (int i = 0; i < sequences.length; i++)
-    {
-      String safename = new String("Sequence" + i);
-      map.put(safename, sequences[i].getName());
-      sequences[i].setName(safename);
-    }
-    return map;
-  }
-
-  public static boolean deuniquify(Hashtable map, SequenceI[] sequences)
-  {
-    // recover unsafe sequence names for a sequence set
-    boolean allfound = true;
-    for (int i = 0; i < sequences.length; i++)
-    {
-      if (map.containsKey(sequences[i].getName()))
-      {
-        String unsafename = (String) map.get(sequences[i].getName());
-        sequences[i].setName(unsafename);
-      }
-      else
-      {
-        allfound = false;
-      }
-    }
-    return allfound;
-  }
-
-}
+/*\r
+ * Jalview - A Sequence Alignment Editor and Viewer\r
+ * Copyright (C) 2005 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
+ *\r
+ * This program is free software; you can redistribute it and/or\r
+ * modify it under the terms of the GNU General Public License\r
+ * as published by the Free Software Foundation; either version 2\r
+ * of the License, or (at your option) any later version.\r
+ *\r
+ * This program is distributed in the hope that it will be useful,\r
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
+ * GNU General Public License for more details.\r
+ *\r
+ * You should have received a copy of the GNU General Public License\r
+ * along with this program; if not, write to the Free Software\r
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA\r
+ */\r
+package jalview.analysis;\r
+\r
+import java.util.*;\r
+\r
+import jalview.datamodel.*;\r
+\r
+/**\r
+ * <p>Title: </p>\r
+ *\r
+ * <p>Description: </p>\r
+ *\r
+ * <p>Copyright: Copyright (c) 2004</p>\r
+ *\r
+ * <p>Company: Dundee University</p>\r
+ *\r
+ * @author not attributable\r
+ * @version 1.0\r
+ */\r
+public class SeqsetUtils\r
+{\r
+\r
+  /**\r
+   * Store essential properties of a sequence in a hashtable for later recovery\r
+   *  Keys are Name, Start, End, SeqFeatures, PdbId\r
+   * @param seq SequenceI\r
+   * @return Hashtable\r
+   */\r
+  public static Hashtable SeqCharacterHash(SequenceI seq)\r
+  {\r
+    Hashtable sqinfo = new Hashtable();\r
+    sqinfo.put("Name", seq.getName());\r
+    sqinfo.put("Start", new Integer(seq.getStart()));\r
+    sqinfo.put("End", new Integer(seq.getEnd()));\r
+    sqinfo.put("SeqFeatures", (seq.getSequenceFeatures() !=null) ? seq.getSequenceFeatures() : new Vector());\r
+    sqinfo.put("PdbId",\r
+               (seq.getPDBId() != null) ? seq.getPDBId() : new String(""));\r
+    sqinfo.put("datasetSequence", (seq.getDatasetSequence() !=null) ? seq.getDatasetSequence() : new Sequence("THISISAPLACEHOLDER",""));\r
+    return sqinfo;\r
+  }\r
+\r
+  /**\r
+   * Recover essential properties of a sequence from a hashtable\r
+   * TODO: replace these methods with something more elegant.\r
+   * @param sq SequenceI\r
+   * @param sqinfo Hashtable\r
+   * @return boolean\r
+   */\r
+  public static boolean SeqCharacterUnhash(SequenceI sq, Hashtable sqinfo)\r
+  {\r
+    boolean namePresent = true;\r
+    String oldname = (String) sqinfo.get("Name");\r
+    Integer start = (Integer) sqinfo.get("Start");\r
+    Integer end = (Integer) sqinfo.get("End");\r
+    java.util.Vector sfeatures = (java.util.Vector) sqinfo.get(\r
+        "SeqFeatures");\r
+    String pdbid = (String) sqinfo.get("PdbId");\r
+    Sequence seqds = (Sequence) sqinfo.get("datasetSequence");\r
+    if (oldname == null)\r
+    {\r
+      namePresent = false;\r
+    }\r
+    else\r
+    {\r
+      sq.setName(oldname);\r
+    }\r
+\r
+    if (!pdbid.equals(""))\r
+    {\r
+      sq.setPDBId(pdbid);\r
+    }\r
+\r
+    if ( (start != null) && (end != null))\r
+    {\r
+      sq.setStart(start.intValue());\r
+      sq.setEnd(end.intValue());\r
+    }\r
+\r
+    if ((sfeatures != null) && (sfeatures.size()>0))\r
+    {\r
+      sq.setSequenceFeatures(sfeatures);\r
+    }\r
+    if ((seqds!=null) && !(seqds.getName().equals("THISISAPLACEHOLDER") && seqds.getLength()==0)) {\r
+      sq.setDatasetSequence(seqds);\r
+    }\r
+\r
+    return namePresent;\r
+  }\r
+\r
+  /**\r
+   * Form of the unique name used in uniquify for the i'th sequence in an ordered vector of sequences.\r
+   * @param i int\r
+   * @return String\r
+   */\r
+  public static String unique_name(int i)\r
+  {\r
+    return new String("Sequence" + i);\r
+  }\r
+\r
+  public static Hashtable uniquify(SequenceI[] sequences, boolean write_names)\r
+  {\r
+    // Generate a safely named sequence set and a hash to recover the sequence names\r
+    Hashtable map = new Hashtable();\r
+    //String[] un_names = new String[sequences.length];\r
+\r
+    for (int i = 0; i < sequences.length; i++)\r
+    {\r
+      String safename = unique_name(i);\r
+      map.put(safename, SeqCharacterHash(sequences[i]));\r
+\r
+      if (write_names)\r
+      {\r
+        sequences[i].setName(safename);\r
+      }\r
+    }\r
+\r
+\r
+    return map;\r
+  }\r
+\r
+  public static boolean deuniquify(Hashtable map, SequenceI[] sequences)\r
+  {\r
+    // recover unsafe sequence names for a sequence set\r
+    boolean allfound = true;\r
+\r
+    for (int i = 0; i < sequences.length; i++)\r
+    {\r
+      if (map.containsKey(sequences[i].getName()))\r
+      {\r
+        Hashtable sqinfo = (Hashtable) map.get(sequences[i].getName());\r
+        SeqCharacterUnhash(sequences[i], sqinfo);\r
+      }\r
+      else\r
+      {\r
+        allfound = false;\r
+      }\r
+    }\r
+\r
+    return allfound;\r
+  }\r
+}\r