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

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

All Implemented Interfaces:

GroupingObject, SearchCriterion

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

A publication year range wrapper.

Constructor Summary

PubYearRange()
Creates a new publication year range wrapper.

PubYearRange(java.lang.Integer startYear, java.lang.Integer endYear)
Creates a new publication year range 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.
java.lang.Integer	getEndYear() Gets the end year.
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.Integer	getStartYear() Gets the start year.
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 publication year range.

Methods inherited from class java.lang.Object

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

Constructor Detail

PubYearRange

public PubYearRange()

Creates a new publication year range wrapper.

PubYearRange

public PubYearRange(java.lang.Integer startYear,
                    java.lang.Integer endYear)

Creates a new publication year range wrapper.

Parameters:

startYear - The start year, or null if none.

endYear - The end year, or null if none.

Method Detail

getStartYear

public java.lang.Integer getStartYear()

Gets the start year.

Returns:

The start year, or null if none.

getEndYear

public java.lang.Integer getEndYear()

Gets the end year.

Returns:

The end year, or null if none.

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 publication year range.

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.