JAL-2994 put ‘\’ first in character class clause of regex - otherwise doesn’t compile...
[jalview.git] / src / jalview / datamodel / AnnotatedCollectionI.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 public interface AnnotatedCollectionI extends SequenceCollectionI
24 {
25
26   /**
27    * TODO: decide if null is a valid response if there is no annotation on the
28    * object
29    * 
30    * @return null
31    */
32   AlignmentAnnotation[] getAlignmentAnnotation();
33
34   /**
35    * Returns a list of annotations matching the given calc id, or an empty list
36    * if calcId is null
37    * 
38    * @param calcId
39    * @return
40    */
41   Iterable<AlignmentAnnotation> findAnnotation(String calcId);
42
43   /**
44    * Returns an iterable collection of any annotations that match on given
45    * sequence ref, calcId and label (ignoring null values).
46    * 
47    * @param seq
48    *          null or reference sequence to select annotation for
49    * @param calcId
50    *          null or the calcId to select annotation for
51    * @param label
52    *          null or the label to select annotation for
53    */
54   Iterable<AlignmentAnnotation> findAnnotations(SequenceI seq,
55           String calcId, String label);
56
57   /**
58    * context for this annotated collection
59    * 
60    * @return null or the collection upon which this collection is defined (e.g.
61    *         alignment, parent group).
62    */
63   AnnotatedCollectionI getContext();
64
65   
66 }