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

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

All Implemented Interfaces:

GroupingObject, SearchCriterion

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

A mortality wrapper.

Field Summary

static byte	IMMORTAL_OR_SUPERNATURAL Immortal or supernatural.
static byte	MORTAL Mortal.
static byte	NUM_MORTALITY Number of mortality attributes.
static byte	UNKNOWN_OR_OTHER "Other" mortality.

Constructor Summary

Mortality()
Creates a new mortality wrapper.

Mortality(byte mortality)
Creates a new mortality 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.
Spelling	getGroupingSpelling(int numHits) Gets the spelling of the grouping object.
java.lang.Class	getJoinClass() Gets the join class.
byte	getMortality() Gets the mortality.
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 mortality.

Methods inherited from class java.lang.Object

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

Field Detail

MORTAL

public static final byte MORTAL

Mortal.

See Also:

Constant Field Values

IMMORTAL_OR_SUPERNATURAL

public static final byte IMMORTAL_OR_SUPERNATURAL

Immortal or supernatural.

See Also:

Constant Field Values

UNKNOWN_OR_OTHER

public static final byte UNKNOWN_OR_OTHER

"Other" mortality.

See Also:

Constant Field Values

NUM_MORTALITY

public static final byte NUM_MORTALITY

Number of mortality attributes.

See Also:

Constant Field Values

Constructor Detail

Mortality

public Mortality()

Creates a new mortality wrapper.

Mortality

public Mortality(byte mortality)

Creates a new mortality wrapper.

Parameters:

mortality - The mortality.

Method Detail

getMortality

public byte getMortality()

Gets the mortality.

Returns:

The mortality.

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 mortality.

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.