gate.creole.ir.IndexField Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gate-core Show documentation

GATE - general achitecture for text engineering - is open source software capable of solving almost any text processing problem. This artifact enables you to embed the core GATE Embedded with its essential dependencies. You will able to use the GATE Embedded API and load and store GATE XML documents. This artifact is the perfect dependency for CREOLE plugins or for applications that need to customize the GATE dependencies due to confict with their own dependencies or for lower footprint.

The newest version!

/*
 *  IndexField.java
 *
 *  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).
 *
 *  Rosen Marinov, 19/Apr/2002
 *
 */

package gate.creole.ir;

import java.io.Serializable;

public class IndexField implements Serializable{

  static final long serialVersionUID = 3632609241787241616L;

  /** Name of field for indexing - the name of the feature key of
   *  the document should be same. */
  private String fieldName;

  /** Reader object for this field. Can be NULL. */
  private PropertyReader propReader;

  /** If set to true then the value should not be modified by the analyzer. */
  private boolean isPreseved;

  /** Constructor of the class. */
  public IndexField(String name, PropertyReader rdr, boolean preseved) {
    this.fieldName = name;
    this.propReader = rdr;
    this.isPreseved = preseved;
  }

  /** @return String name of the field.*/
  public String getName(){
    return fieldName;
  }

  /** @return Reader object for this field or null */
  public PropertyReader getReader(){
    return propReader;
  }

  /** @return boolean preservation of value */
  public boolean isPreseved(){
    return isPreseved;
  }

}