ch.agent.t2.applied

Class SimpleSubPeriodPattern

java.lang.Object

ch.agent.t2.applied.SimpleSubPeriodPattern

All Implemented Interfaces:

SubPeriodPattern

public class SimpleSubPeriodPattern
extends Object
implements SubPeriodPattern

A SimpleSubPeriodPattern defines one or more sub periods within a base period. All sub periods have the same resolution. They are defined by their number within the base period. Here is an example: "on the 10th day and on the 20th of each occurring month", and here is another one: "at 10:15, 14:20, and 22:40 every working day".

Author:

Jean-Paul Vetterli

Constructor Summary

Constructors

Constructor and Description
SimpleSubPeriodPattern(Resolution basePeriod, Resolution subPeriod, int[] ranks) Construct a sub period pattern with the given base period and sub period resolutions, and with the given 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

SimpleSubPeriodPattern

public SimpleSubPeriodPattern(Resolution basePeriod,
                              Resolution subPeriod,
                              int[] ranks)

Construct a sub period pattern with the given base period and sub period resolutions, and with the given ranks.

Parameters:

basePeriod - a non-null resolution

subPeriod - a non-null resolution

ranks - a non-null non-empty array of integers

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