edu.stanford.nlp.ling.tokensregex.matcher.Match Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of stanford-corenlp Show documentation

Stanford CoreNLP provides a set of natural language analysis tools which can take raw English language text input and give the base forms of words, their parts of speech, whether they are names of companies, people, etc., normalize dates, times, and numeric quantities, mark up the structure of sentences in terms of phrases and word dependencies, and indicate which noun phrases refer to the same entities. It provides the foundational building blocks for higher level text understanding applications.

There is a newer version: 4.5.7

Show newest version

package edu.stanford.nlp.ling.tokensregex.matcher;

import edu.stanford.nlp.util.HasInterval;
import edu.stanford.nlp.util.Interval;
import edu.stanford.nlp.util.StringUtils;

import java.util.List;

/**
* Represent a matched span over sequence of elements
*
* @author Angel Chang
*/
public class Match implements HasInterval
{
  /* List of elements that were actually matched */
  List matched;
  /* Value corresponding to the matched span */
  V value;
  /* Start offset of the span */
  int begin;
  /* End offset of the span */
  int end;
  Object customMatchObject;  // Custom match object
  transient Interval span;

  public Match() {}

  public Match(List matched, V value, int begin, int end) {
    this.matched = matched;
    this.value = value;
    this.begin = begin;
    this.end = end;
  }

  public List getMatched() {
    return matched;
  }

  public int getMatchedLength() {
    return (matched != null)? matched.size():0;
  }

  public V getValue() {
    return value;
  }

  public int getBegin() {
    return begin;
  }

  public int getEnd() {
    return end;
  }

  public Object getCustom() {
    return customMatchObject;
  }

  public void setCustom(Object customMatchObject) {
    this.customMatchObject = customMatchObject;
  }

  @Override
  public boolean equals(Object o) {
    if (this == o) return true;
    if (o == null || getClass() != o.getClass()) return false;

    Match match = (Match) o;

    if (begin != match.begin) return false;
    if (end != match.end) return false;
    if (matched != null ? !matched.equals(match.matched) : match.matched != null) return false;
    if (value != null ? !value.equals(match.value) : match.value != null) return false;

    return true;
  }

  @Override
  public int hashCode() {
    int result = matched != null ? matched.hashCode() : 0;
    result = 31 * result + begin;
    result = 31 * result + end;
    return result;
  }

  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("[" + ((matched != null)? StringUtils.join(matched, " - "):"") + "]");
    sb.append(" -> ").append(value);
    sb.append(" at (").append(begin);
    sb.append(",").append(end).append(")");
    return sb.toString();
  }

  public Interval getInterval() {
    if (span == null) span = Interval.toInterval(begin, end, Interval.INTERVAL_OPEN_END);
    return span;
  }
}