edu.northwestern.at.monk.model
Class HeadWord

java.lang.Object
  extended by edu.northwestern.at.monk.model.ComboFeature
      extended by edu.northwestern.at.monk.model.HeadWord
All Implemented Interfaces:
Feature, java.lang.Comparable<HeadWord>

public class HeadWord
extends ComboFeature
implements Feature, java.lang.Comparable<HeadWord>

A headword combination feature.

See Also:
MONK Datastore Overview, Licensing Agreement

Constructor Summary
HeadWord(Lemma lemma)
          Creates a new headword.
 
Method Summary
 int compareTo(HeadWord other)
          Compares this instance with another.
 boolean equals(java.lang.Object obj)
          Returns true if this object equals some other object.
 java.lang.String getHeadWord()
          Gets the headword.
 int hashCode()
          Returns a hash code for this object.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HeadWord

public HeadWord(Lemma lemma)
Creates a new headword.

Parameters:
lemma - Lemma.
Method Detail

getHeadWord

public java.lang.String getHeadWord()
Gets the headword.

Returns:
Headword.

equals

public boolean equals(java.lang.Object obj)
Returns true if this object equals some other object.

Overrides:
equals in class java.lang.Object
Parameters:
obj - Other object.
Returns:
True if this object equals the other object.

hashCode

public int hashCode()
Returns a hash code for this object.

Overrides:
hashCode in class java.lang.Object
Returns:
Hash code.

compareTo

public int compareTo(HeadWord other)
Compares this instance with another.

Headwords are ordered in case and diacritical-insensitive increasing alphabetical order.

Specified by:
compareTo in interface java.lang.Comparable<HeadWord>
Parameters:
other - The other instance to be compared.
Returns:
A negative integer, zero, or a positive integer as this instance is less than, equal to, or greater than the specified instance.