ch.agent.t2.time

Class Range

java.lang.Object

ch.agent.t2.time.Range

All Implemented Interfaces:

Iterable<TimeIndex>

public class Range
extends Object
implements Iterable<TimeIndex>

A Range is an immutable time interval in a TimeDomain. A range can be empty. When not empty, both ends of the interval are well-defined. Open intervals and semi-open intervals are not supported.

A Range is an immutable object.

Author:

Jean-Paul Vetterli

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Range.RangeIterator RangeIterator is a Iterator return TimeIndex objects.

Constructor Summary

Constructors

Constructor and Description
Range(Range range) Construct a range as a copy of the argument.
Range(TimeDomain domain) Construct an empty range.
Range(TimeDomain domain, long first, long last) Construct a range with bounds specified with numerical time indexes,.
Range(TimeDomain domain, String firstDate, String lastDate, Adjustment adjust) Construct a range with bounds specified as date strings.
Range(TimeIndex first, TimeIndex last) Construct a range with bounds specified as times.

Method Summary

Modifier and Type	Method and Description
Range	convert(TimeDomain domain, Adjustment adjust) Convert the range to the domain specified.
boolean	equals(Object obj)
TimeIndex	getFirst() Return the lower bound as a time or null when the range is empty.
long	getFirstIndex() Return the lower bound as a numerical time index.
TimeIndex	getLast() r Return the upper bound as a time o null when the range is empty.
long	getLastIndex() Return the upper bound as a numerical time index.
long	getSize() Return the range size.
int	getSizeAsInt() Get the size of the range as an integer and check for overflow.
TimeDomain	getTimeDomain() Return the time domain.
int	hashCode()
Range	intersection(Range range) Return a new range which is the intersection with the argument.
boolean	isEmpty() Return true if the range is empty, else false.
boolean	isInRange(long index) Return true if the numerical time index is within range.
boolean	isInRange(Range range) Return true if another range is within range.
boolean	isInRange(TimeIndex time) Return true if the time is within range.
Iterator<TimeIndex>	iterator()
String	toString()
Range	union(Range range) Return a new range which is the union with the argument.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Range

public Range(TimeDomain domain)

Construct an empty range.

Parameters:

domain - a non null domain

Range

public Range(Range range)

Construct a range as a copy of the argument.

Parameters:

range - a non-null range

Range

public Range(TimeDomain domain,
             long first,
             long last)

Construct a range with bounds specified with numerical time indexes,. Specifying a first bound past the second results in an empty range.

Parameters:

domain - a non-null domain

first - the lower bound

last - the upper bound

Throws:

T2Exception

Range

public Range(TimeIndex first,
             TimeIndex last)
      throws T2Exception

Construct a range with bounds specified as times. Specifying a first bound past the second results in an empty range.

Parameters:

first - a non-null lower bound

last - a non-null upper bound

Throws:

T2Exception

Range

public Range(TimeDomain domain,
             String firstDate,
             String lastDate,
             Adjustment adjust)
      throws T2Exception

Construct a range with bounds specified as date strings. Bounds are adjusted if necessary and if allowed by the adjust parameter. The range will be smaller (larger) ifO adjustment DOWN (UP) is specified. An exception is thrown if adjusting is required but adjustment NONE is specified.

Specifying a first bound past the second results in an empty range.

Parameters:

domain - a non-null domain

firstDate - a non-null lower bound

lastDate - a non-null upper bound

adjust - a non-null adjustment mode

Throws:

T2Exception

Method Detail

convert

public Range convert(TimeDomain domain,
                     Adjustment adjust)
              throws T2Exception

Convert the range to the domain specified. The range will be made smaller (larger) if adjustment DOWN (UP) is specified. An exception is thrown if adjusting is required but adjustment NONE is specified.

If the domain is the same, returns this range, else a new range is created.

Parameters:

domain - a non-null domain

adjust - a non-null adjustment mode

Returns:

a range

Throws:

T2Exception

iterator

public Iterator<TimeIndex> iterator()

Specified by:

iterator in interface Iterable<TimeIndex>

getFirstIndex

public long getFirstIndex()

Return the lower bound as a numerical time index.

Returns:

the lower bound

getLastIndex

public long getLastIndex()

Return the upper bound as a numerical time index.

Returns:

the upper bound

getSizeAsInt

public int getSizeAsInt()
                 throws T2Exception

Get the size of the range as an integer and check for overflow.

Returns:

the range size as an integer

Throws:

T2Exception

getSize

public long getSize()

Return the range size.

Returns:

the size

getTimeDomain

public TimeDomain getTimeDomain()

Return the time domain.

Returns:

the time domain

isEmpty

public boolean isEmpty()

Return true if the range is empty, else false.

Returns:

true if the range is empty

isInRange

public boolean isInRange(long index)

Return true if the numerical time index is within range.

Parameters:

index - a numerical time index

Returns:

true if the time is in the range

isInRange

public boolean isInRange(TimeIndex time)
                  throws T2Exception

Return true if the time is within range. The domains must be equal.

Parameters:

time - a non-null time

Returns:

true if the time is in the range

Throws:

T2Exception

isInRange

public boolean isInRange(Range range)
                  throws T2Exception

Return true if another range is within range. This is the case if both ends of the other range are within this range. The domains must be equal. A range equal to this range is considered to be inside and as a corollary an empty range is inside another empty range.

Parameters:

range - a non-null range

Returns:

true if the other range is in the range

Throws:

T2Exception

getFirst

public TimeIndex getFirst()

Return the lower bound as a time or null when the range is empty.

Returns:

the lower bound or null

getLast

public TimeIndex getLast()

r Return the upper bound as a time o null when the range is empty.

Returns:

the upper bound or null

union

public Range union(Range range)
            throws T2Exception

Return a new range which is the union with the argument.

Parameters:

range - a non-null range

Returns:

the union of both ranges

Throws:

T2Exception

intersection

public Range intersection(Range range)
                   throws T2Exception

Return a new range which is the intersection with the argument. The result can be an empty range.

Parameters:

range - a non-null range

Returns:

the intersection of both ranges

Throws:

T2Exception

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object