edu.northwestern.at.wordhoard.model.search
Class SpeakerName

java.lang.Object
  edu.northwestern.at.wordhoard.model.search.SpeakerName

All Implemented Interfaces:

GroupingObject, SearchCriterion

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

A speaker name search criterion.

Constructor Summary

SpeakerName()
Creates a new speaker name object.

SpeakerName(java.lang.String name)
Creates a new speaker name object.

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 this object is equal to some other object.
Spelling	getGroupingSpelling(int numHits) Gets the spelling of the grouping object.
java.lang.Class	getJoinClass() Gets the join class.
java.lang.String	getName() Gets the name.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

SpeakerName

public SpeakerName()

Creates a new speaker name object.

SpeakerName

public SpeakerName(java.lang.String name)

Creates a new speaker name object.

Parameters:

name - Name.

Method Detail

getName

public java.lang.String getName()

Gets the name.

Returns:

The name.

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:

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

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.