CleanStringAccessor.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.Annotation;
17 import gate.AnnotationSet;
18 import gate.Document;
19 import gate.Utils;
20 
21 /**
22  * Accessor that returns the underlying string of an annotation in a
23  * document. The string is cleaned up a bit as follows: <code>
24  * cleanString = string.replaceAll("\\s+", " ").trim();
25  </code>
26  
27  @author esword
28  */
29 public class CleanStringAccessor extends StringAccessor {
30 
31   private static final long serialVersionUID = -4213321436300709066L;
32 
33   /**
34    * Return the cleaned up underlying string for the annotation. Context
35    * must be a {@link Document} or an {@link AnnotationSet} which points
36    * to the document.
37    */
38   @Override
39   public Object getValue(Annotation annot, AnnotationSet context) {
40     return Utils.cleanString((String)super.getValue(annot, context));
41   }
42 
43   /**
44    * Always returns "cleanString", the name of the meta-property which
45    * this accessor provides.
46    */
47   @Override
48   public Object getKey() {
49     return "cleanString";
50   }
51 
52 }