src/jalview/datamodel/SequenceCollectionI.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8)
   3  * Copyright (C) 2012 J Procter, AM Waterhouse, LM Lui, J Engelhardt, G Barton, M Clamp, S Searle
   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 of the License, or (at your option) any later version.
  10  *
  11  * Jalview is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty
  13  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  14  * PURPOSE.  See the GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18 package jalview.datamodel;
  19
  20 import java.util.List;
  21 import java.util.Map;
  22
  23 public interface SequenceCollectionI
  24 {
  25   List<SequenceI> getSequences();
  26
  27   List<SequenceI> getSequences(
  28           Map<SequenceI, SequenceCollectionI> hiddenReps);
  29   int getWidth();
  30   /**
  31    *
  32    * @return true if getSeqrep doesn't return null
  33    */
  34   boolean hasSeqrep();
  35   /**
  36    * get the reference or representative sequence within this collection
  37    * @return null or the current reference sequence
  38    */
  39   SequenceI getSeqrep();
  40   /**
  41    * set the reference or representative sequence for this collection.
  42    * Reference is assumed to be present within the collection.
  43    * @return
  44    */
  45   void setSeqrep(SequenceI refseq);
  46 }