X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fdatamodel%2FSequenceCollectionI.java;h=e2bb5a64939182245a646779a1e3594f49fdf727;hb=a7169b1c72607f3c9357195b4999869650a2a891;hp=34cf1755b699710b113f1a645ac656951e93e6b9;hpb=b57a02c25e335d033c97f8a6bacd6b54f62bd2b6;p=jalview.git
diff --git a/src/jalview/datamodel/SequenceCollectionI.java b/src/jalview/datamodel/SequenceCollectionI.java
index 34cf175..e2bb5a6 100644
--- a/src/jalview/datamodel/SequenceCollectionI.java
+++ b/src/jalview/datamodel/SequenceCollectionI.java
@@ -1,3 +1,23 @@
+/*
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ 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.
+ *
+ * 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 .
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
+ */
package jalview.datamodel;
import java.util.List;
@@ -5,11 +25,62 @@ import java.util.Map;
public interface SequenceCollectionI
{
+ /**
+ *
+ * @return (visible) sequences in this collection. This may be a direct
+ * reference to the collection so not thread safe
+ */
List getSequences();
+ /**
+ * FIXME: AlignmentI.getSequences(hiddenReps) doesn't actually obey this
+ * contract!
+ *
+ * @param hiddenReps
+ * @return the full set of sequences in this collection, including any
+ * sequences represented by sequences in the collection.
+ */
List getSequences(
Map hiddenReps);
int getWidth();
+ /**
+ *
+ * @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