ch.agent.t2.timeutil

Class RangeHolder

java.lang.Object

ch.agent.t2.timeutil.RangeHolder

public class RangeHolder
extends Object

A RangeHolder helps applications manipulate time ranges.

If necessary, dates are adjusted. Adjustment is upwards for the start of the range and downwards for the end.

Author:

Jean-Paul Vetterli

Constructor Summary

Constructors

Constructor and Description
RangeHolder() Construct a range holder in the daily time domain and initialized with the current time.
RangeHolder(Range range) Construct a range holder for the given range.
RangeHolder(RangeHolder model) Construct a range holder as a copy of the given model.
RangeHolder(TimeDomain domain) Construct a range holder with the given time domain and initialized with the current time.

Method Summary

Modifier and Type	Method and Description
String	getBeginText() Return the text of the day expression set with setBegin.
String	getEndText() Return the text of the day expression set with setEnd.
Range	getRange() Get the range evaluated in the time domain of the range holder.
Range	getRange(Range context) Get the range evaluated in the context of the given range.
Range	getRange(TimeDomain context) Get the range evaluated in the context of the given domain.
TimeDomain	getTimeDomain() Return the time domain.
void	incrBegin(boolean up, boolean large) Increase or decrease the beginning of the range by a unit or by a large amount.
void	incrBegin(int increment) Increment the beginning of the range by the given amount.
void	incrEnd(boolean up, boolean large) Increase or decrease the end of the range by a unit or by a large amount.
void	incrEnd(int increment) Increment the end of the range by the given amount.
boolean	needContext() Return true if the range holder needs a context for evaluating dates.
void	reset(Range range) Change the range to the given range.
void	reset(TimeDomain domain) Change the time domain of the range holder.
void	setBegin(String date) Set the date for the range beginning.
void	setEnd(String date) Set the date for the range end.

Methods inherited from class java.lang.Object

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

Constructor Detail

RangeHolder

public RangeHolder(TimeDomain domain)

Construct a range holder with the given time domain and initialized with the current time.

Parameters:

domain - a non-null time domain

RangeHolder

public RangeHolder()

Construct a range holder in the daily time domain and initialized with the current time.

RangeHolder

public RangeHolder(Range range)

Construct a range holder for the given range.

Parameters:

range - a non-null range

RangeHolder

public RangeHolder(RangeHolder model)

Construct a range holder as a copy of the given model.

Parameters:

model - a non-null range holder

Method Detail

getTimeDomain

public TimeDomain getTimeDomain()

Return the time domain.

Returns:

the time domain of the range

reset

public void reset(Range range)

Change the range to the given range.

Parameters:

range - a non-null range

reset

public void reset(TimeDomain domain)
           throws T2Exception

Change the time domain of the range holder. The day expressions of the current bounds are retained.

Parameters:

domain - a non-null domain

Throws:

T2Exception

setBegin

public void setBegin(String date)
              throws T2Exception

Set the date for the range beginning. A null or empty date is allowed. This is useful for signaling that no date is specified. The method has a side-effect on the other extremity of the range. Refer to DayExpression for the valid syntax of dates.

Parameters:

date - a day expression

Throws:

T2Exception

setEnd

public void setEnd(String date)
            throws T2Exception

Set the date for the range end. A null or empty date is allowed. This is useful for signaling that no date is specified. The method has a side-effect on the other extremity of the range. Refer to DayExpression for the valid syntax of dates.

Parameters:

date - a day expression

Throws:

T2Exception

incrBegin

public void incrBegin(int increment)
               throws T2Exception

Increment the beginning of the range by the given amount. If no date is currently set, the method has the same effect as setting the beginning to the current time. The method has a side-effect on the other extremity of the range.

Parameters:

increment - a positive or negative number

Throws:

T2Exception

incrBegin

public void incrBegin(boolean up,
                      boolean large)
               throws T2Exception

Increase or decrease the beginning of the range by a unit or by a large amount. What constitutes a large amount depends on the resolution of the time domain. The method has a side-effect on the other extremity of the range.

Parameters:

up - if true increase, else decrease

large - if true use a large amount, else a single unit

Throws:

T2Exception

incrEnd

public void incrEnd(int increment)
             throws T2Exception

Increment the end of the range by the given amount. If no date is currently set, the method has the same effect as setting the beginning to the current time. The method has a side-effect on the other extremity of the range.

Parameters:

increment - a positive or negative number

Throws:

T2Exception

incrEnd

public void incrEnd(boolean up,
                    boolean large)
             throws T2Exception

Increase or decrease the end of the range by a unit or by a large amount. What constitutes a large amount depends on the resolution of the time domain. The method has a side-effect on the other extremity of the range.

Parameters:

up - if true increase, else decrease

large - if true use a large amount, else a single unit

Throws:

T2Exception

getBeginText

public String getBeginText()

Return the text of the day expression set with setBegin. If a date was never set, an empty string is returned. To get the resolved date, use one of the getRange methods. The method never returns null.

Returns:

the text of the current day expression for the beginning of the range or an empty string

getEndText

public String getEndText()

Return the text of the day expression set with setEnd. If a date was never set, an empty string is returned. To get the resolved date, use one of the getRange methods. The method never returns null.

Returns:

the text of the current day expression for the end of the range or an empty string

getRange

public Range getRange()
               throws T2Exception

Get the range evaluated in the time domain of the range holder.

Returns:

a range

Throws:

T2Exception

getRange

public Range getRange(TimeDomain context)
               throws T2Exception

Get the range evaluated in the context of the given domain.

Parameters:

context - a non-null time domain

Returns:

a range

Throws:

T2Exception

getRange

public Range getRange(Range context)
               throws T2Exception

Get the range evaluated in the context of the given range. If the holder does not contain any info, an empty range is returned. If the domain needs conversion, steps are taken to avoid invalid ranges. For example, when because of adjustments the daily range [1980-11-22, 1980-11-22] would be turned into the Monday to Friday range [1980-11-24, 1980-11-21], the method fixes it to [1980-11-21, 1980-11-21].

Parameters:

context - non-null range

Returns:

a range

Throws:

T2Exception

needContext

public boolean needContext()

Return true if the range holder needs a context for evaluating dates.

Returns:

true if a context is needed