ch.agent.t2.time

Class TimeDomainDefinition

java.lang.Object

ch.agent.t2.time.TimeDomainDefinition

public class TimeDomainDefinition
extends Object

TimeDomainDefinition is a helper class encapsulating properties of a time domain. Time domain definitions are immutable.

Author:

Jean-Paul Vetterli

Constructor Summary

Constructors

Constructor and Description
TimeDomainDefinition(String label, Resolution baseUnit, long origin) Construct a definition with the given label and properties.
TimeDomainDefinition(String label, Resolution baseUnit, long origin, BasePeriodPattern basePattern) Construct a definition with the given label and properties.
TimeDomainDefinition(String label, Resolution baseUnit, long origin, BasePeriodPattern basePattern, SubPeriodPattern subPattern) Construct a definition with the given label and properties.

Method Summary

Modifier and Type	Method and Description
TimeDomain	asTimeDomain() Construct the time domain corresponding to this definition.
BasePeriodPattern	getBasePeriodPattern() Return the base period pattern.
Resolution	getBaseUnit() Return the resolution.
protected TimeDomain	getCached() For subclasses.
String	getLabel() Return the label.
long	getOrigin() Return the origin.
SubPeriodPattern	getSubPeriodPattern() Return the sub period pattern.
protected void	setCached(TimeDomain cached) For subclasses.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeDomainDefinition

public TimeDomainDefinition(String label,
                            Resolution baseUnit,
                            long origin,
                            BasePeriodPattern basePattern,
                            SubPeriodPattern subPattern)

Construct a definition with the given label and properties. If the label is null, one will be generated.

Parameters:

label - a string or null

baseUnit - a resolution

origin - a number

basePattern - base period pattern

subPattern - a sub period pattern

TimeDomainDefinition

public TimeDomainDefinition(String label,
                            Resolution baseUnit,
                            long origin,
                            BasePeriodPattern basePattern)

Construct a definition with the given label and properties.

Parameters:

label - a string or null

baseUnit - a resolution

origin - a number

basePattern - base period pattern

TimeDomainDefinition

public TimeDomainDefinition(String label,
                            Resolution baseUnit,
                            long origin)

Construct a definition with the given label and properties.

Parameters:

label - a string or null

baseUnit - a resolution

origin - a number

Method Detail

getCached

protected TimeDomain getCached()

For subclasses.

Returns:

a time domain or null

setCached

protected void setCached(TimeDomain cached)

For subclasses.

Parameters:

cached - a time domain

asTimeDomain

public TimeDomain asTimeDomain()

Construct the time domain corresponding to this definition. This method creates a time domain with a default TimeFormatter and a default TimeScanner. Any problem with the definition will be detected the first time this method is executed.

Returns:

a time domain

getLabel

public String getLabel()

Return the label.

Returns:

the label

getOrigin

public long getOrigin()

Return the origin.

Returns:

the origin

getBaseUnit

public Resolution getBaseUnit()

Return the resolution.

Returns:

the resolution

getBasePeriodPattern

public BasePeriodPattern getBasePeriodPattern()

Return the base period pattern.

Returns:

the sub period pattern

getSubPeriodPattern

public SubPeriodPattern getSubPeriodPattern()

Return the sub period pattern.

Returns:

the sub period pattern

toString

public String toString()

Overrides:

toString in class Object