src/jalview/analysis/SeqsetUtils.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.analysis;
  22
  23 import jalview.datamodel.PDBEntry;
  24 import jalview.datamodel.Sequence;
  25 import jalview.datamodel.SequenceFeature;
  26 import jalview.datamodel.SequenceI;
  27
  28 import java.util.Enumeration;
  29 import java.util.Hashtable;
  30 import java.util.List;
  31 import java.util.Vector;
  32
  33 public class SeqsetUtils
  34 {
  35
  36   /**
  37    * Store essential properties of a sequence in a hashtable for later recovery
  38    * Keys are Name, Start, End, SeqFeatures, PdbId
  39    *
  40    * @param seq
  41    *          SequenceI
  42    * @return Hashtable
  43    */
  44   public static Hashtable SeqCharacterHash(SequenceI seq)
  45   {
  46     Hashtable sqinfo = new Hashtable();
  47     sqinfo.put("Name", seq.getName());
  48     sqinfo.put("Start", new Integer(seq.getStart()));
  49     sqinfo.put("End", new Integer(seq.getEnd()));
  50     if (seq.getDescription() != null)
  51     {
  52       sqinfo.put("Description", seq.getDescription());
  53     }
  54
  55     Vector<SequenceFeature> sfeat = new Vector<SequenceFeature>();
  56     List<SequenceFeature> sfs = seq.getFeatures().getAllFeatures();
  57     sfeat.addAll(sfs);
  58
  59     if (seq.getDatasetSequence() == null)
  60     {
  61       sqinfo.put("SeqFeatures", sfeat);
  62       sqinfo.put("PdbId",
  63               (seq.getAllPDBEntries() != null) ? seq.getAllPDBEntries()
  64                       : new Vector<PDBEntry>());
  65     }
  66     else
  67     {
  68       sqinfo.put("datasetSequence",
  69               (seq.getDatasetSequence() != null) ? seq.getDatasetSequence()
  70                       : new Sequence("THISISAPLACEHOLDER", ""));
  71     }
  72     return sqinfo;
  73   }
  74
  75   /**
  76    * Recover essential properties of a sequence from a hashtable TODO: replace
  77    * these methods with something more elegant.
  78    *
  79    * @param sq
  80    *          SequenceI
  81    * @param sqinfo
  82    *          Hashtable
  83    * @return boolean true if name was not updated from sqinfo Name entry
  84    */
  85   public static boolean SeqCharacterUnhash(SequenceI sq, Hashtable sqinfo)
  86   {
  87     boolean namePresent = true;
  88     if (sqinfo == null)
  89     {
  90       return false;
  91     }
  92     String oldname = (String) sqinfo.get("Name");
  93     Integer start = (Integer) sqinfo.get("Start");
  94     Integer end = (Integer) sqinfo.get("End");
  95     Vector<SequenceFeature> sfeatures = (Vector<SequenceFeature>) sqinfo
  96             .get("SeqFeatures");
  97     Vector<PDBEntry> pdbid = (Vector<PDBEntry>) sqinfo.get("PdbId");
  98     String description = (String) sqinfo.get("Description");
  99     Sequence seqds = (Sequence) sqinfo.get("datasetSequence");
 100     if (oldname == null)
 101     {
 102       namePresent = false;
 103     }
 104     else
 105     {
 106       sq.setName(oldname);
 107     }
 108     if (pdbid != null && pdbid.size() > 0)
 109     {
 110       sq.setPDBId(pdbid);
 111     }
 112
 113     if ((start != null) && (end != null))
 114     {
 115       sq.setStart(start.intValue());
 116       sq.setEnd(end.intValue());
 117     }
 118
 119     if (sfeatures != null && !sfeatures.isEmpty())
 120     {
 121       sq.setSequenceFeatures(sfeatures);
 122     }
 123     if (description != null)
 124     {
 125       sq.setDescription(description);
 126     }
 127     if ((seqds != null)
 128             && !(seqds.getName().equals("THISISAPLACEHOLDER") && seqds
 129                     .getLength() == 0))
 130     {
 131       if (sfeatures != null)
 132       {
 133         System.err
 134                 .println("Implementation error: setting dataset sequence for a sequence which has sequence features.\n\tDataset sequence features will not be visible.");
 135       }
 136       sq.setDatasetSequence(seqds);
 137     }
 138
 139     return namePresent;
 140   }
 141
 142   /**
 143    * Form of the unique name used in uniquify for the i'th sequence in an
 144    * ordered vector of sequences.
 145    *
 146    * @param i
 147    *          int
 148    * @return String
 149    */
 150   public static String unique_name(int i)
 151   {
 152     return new String("Sequence" + i);
 153   }
 154
 155   /**
 156    * Generates a hash of SeqCharacterHash properties for each sequence in a
 157    * sequence set, and optionally renames the sequences to an unambiguous 'safe'
 158    * name.
 159    *
 160    * @param sequences
 161    *          SequenceI[]
 162    * @param write_names
 163    *          boolean set this to rename each of the sequences to its
 164    *          unique_name(index) name
 165    * @return Hashtable to be passed to
 166    * @see deuniquify to recover original names (and properties) for renamed
 167    *      sequences
 168    */
 169   public static Hashtable uniquify(SequenceI[] sequences,
 170           boolean write_names)
 171   {
 172     // Generate a safely named sequence set and a hash to recover the sequence
 173     // names
 174     Hashtable map = new Hashtable();
 175     // String[] un_names = new String[sequences.length];
 176
 177     for (int i = 0; i < sequences.length; i++)
 178     {
 179       String safename = unique_name(i);
 180       map.put(safename, SeqCharacterHash(sequences[i]));
 181
 182       if (write_names)
 183       {
 184         sequences[i].setName(safename);
 185       }
 186     }
 187
 188     return map;
 189   }
 190
 191   /**
 192    * recover unsafe sequence names and original properties for a sequence set
 193    * using a map generated by
 194    *
 195    * @see uniquify(sequences,true)
 196    * @param map
 197    *          Hashtable
 198    * @param sequences
 199    *          SequenceI[]
 200    * @return boolean
 201    */
 202   public static boolean deuniquify(Hashtable map, SequenceI[] sequences)
 203   {
 204     return deuniquify(map, sequences, true);
 205   }
 206
 207   /**
 208    * recover unsafe sequence names and original properties for a sequence set
 209    * using a map generated by
 210    *
 211    * @see uniquify(sequences,true)
 212    * @param map
 213    *          Hashtable
 214    * @param sequences
 215    *          SequenceI[]
 216    * @param quiet
 217    *          when false, don't complain about sequences without any data in the
 218    *          map.
 219    * @return boolean
 220    */
 221   public static boolean deuniquify(Hashtable map, SequenceI[] sequences,
 222           boolean quiet)
 223   {
 224     jalview.analysis.SequenceIdMatcher matcher = new SequenceIdMatcher(
 225             sequences);
 226     SequenceI msq = null;
 227     Enumeration keys = map.keys();
 228     Vector unmatched = new Vector();
 229     for (int i = 0, j = sequences.length; i < j; i++)
 230     {
 231       unmatched.addElement(sequences[i]);
 232     }
 233     while (keys.hasMoreElements())
 234     {
 235       Object key = keys.nextElement();
 236       if (key instanceof String)
 237       {
 238         if ((msq = matcher.findIdMatch((String) key)) != null)
 239         {
 240           Hashtable sqinfo = (Hashtable) map.get(key);
 241           unmatched.removeElement(msq);
 242           SeqCharacterUnhash(msq, sqinfo);
 243         }
 244         else
 245         {
 246           if (!quiet)
 247           {
 248             System.err.println("Can't find '" + ((String) key)
 249                     + "' in uniquified alignment");
 250           }
 251         }
 252       }
 253     }
 254     if (unmatched.size() > 0 && !quiet)
 255     {
 256       System.err.println("Did not find matches for :");
 257       for (Enumeration i = unmatched.elements(); i.hasMoreElements(); System.out
 258               .println(((SequenceI) i.nextElement()).getName()))
 259       {
 260         ;
 261       }
 262       return false;
 263     }
 264
 265     return true;
 266   }
 267
 268   /**
 269    * returns a subset of the sequenceI seuqences, including only those that
 270    * contain at least one residue.
 271    *
 272    * @param sequences
 273    *          SequenceI[]
 274    * @return SequenceI[]
 275    */
 276   public static SequenceI[] getNonEmptySequenceSet(SequenceI[] sequences)
 277   {
 278     // Identify first row of alignment with residues for prediction
 279     boolean ungapped[] = new boolean[sequences.length];
 280     int msflen = 0;
 281     for (int i = 0, j = sequences.length; i < j; i++)
 282     {
 283       String tempseq = jalview.analysis.AlignSeq.extractGaps(
 284               jalview.util.Comparison.GapChars,
 285               sequences[i].getSequenceAsString());
 286
 287       if (tempseq.length() == 0)
 288       {
 289         ungapped[i] = false;
 290       }
 291       else
 292       {
 293         ungapped[i] = true;
 294         msflen++;
 295       }
 296     }
 297     if (msflen == 0)
 298     {
 299       return null; // no minimal set
 300     }
 301     // compose minimal set
 302     SequenceI[] mset = new SequenceI[msflen];
 303     for (int i = 0, j = sequences.length, k = 0; i < j; i++)
 304     {
 305       if (ungapped[i])
 306       {
 307         mset[k++] = sequences[i];
 308       }
 309     }
 310     ungapped = null;
 311     return mset;
 312   }
 313 }