ch.agent.t2.applied

Class DayRankingSubPeriodPattern

java.lang.Object

ch.agent.t2.applied.DayRankingSubPeriodPattern

All Implemented Interfaces:

SubPeriodPattern

public class DayRankingSubPeriodPattern
extends Object
implements SubPeriodPattern

A DayRankingSubperiodPattern defines sub periods within a base period in terms of named days. For a simple example of use, see ThirdFriday. It is possible to define more complex patterns.

Author:

Jean-Paul Vetterli

See Also:

SimpleSubPeriodPattern

Constructor Summary

Constructors

Constructor and Description
DayRankingSubPeriodPattern(Resolution basePeriod, DayByNameAndRank[] ranks) Construct a sub period pattern for the given base period and ranks.

Method Summary

Modifier and Type	Method and Description
long	adjustForSubPeriod(long time, Adjustment adjust, TimeParts tp) Modify and return the numeric time index corresponding to the state of the time parts argument.
boolean	equals(Object obj)
TimeParts	fillInSubPeriod(int subPeriod, TimeParts tp) Update the relevant field of the time parts argument for the given sub period and return a modified copy.
Resolution	getBasePeriod() Return the base period resolution.
int	getSize() Return the number of sub periods.
Resolution	getSubPeriod() Return the sub period resolution.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DayRankingSubPeriodPattern

public DayRankingSubPeriodPattern(Resolution basePeriod,
                                  DayByNameAndRank[] ranks)

Construct a sub period pattern for the given base period and ranks. There are multiple restrictions on the dayPattern parameter. First it must specify ranks in increasing order. Then it is forbidden to have repetitions of actual days. To ensure this rule holds in all cases, negative ranks occupy two positive ranks, because a day can occur 4 or 5 times in a month and 52 or 53 times in a year. For example, in a month, Fri 2 and Fri -4 correspond to the same day when there are 5 Fridays in the month and Fri 2 and -3 correspond to the same day when there are 4 Fridays. So both are forbidden. On the other hand, Fri 2 and -2 is okay. A further restriction is that a given rank can be used only once. For example it is forbidden to specify Mon 1 and Fri 1. This is done to limit complexity, because in some cases Mon 1 precedes Fri 1 while in other cases it comes after. As a final restriction, all ranks must be relative to the same unit. It is not possible to mix days of month with days of year.

If any restriction is violated an IllegalArgumentException is thrown.

Parameters:

basePeriod - a non-null resolution, yearly or monthly

ranks - an array of day definitions

Throws:

T2Exception

Method Detail

getSize

public int getSize()

Description copied from interface: SubPeriodPattern

Return the number of sub periods.

Specified by:

getSize in interface SubPeriodPattern

Returns:

a positive number

getSubPeriod

public Resolution getSubPeriod()

Description copied from interface: SubPeriodPattern

Return the sub period resolution.

Specified by:

getSubPeriod in interface SubPeriodPattern

Returns:

a resolution

getBasePeriod

public Resolution getBasePeriod()

Description copied from interface: SubPeriodPattern

Return the base period resolution.

Specified by:

getBasePeriod in interface SubPeriodPattern

Returns:

a resolution

adjustForSubPeriod

public long adjustForSubPeriod(long time,
                               Adjustment adjust,
                               TimeParts tp)
                        throws T2Exception

Description copied from interface: SubPeriodPattern

Modify and return the numeric time index corresponding to the state of the time parts argument. The numeric time index passed as an argument reflects those fields of the time parts argument relevant to the base unit and incorporates the effect from the base period pattern. Remaining fields of the time parts argument are either used to determined the sub period or are ignored. This method is intended for used by TimePacker.pack(TimeParts, Adjustment).

Specified by:

adjustForSubPeriod in interface SubPeriodPattern

Parameters:

time - a numeric time index

adjust - an allowed adjustment mode

tp - a time parts object with the complete time specification

Returns:

the numeric time index adjusted for the sub period

Throws:

T2Exception

fillInSubPeriod

public TimeParts fillInSubPeriod(int subPeriod,
                                 TimeParts tp)

Description copied from interface: SubPeriodPattern

Update the relevant field of the time parts argument for the given sub period and return a modified copy. This method is intended for used by TimePacker.unpack(long).

Specified by:

fillInSubPeriod in interface SubPeriodPattern

Parameters:

subPeriod - a positive number

tp - a time parts object to be modified

Returns:

a new time parts object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object