Record Class ParserAnnotator.Phrase

java.lang.Object

java.lang.Record

opennlp.tools.parser.ParserAnnotator.Phrase

Record Components:

label - The phrase label. Must not be null or blank.

head - The span of the head token in the document text. Must not be null.

Enclosing class:

ParserAnnotator

public static record ParserAnnotator.Phrase(String label, opennlp.tools.util.Span head)
extends Record

One phrase of a constituency parse: its label, such as NP or VP, and the span of the token that heads it. The phrase's own span is the annotation's span.

Since:

3.0.0

Constructor Summary

Constructors

Constructor	Description
Phrase(String label, opennlp.tools.util.Span head)	Validates the phrase.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
opennlp.tools.util.Span	head()	Returns the value of the head record component.
String	label()	Returns the value of the label record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Phrase

public Phrase(String label,
 opennlp.tools.util.Span head)

Validates the phrase.

Throws:

IllegalArgumentException - Thrown if label is null or blank, or head is null.

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

label

public String label()

Returns the value of the label record component.

Returns:

the value of the label record component

head

public opennlp.tools.util.Span head()

Returns the value of the head record component.

Returns:

the value of the head record component