ch.agent.t2.time

Interface TimePacker

All Known Implementing Classes:

TimeFactory

public interface TimePacker

TimePacker defines the backend interface for the machinery implementing TimeDomain and TimeIndex.

Author:

Jean-Paul Vetterli

Method Summary

Modifier and Type	Method and Description
BasePeriodPattern	getBasePeriodPattern() Return the base period pattern.
int	getBasePeriodSize() Return the number of time points within a base period.
TimeIndex	getBasePeriodStart(TimeIndex t) Return the time index of the first time point in the base period containing the time specified.
DayOfWeek	getDayOfWeek(TimeIndex time) Return the day of week for the given time.
SubPeriodPattern	getSubPeriodPattern() Return the sub period pattern.
long	pack(TimeParts timeParts, Adjustment adjust) Pack the component elements of the time into a numeric time index.
TimeParts	unpack(long time) Unpack the numeric representation of time into its component elements.
boolean	valid(long time, boolean testOnly) Return true if the numeric time index is valid for the domain.

Method Detail

getBasePeriodPattern

BasePeriodPattern getBasePeriodPattern()

Return the base period pattern. This pattern is used to compress or decompress the raw numeric time index to or from a denser one. The result is null when no such pattern is defined.

Returns:

the base period pattern or null

getSubPeriodPattern

SubPeriodPattern getSubPeriodPattern()

Return the sub period pattern. This pattern is used to add sub periods to a base period. The result is null when no such pattern is defined.

Returns:

the sub period pattern or null

getBasePeriodSize

int getBasePeriodSize()

Return the number of time points within a base period. When there is sub period pattern, the result is its size, else it is 1.

Returns:

the number of time points within a base period

getBasePeriodStart

TimeIndex getBasePeriodStart(TimeIndex t)

Return the time index of the first time point in the base period containing the time specified. When there is no period pattern, this is the same as the time specified.

Parameters:

t - a non-null time index, which must be from this time domain

Returns:

a time index

valid

boolean valid(long time,
              boolean testOnly)
       throws T2Exception

Return true if the numeric time index is valid for the domain. Depending on the testOnly argument, the method throws an exception when the time is not valid.

Parameters:

time - numeric time to validate

testOnly - if true do not throw an exception when time is not valid

Returns:

true if valid

Throws:

T2Exception

unpack

TimeParts unpack(long time)

Unpack the numeric representation of time into its component elements.

Parameters:

time - a numeric time index

Returns:

a TimeParts

pack

long pack(TimeParts timeParts,
          Adjustment adjust)
   throws T2Exception

Pack the component elements of the time into a numeric time index. Depending on the domain, not all times exist. In such cases, the time is adjusted upwards or downwards if permitted. When a base period and a sub period pattern are both active, the adjustment applies only to the sub period.

Parameters:

timeParts - a time parts object

adjust - a non-null adjustment mode

Returns:

a numerical time index

Throws:

T2Exception

getDayOfWeek

DayOfWeek getDayOfWeek(TimeIndex time)
                throws T2Exception

Return the day of week for the given time.

Parameters:

time - a time index

Returns:

the day of the week

Throws:

T2Exception