gate.jape.constraint.CleanStringAccessor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of annie Show documentation

ANNIE is a general purpose information extraction system that provides the building blocks of many other GATE applications.

There is a newer version: 9.1

Show newest version

/*
 *  Copyright (c) 1995-2012, The University of Sheffield. See the file
 *  COPYRIGHT.txt in the software or at http://gate.ac.uk/gate/COPYRIGHT.txt
 *
 *  This file is part of GATE (see http://gate.ac.uk/), and is free
 *  software, licenced under the GNU Library General Public License,
 *  Version 2, June 1991 (in the distribution as file licence.html,
 *  and also available at http://gate.ac.uk/gate/licence.html).
 *
 *  Eric Sword, 09/03/08
 *
 *  $Id$
 */
package gate.jape.constraint;

import gate.Annotation;
import gate.AnnotationSet;
import gate.Document;
import gate.Utils;

/**
 * Accessor that returns the underlying string of an annotation in a
 * document. The string is cleaned up a bit as follows: 
 * cleanString = string.replaceAll("\\s+", " ").trim();
 * 
 * 
 * @author esword
 */
public class CleanStringAccessor extends StringAccessor {

  private static final long serialVersionUID = -4213321436300709066L;

  /**
   * Return the cleaned up underlying string for the annotation. Context
   * must be a {@link Document} or an {@link AnnotationSet} which points
   * to the document.
   */
  @Override
  public Object getValue(Annotation annot, AnnotationSet context) {
    return Utils.cleanString((String)super.getValue(annot, context));
  }

  /**
   * Always returns "cleanString", the name of the meta-property which
   * this accessor provides.
   */
  @Override
  public Object getKey() {
    return "cleanString";
  }

}