src/jalview/datamodel/AnnotatedCollectionI.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
   3  * Copyright (C) 2014 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   Iterable<AlignmentAnnotation> findAnnotation(String calcId);
  35
  36   /**
  37    * context for this annotated collection
  38    *
  39    * @return null or the collection upon which this collection is defined (e.g.
  40    *         alignment, parent group).
  41    */
  42   AnnotatedCollectionI getContext();
  43
  44   /**
  45    * Return an iterable set of any annotations in the collection that match the
  46    * provided criteria, i.e.
  47    * <ul>
  48    * <li>reference the same sequence datasequence</li>
  49    * <li>have the same calcId (source of annotation)</li>
  50    * <li>have the same label (type of annotation)</li>
  51    * </ul>
  52    *
  53    * @param datasequence
  54    * @param calcId
  55    * @param label
  56    * @return
  57    */
  58   Iterable<AlignmentAnnotation> findAnnotation(SequenceI datasequence,
  59           String calcId, String label);
  60 }