edu.northwestern.at.wordhoard.model.wrappers
Class Gender

java.lang.Object
  edu.northwestern.at.wordhoard.model.wrappers.Gender

All Implemented Interfaces:

GroupingObject, SearchCriterion

public class Gender
extends java.lang.Object
implements SearchCriterion, GroupingObject

A gender wrapper.

Field Summary

static byte	FEMALE Female gender.
static byte	MALE Male gender.
static byte	NUM_GENDERS Number of genders.
static byte	UNCERTAIN_MIXED_OR_UNKNOWN Uncertain, mixed, or unknown gender.

Constructor Summary

Gender()
Creates a new gender wrapper.

Gender(byte gender)
Creates a new gender wrapper.

Method Summary

void	appendDescription(TextLine line, FontInfo romanFontInfo, FontInfo[] fontInfo) Appends a description to a text line.
boolean	equals(java.lang.Object obj) Returns true if some other object is equal to this one.
byte	getGender() Gets the gender.
Spelling	getGroupingSpelling(int numHits) Gets the spelling of the grouping object.
java.lang.Class	getJoinClass() Gets the join class.
java.lang.String	getReportPhrase() Gets the report phrase.
java.lang.String	getWhereClause() Gets the Hibernate where clause.
int	hashCode() Returns a hash code for the object.
void	setArg(org.hibernate.Query q, org.hibernate.Session session) Sets the Hibernate query argument.
java.lang.String	toString() Returns a string representation of the gender.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

MALE

public static final byte MALE

Male gender.

See Also:

Constant Field Values

FEMALE

public static final byte FEMALE

Female gender.

See Also:

Constant Field Values

UNCERTAIN_MIXED_OR_UNKNOWN

public static final byte UNCERTAIN_MIXED_OR_UNKNOWN

Uncertain, mixed, or unknown gender.

See Also:

Constant Field Values

NUM_GENDERS

public static final byte NUM_GENDERS

Number of genders.

See Also:

Constant Field Values

Constructor Detail

Gender

public Gender()

Creates a new gender wrapper.

Gender

public Gender(byte gender)

Creates a new gender wrapper.

Parameters:

gender - The gender.

Method Detail

getGender

public byte getGender()

Gets the gender.

Returns:

The gender.

getJoinClass

public java.lang.Class getJoinClass()

Gets the join class.

Specified by:

getJoinClass in interface SearchCriterion

Returns:

The join class, or null if none.

getWhereClause

public java.lang.String getWhereClause()

Gets the Hibernate where clause.

Specified by:

getWhereClause in interface SearchCriterion

Returns:

The Hibernate where clause.

setArg

public void setArg(org.hibernate.Query q,
                   org.hibernate.Session session)

Sets the Hibernate query argument.

Specified by:

setArg in interface SearchCriterion

Parameters:

q - Hibernate query.

session - Hibernate session.

appendDescription

public void appendDescription(TextLine line,
                              FontInfo romanFontInfo,
                              FontInfo[] fontInfo)

Appends a description to a text line.

Specified by:

appendDescription in interface SearchCriterion

Parameters:

line - Text line.

romanFontInfo - Roman font info.

fontInfo - Array of font info indexed by character set.

getReportPhrase

public java.lang.String getReportPhrase()

Gets the report phrase.

Specified by:

getReportPhrase in interface GroupingObject

Returns:

The report phrase "spoken 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.

toString

public java.lang.String toString()

Returns a string representation of the gender.

Overrides:

toString in class java.lang.Object

Returns:

String representation.

equals

public boolean equals(java.lang.Object obj)

Returns true if some other object is equal to this one.

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.