src/jalview/datamodel/SequenceCollectionI.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.datamodel;
  22
  23 import jalview.analysis.Conservation;
  24
  25 import java.util.Hashtable;
  26 import java.util.List;
  27 import java.util.Map;
  28
  29 public interface SequenceCollectionI
  30 {
  31   /**
  32    *
  33    * @return (visible) sequences in this collection. This may be a direct
  34    *         reference to the collection so not thread safe
  35    */
  36   List<SequenceI> getSequences();
  37
  38   /**
  39    * FIXME: AlignmentI.getSequences(hiddenReps) doesn't actually obey this
  40    * contract!
  41    *
  42    * @param hiddenReps
  43    * @return the full set of sequences in this collection, including any
  44    *         sequences represented by sequences in the collection.
  45    */
  46   List<SequenceI> getSequences(
  47           Map<SequenceI, SequenceCollectionI> hiddenReps);
  48
  49   int getWidth();
  50
  51   /**
  52    *
  53    * @return true if getSeqrep doesn't return null
  54    */
  55   boolean hasSeqrep();
  56
  57   /**
  58    * get the reference or representative sequence within this collection
  59    *
  60    * @return null or the current reference sequence
  61    */
  62   SequenceI getSeqrep();
  63
  64   /**
  65    * set the reference or representative sequence for this collection. Reference
  66    * is assumed to be present within the collection.
  67    *
  68    * @return
  69    */
  70   void setSeqrep(SequenceI refseq);
  71
  72   /**
  73    * @return the first column included in this collection. Runs from 0<=i<N_cols
  74    */
  75   int getStartRes();
  76
  77   /**
  78    *
  79    * @return the last column in this collection. Runs from 0<=i<N_cols
  80    */
  81   int getEndRes();
  82
  83   /**
  84    * Answers true if sequence data is nucleotide (according to some heuristic)
  85    *
  86    * @return
  87    */
  88   boolean isNucleotide();
  89
  90   /**
  91    *
  92    * @return the physicochemical property conservation for this sequence
  93    *         collection (protein only)
  94    */
  95   Conservation getConservation();
  96
  97   /**
  98    *
  99    * @return null or a valid Codon consensus object (protein only)
 100    */
 101   Hashtable[] getComplementConsensusHash();
 102
 103   /**
 104    *
 105    * @return null or a valid RNA Structure base pair consensus object (nucleotide
 106    *         only)
 107    */
 108   Hashtable[] getRnaStructureConsensusHash();
 109
 110   /**
 111    *
 112    * @return null or the consensus profile for this collection if it has been
 113    *         calculated
 114    */
 115   ProfilesI getSequenceConsensusHash();
 116
 117 }