edu.northwestern.at.wordhoard.model.bibtool
Class DateGroup

java.lang.Object
  edu.northwestern.at.wordhoard.model.bibtool.DateGroup

All Implemented Interfaces:

GroupingObject

public class DateGroup
extends java.lang.Object
implements GroupingObject

An author.

A DateGroup entry contains the following:

• A list of works (see Work) from the time frame. A DateGroup may not have any works listed.

The earliest and latest work dates may not match the dates for the earliest and latest works of an author in the database. This is because the database may not contain all of the author's works.

Constructor Summary

DateGroup(java.lang.String dateLabel, java.lang.Integer startYear, java.lang.Integer endYear)

Method Summary

static DateGroup	getDateGroup(int groupBy, java.lang.Integer startYear, java.lang.Integer endYear) Creates a new entry.
java.lang.Integer	getEndYear() Gets the end year.
Spelling	getGroupingSpelling(int numHits) Gets the spelling of the grouping object.
java.lang.String	getLabel() Gets the group's label.
java.lang.String	getReportPhrase() Gets the report phrase.
java.lang.Integer	getStartYear() Gets the start year.
java.lang.String	toString() Return name for display.
java.lang.String	toStringDetailed() Return author's full information for display.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface edu.northwestern.at.wordhoard.model.grouping.GroupingObject

equals, hashCode

Constructor Detail

DateGroup

public DateGroup(java.lang.String dateLabel,
                 java.lang.Integer startYear,
                 java.lang.Integer endYear)

Method Detail

getDateGroup

public static DateGroup getDateGroup(int groupBy,
                                     java.lang.Integer startYear,
                                     java.lang.Integer endYear)

Creates a new entry.

getLabel

public java.lang.String getLabel()

Gets the group's label.

Returns:

The dateLabel.

getStartYear

public java.lang.Integer getStartYear()

Gets the start year.

Returns:

The start year.

getEndYear

public java.lang.Integer getEndYear()

Gets the end year.

Returns:

The end year.

toString

public java.lang.String toString()

Return name for display.

Overrides:

toString in class java.lang.Object

Returns:

Author's name.

toStringDetailed

public java.lang.String toStringDetailed()

Return author's full information for display.

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.