AnnotationData.java
01 /*
02  *  Copyright (c) 1995-2012, The University of Sheffield. See the file
03  *  COPYRIGHT.txt in the software or at http://gate.ac.uk/gate/COPYRIGHT.txt
04  *
05  *  This file is part of GATE (see http://gate.ac.uk/), and is free
06  *  software, licenced under the GNU Library General Public License,
07  *  Version 2, June 1991 (in the distribution as file licence.html,
08  *  and also available at http://gate.ac.uk/gate/licence.html).
09  *
10  *  Valentin Tablan, 24 Apr 2008
11  *
12  *  $Id: AnnotationData.java 15333 2012-02-07 13:18:33Z ian_roberts $
13  */
14 package gate.gui.annedit;
15 
16 import gate.Annotation;
17 import gate.AnnotationSet;
18 
19 /**
20  * A structure for storing the information describing an annotation (i.e. the 
21  {@link Annotation} object and its enclosing {@link AnnotationSet}.
22  */
23 public interface AnnotationData {
24   /**
25    * Gets the {@link Annotation} object represented by this structure.
26    @return an {@link Annotation} value.
27    */
28   public Annotation getAnnotation();
29   
30   /**
31    * Gets the {@link AnnotationSet} object containing the annotation stored 
32    * by this structure.
33    @return an {@link AnnotationSet} value.
34    */    
35   public AnnotationSet getAnnotationSet();
36 }