mention.java

自然语言处理领域的一个开发包

///////////////////////////////////////////////////////////////////////////////
//Copyright (C) 2003 Thomas Morton
//
//This library is free software; you can redistribute it and/or
//modify it under the terms of the GNU Lesser General Public
//License as published by the Free Software Foundation; either
//version 2.1 of the License, or (at your option) any later version.
//
//This library is distributed in the hope that it will be useful,
//but WITHOUT ANY WARRANTY; without even the implied warranty of
//MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//GNU Lesser General Public License for more details.
//
//You should have received a copy of the GNU Lesser General Public
//License along with this program; if not, write to the Free Software
//Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
//////////////////////////////////////////////////////////////////////////////
package opennlp.tools.coref.mention;

import opennlp.tools.util.Span;

/**
 * Data strucure representation of a mention.
 */
public class Mention implements Comparable {

  /** Represents the character offset for this extent. */
  private Span span;
  
  /** A string representing the type of this extent.  This is helpfull for determining
   * which piece of code created a particular extent.
   */
  protected String type;
  /** The entity id indicating which entity this extent belongs to.  This is only
   * used when training a coreference classifier.
   */
  private int id;
  
  /** Represents the character offsets of the the head of this extent. */
  private Span headSpan;
  
  /** The parse node that this extent is based on. */
  protected Parse parse;
  
  /** A string representing the name type for this extent. */
  protected String nameType;
    
  
  public Mention(Span span, Span headSpan, int entityId, Parse parse, String extentType) {
    this.span=span;
    this.headSpan=headSpan;
    this.id=entityId;
    this.type=extentType;
    this.parse = parse;
  }
  
  public Mention(Span span, Span headSpan, int entityId, Parse parse, String extentType, String nameType) {
    this.span=span;
    this.headSpan=headSpan;
    this.id=entityId;
    this.type=extentType;
    this.parse = parse;
    this.nameType = nameType;
  }
  
  public Mention(Mention mention) {
    this(mention.span,mention.headSpan,mention.id,mention.parse,mention.type,mention.nameType);
  }

  /**
   * Returns the character offsets for this extent.
   * @return The span representing the character offsets of this extent.
   */
  public Span getSpan() {
    return(span);
  }

  /**
   * Returns the character offsets for the head of this extent.
   * @return The span representing the character offsets for the head of this extent.
   */
  public Span getHeadSpan() {
    return(headSpan);
  }
  
  /** 
   * Returns the parse node that this extent is based on.
   * @return The parse node that this extent is based on or null if the extent is newly created.
   */
  public Parse getParse() {
    return parse;
  }
  
  public int compareTo(Object o) {
    Mention e = (Mention) o;
    return(span.compareTo(e.span));
  }
  
  /**
   * Specifies the parse for this mention.
   * @param parse The parse for this mention.
   */
  public void setParse(Parse parse) {
    this.parse = parse;
  }

  /**
   * Returns the named-entity category associated with this mention.
   * @return the named-entity category associated with this mention.
   */
  public String getNameType() {
    return nameType;
  }
  
  /**
   * Specifies the named-entity category associated with this mention.
   * @param nameType the named-entity category associated with this mention.
   */
  protected void setNameType(String nameType) {
    this.nameType = nameType;
  }

  /**
   * Associates an id with this mention.
   * @param i The id for this mention.
   */
  public void setId(int i) {
    id=i;
  }

  /**
   * Returns the id associated with this mention.
   * @return the id associated with this mention.
   */
  public int getId() {
    return(id);
  }

  public String toString() {
    return("mention(span="+span+",hs="+headSpan+", type="+type+", id="+id+" "+parse+" )"); 
  }

}