fr.cnes.genopus.time

Class GPDateInterval

java.lang.Object

fr.cnes.genius.interval.GIntervalAbstract

fr.cnes.genopus.time.GPDateInterval

public class GPDateInterval
extends fr.cnes.genius.interval.GIntervalAbstract

Class defining an interval of dates to test dates against. The interval is composed of two sub intervals: an OK interval and an optional warning interval. OK interval must be always included in the OK sub interval. The limits of these sub intervals can be, independently, open or closed.

Author:

aadt

Nested Class Summary

Nested classes/interfaces inherited from class fr.cnes.genius.interval.GIntervalAbstract

fr.cnes.genius.interval.GIntervalAbstract.GStatus, fr.cnes.genius.interval.GIntervalAbstract.Rule

Constructor Summary

Constructors

Constructor and Description
GPDateInterval() Empty constructor.
GPDateInterval(fr.cnes.sirius.patrius.time.AbsoluteDateInterval okInterval) Constructor of the dates interval only with OK zone.
GPDateInterval(fr.cnes.sirius.patrius.time.AbsoluteDateInterval okInterval, fr.cnes.sirius.patrius.time.AbsoluteDateInterval warnInterval) Constructor of the date interval with OK and WARN zones.

Method Summary

Modifier and Type	Method and Description
protected fr.cnes.genius.interval.GIntervalAbstract.Rule	getMaxRule()
protected Double	getMaxValue()
String	getMessage()
protected fr.cnes.genius.interval.GIntervalAbstract.Rule	getMinRule()
protected Double	getMinValue()
fr.cnes.sirius.patrius.time.AbsoluteDateInterval	getOKInterval() Getter for the OK zone interval.
fr.cnes.sirius.patrius.time.AbsoluteDateInterval	getWarnInterval() Getter for the warning zone interval.
boolean	overlaps(fr.cnes.genius.interval.GIntervalAbstract otherInterval)
fr.cnes.genius.interval.GIntervalAbstract.GStatus	testRange(Object object)
void	updateMessage(fr.cnes.genius.unit.GUnit currentUnit, fr.cnes.genius.interval.GIntervalFormatAbstract formatter)

Methods inherited from class java.lang.Object

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

Constructor Detail

GPDateInterval

public GPDateInterval()

Empty constructor.

GPDateInterval

public GPDateInterval(fr.cnes.sirius.patrius.time.AbsoluteDateInterval okInterval)

Constructor of the dates interval only with OK zone.

Parameters:

okInterval - OK zone interval.

GPDateInterval

public GPDateInterval(fr.cnes.sirius.patrius.time.AbsoluteDateInterval okInterval,
                      fr.cnes.sirius.patrius.time.AbsoluteDateInterval warnInterval)
               throws GPDateException

Constructor of the date interval with OK and WARN zones.

Parameters:

okInterval - OK zone interval.

warnInterval - warning zone interval.

Throws:

GPDateException - if OK interval is not included in warning interval

Method Detail

getOKInterval

public fr.cnes.sirius.patrius.time.AbsoluteDateInterval getOKInterval()

Getter for the OK zone interval.

Returns:

the OK interval of dates.

getWarnInterval

public fr.cnes.sirius.patrius.time.AbsoluteDateInterval getWarnInterval()

Getter for the warning zone interval.

Returns:

the warning interval of dates.

getMessage

public String getMessage()

Specified by:

getMessage in class fr.cnes.genius.interval.GIntervalAbstract

testRange

public fr.cnes.genius.interval.GIntervalAbstract.GStatus testRange(Object object)

Specified by:

testRange in class fr.cnes.genius.interval.GIntervalAbstract

overlaps

public boolean overlaps(fr.cnes.genius.interval.GIntervalAbstract otherInterval)

Specified by:

overlaps in class fr.cnes.genius.interval.GIntervalAbstract

getMinValue

protected Double getMinValue()

Specified by:

getMinValue in class fr.cnes.genius.interval.GIntervalAbstract

getMaxValue

protected Double getMaxValue()

Specified by:

getMaxValue in class fr.cnes.genius.interval.GIntervalAbstract

getMaxRule

protected fr.cnes.genius.interval.GIntervalAbstract.Rule getMaxRule()

Specified by:

getMaxRule in class fr.cnes.genius.interval.GIntervalAbstract

getMinRule

protected fr.cnes.genius.interval.GIntervalAbstract.Rule getMinRule()

Specified by:

getMinRule in class fr.cnes.genius.interval.GIntervalAbstract

updateMessage

public void updateMessage(fr.cnes.genius.unit.GUnit currentUnit,
                          fr.cnes.genius.interval.GIntervalFormatAbstract formatter)

Specified by:

updateMessage in class fr.cnes.genius.interval.GIntervalAbstract