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