StringAccessor.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  *  Eric Sword, 09/03/08
11  *
12  *  $Id$
13  */
14 package gate.jape.constraint;
15 
16 import gate.*;
17 
18 /**
19  * Accessor that returns the underlying string of an annotation in a document.
20  *
21  @version $Revision$
22  @author esword
23  */
24 public class StringAccessor extends MetaPropertyAccessor {
25 
26   private static final long serialVersionUID = 2694222663341694646L;
27 
28   /**
29    * Return the underlying string for the annotation. Context
30    * must be a {@link Document} or an {@link AnnotationSet} which
31    * points to the document.
32    */
33   @Override
34   public Object getValue(Annotation annot, AnnotationSet context) {
35     if(annot == nullreturn null;
36 
37     Document doc = context.getDocument();
38 
39     String retVal = doc.getContent().toString().substring(
40             annot.getStartNode().getOffset().intValue(),
41             annot.getEndNode().getOffset().intValue());
42     if (retVal == null)
43         return "";
44     return retVal;
45   }
46 
47   /**
48    * Always returns "string", the name of the meta-property which this
49    * accessor provides.
50    */
51   @Override
52   public Object getKey() {
53     return "string";
54   }
55 
56 }