ch.agent.t2.applied

Class DayByNameAndRank

java.lang.Object

ch.agent.t2.applied.DayByNameAndRank

public class DayByNameAndRank
extends Object

DayByNameAndRank defines a day by its name and its rank within a month or a year. This allows to define for example the 3d Friday of the month, or the last Monday of the year. Other base periods units are not meaningful, and are not allowed. The rank is a non-zero number between -5 and +5 for months and -53 and +53 for years. With a negative rank, days are counted from the end, with -1 for the last day.

Author:

Jean-Paul Vetterli

Constructor Summary

Constructors

Constructor and Description
DayByNameAndRank(DayOfWeek day, int rank) Construct day definition for the given day of week and rank.

Method Summary

Modifier and Type	Method and Description
protected void	checkRank(int rank, Resolution unit) Verify the validity of the rank for the given resolution.
boolean	equals(Object obj)
DayOfWeek	getDayOfWeek() Return the day of week.
protected int	getMaxRank(Resolution unit) Return the maximum rank even if it is not always achievable.
int	getRank() Return the rank.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DayByNameAndRank

public DayByNameAndRank(DayOfWeek day,
                        int rank)

Construct day definition for the given day of week and rank.

Parameters:

day - non-null day of week

rank - a non-zero number in [-5, 5] or [-53, 53] depending on the context

Method Detail

getMaxRank

protected int getMaxRank(Resolution unit)
                  throws T2Exception

Return the maximum rank even if it is not always achievable. For example, the maximum rank for a day in a month is 5, but in many months it is only 4.

Parameters:

unit - the resolution

Returns:

the maximum rank for the given resolution

Throws:

T2Exception

checkRank

protected void checkRank(int rank,
                         Resolution unit)
                  throws T2Exception

Verify the validity of the rank for the given resolution.

Parameters:

rank - a number

unit - a non-null resolution

Throws:

T2Exception

getDayOfWeek

public DayOfWeek getDayOfWeek()

Return the day of week.

Returns:

the day of week

getRank

public int getRank()

Return the rank.

Returns:

the rank

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object