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

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

All Implemented Interfaces:

GroupingObject, SearchCriterion

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

A prosodic attribute wrapper.

Field Summary

static byte	NUM_PROSODIC Number of prosodic attributes.
static byte	PROSE Prose.
static byte	UNKNOWN Prosodic attribute unknown.
static byte	VERSE Verse.

Constructor Summary

Prosodic()
Creates a new prosodic attribute wrapper.

Prosodic(byte prosodic)
Creates a new prosodic attribute 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	getProsodic() Gets the prosodic attribute.
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 prosodic attribute.

Methods inherited from class java.lang.Object

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

Field Detail

PROSE

public static final byte PROSE

Prose.

See Also:

Constant Field Values

VERSE

public static final byte VERSE

Verse.

See Also:

Constant Field Values

UNKNOWN

public static final byte UNKNOWN

Prosodic attribute unknown.

See Also:

Constant Field Values

NUM_PROSODIC

public static final byte NUM_PROSODIC

Number of prosodic attributes.

See Also:

Constant Field Values

Constructor Detail

Prosodic

public Prosodic()

Creates a new prosodic attribute wrapper.

Prosodic

public Prosodic(byte prosodic)

Creates a new prosodic attribute wrapper.

Parameters:

prosodic - The prosodic attribute.

Method Detail

getProsodic

public byte getProsodic()

Gets the prosodic attribute.

Returns:

The prosodic attribute.

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 "in".

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 prosodic attribute.

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.