JAL-1645 Version-Rel Version 2.9 Year-Rel 2015 Licensing glob
[jalview.git] / src / jalview / datamodel / SequenceCollectionI.java
index f0d7284..96c7af8 100644 (file)
@@ -1,19 +1,22 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8)
- * Copyright (C) 2012 J Procter, AM Waterhouse, LM Lui, J Engelhardt, G Barton, M Clamp, S Searle
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.9)
+ * Copyright (C) 2015 The Jalview Authors
  * 
  * This file is part of Jalview.
  * 
  * Jalview is free software: you can redistribute it and/or
  * modify it under the terms of the GNU General Public License 
- * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
  *  
  * Jalview is distributed in the hope that it will be useful, but 
  * WITHOUT ANY WARRANTY; without even the implied warranty 
  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
  * PURPOSE.  See the GNU General Public License for more details.
  * 
- * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
  */
 package jalview.datamodel;
 
@@ -29,11 +32,31 @@ public interface SequenceCollectionI
 
   int getWidth();
 
-  /** 
-  * @return the first column included in this collection. Runs from 0<=i<N_cols
-  */
+  /**
+   * 
+   * @return true if getSeqrep doesn't return null
+   */
+  boolean hasSeqrep();
+
+  /**
+   * get the reference or representative sequence within this collection
+   * 
+   * @return null or the current reference sequence
+   */
+  SequenceI getSeqrep();
+
+  /**
+   * set the reference or representative sequence for this collection. Reference
+   * is assumed to be present within the collection.
+   * 
+   * @return
+   */
+  void setSeqrep(SequenceI refseq);
+
+  /**
+   * @return the first column included in this collection. Runs from 0<=i<N_cols
+   */
   int getStartRes();
-  
 
   /**
    *