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

java.lang.Object
  edu.northwestern.at.wordhoard.model.grouping.NoneOfTheAbove

All Implemented Interfaces:

GroupingObject

public class NoneOfTheAbove
extends java.lang.Object
implements GroupingObject

A "none of the above" grouping object.

Method Summary

boolean	equals(java.lang.Object obj) Returns true if this object is equal to some other object.
static NoneOfTheAbove	get(java.lang.Class groupBy) Gets a none of the above grouping object.
static NoneOfTheAbove	get(java.lang.Class groupBy, java.lang.String str) Gets a none of the above grouping 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

Method Detail

get

public static NoneOfTheAbove get(java.lang.Class groupBy,
                                 java.lang.String str)

Gets a none of the above grouping object.

Parameters:

groupBy - Group by class.

str - Grouping spelling string.

Returns:

None of the above grouping object.

get

public static NoneOfTheAbove get(java.lang.Class groupBy)

Gets a none of the above grouping object.

The grouping spelling is "".

Parameters:

groupBy - Group by class.

Returns:

None of the above grouping object.

getReportPhrase

public java.lang.String getReportPhrase()

Gets the report phrase.

Specified by:

getReportPhrase in interface GroupingObject

Returns:

The report phrase.

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.