edu.northwestern.at.wordhoard.model.grouping
Class PrecedingWordForm

java.lang.Object
  extended by edu.northwestern.at.wordhoard.model.grouping.PrecedingWordForm
All Implemented Interfaces:
GroupingObject

public class PrecedingWordForm
extends java.lang.Object
implements GroupingObject

A preceding word form grouping object.


Constructor Summary
PrecedingWordForm(LemPos lemPos)
          Creates a new preceding word form object.
 
Method Summary
 boolean equals(java.lang.Object obj)
          Returns true if this object is equal to some other object.
 Spelling getGroupingSpelling(int numHits)
          Gets the spelling of the grouping object.
 java.lang.String getReportPhrase()
          Gets the report phrase.
 int hashCode()
          Returns a hash code for the object.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PrecedingWordForm

public PrecedingWordForm(LemPos lemPos)
Creates a new preceding word form object.

Parameters:
lemPos - The word form, or null if none.
Method Detail

getReportPhrase

public java.lang.String getReportPhrase()
Gets the report phrase.

Specified by:
getReportPhrase in interface GroupingObject
Returns:
"preceded by".

getGroupingSpelling

public Spelling getGroupingSpelling(int numHits)
Gets the spelling of the grouping object.

Specified by:
getGroupingSpelling in interface GroupingObject
Parameters:
numHits - Number of hits.
Returns:
The spelling of the grouping object.

equals

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

Specified by:
equals in interface GroupingObject
Overrides:
equals in class java.lang.Object
Parameters:
obj - The other object.
Returns:
True if this object equals the other object.

hashCode

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

Specified by:
hashCode in interface GroupingObject
Overrides:
hashCode in class java.lang.Object
Returns:
The hash code.