org.protempa.proposition.interval

Class IntervalFactory

java.lang.Object

org.protempa.proposition.interval.IntervalFactory

public final class IntervalFactory
extends Object

A factory for creating Interval objects. A subclass of Interval will be returned that is optimized for the arguments that are provided to this factory's getInstance methods.

Author:

Andrew Post

Constructor Summary

Constructors

Constructor and Description
IntervalFactory()

Method Summary

Modifier and Type	Method and Description
Interval	getInstance() Returns an unbounded interval.
Interval	getInstance(Long position, Granularity gran) Returns an interval representing a position on the timeline or other axis at a specified granularity.
Interval	getInstance(Long start, Granularity startGran, Long finish, Granularity finishGran) Returns at interval specified by the given start and finish and granularities.
Interval	getInstance(Long minStart, Long maxStart, Granularity startGran, Long minFinish, Long maxFinish, Granularity finishGran) Returns an interval specified by the given minimum start, maximum start, minimum finish and maximum finish and corresponding granularities.

Methods inherited from class java.lang.Object

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

Constructor Detail

IntervalFactory

public IntervalFactory()

Method Detail

getInstance

public Interval getInstance(Long minStart,
                            Long maxStart,
                            Granularity startGran,
                            Long minFinish,
                            Long maxFinish,
                            Granularity finishGran)

Returns an interval specified by the given minimum start, maximum start, minimum finish and maximum finish and corresponding granularities. The interpretation of the starts and finishes depends on the Granularity implementations specifiied by the startGran and finishGran arguments. For example, if startGran is an instance of AbsoluteTimeGranularity, minStart and maxStart are interpreted as date/times.

Parameters:

minStart - the earliest start of the interval, represented as a Long. If null, the earliest start will be unbounded.

maxStart - the latest start of the interval, represented as a Long. if null, the latest start will be unbounded.

startGran - the Granularity of the minStart and maxStart.

minFinish - the earliest finish of the interval, represented as a Long. If null, the earliest finish will be unbounded.

maxFinish - the latest finish of the interval, represented as a Long. If null, the latest finish will be unbounded.

finishGran - the Granularity of the minFinish and maxFinish.

Returns:

an Interval.

getInstance

public Interval getInstance(Long start,
                            Granularity startGran,
                            Long finish,
                            Granularity finishGran)

Returns at interval specified by the given start and finish and granularities.

Parameters:

start - a Long representing the start of the interval. If null, the start will be unbounded.

startGran - the Granularity of the start of the interval. The start parameter's interpretation depends on the Granularity implementation provided.

finish - a Long representing the finish of the interval. If null, the finish will be unbounded.

finishGran - the Granularity of the finish of the interval. The start parameter's interpretation depends on the Granularity implementation provided.

Returns:

an Interval.

getInstance

public Interval getInstance(Long position,
                            Granularity gran)

Returns an interval representing a position on the timeline or other axis at a specified granularity. The interpretation of the position parameter depends on what implementation of Granularity is provided. For example, if the granularity implementation is AbsoluteTimeGranularity, the position is intepreted as a timestamp.

Parameters:

position - a {

gran - a Granularity.

Returns:

an Interval.

getInstance

public Interval getInstance()

Returns an unbounded interval.

Returns:

an Interval.