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

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

All Implemented Interfaces:

GroupingObject, SearchCriterion

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

A publication count range wrapper.

Constructor Summary

DocFrequency()
Creates a new publication count range wrapper.

DocFrequency(java.lang.Integer docfreq, java.lang.String compare, Corpus corpus)
Creates a new publication count 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.String	getCompare() Gets the end count.
Corpus	getCorpus()
java.lang.Integer	getFreq() Gets the start count.
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 publication count range.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocFrequency

public DocFrequency()

Creates a new publication count range wrapper.

DocFrequency

public DocFrequency(java.lang.Integer docfreq,
                    java.lang.String compare,
                    Corpus corpus)

Creates a new publication count range wrapper.

Parameters:

docfreq - The frequency.

compare - The comparison type.

corpus - The corpus.

Method Detail

getFreq

public java.lang.Integer getFreq()

Gets the start count.

Returns:

The start count, or null if none.

getCompare

public java.lang.String getCompare()

Gets the end count.

Returns:

The end count, or null if none.

getCorpus

public Corpus getCorpus()

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