fr.cnes.genius.interval

Class GIntervalDate

java.lang.Object

fr.cnes.genius.interval.GIntervalAbstract

fr.cnes.genius.interval.GIntervalDate

All Implemented Interfaces:

Cloneable

public class GIntervalDate
extends GIntervalAbstract
implements Cloneable

Class defining a validity interval. It is used to check a value against the ranges established for the classes which receive the input values from the user, as classes GEntryInt, GentryReal, GRealEntryVector, GIntEntryVector. The interval is composed of two ranges of values [okMinValue, okMaxValue] and [warnMinValue, warnMaxValue] and the test algorithm is the following:

 if (okMinValue <= value <= okMaxValue) then
   OK
 else if (warnMinValue <= value <= warnMaxValue) then
   WARN
 else
   ERROR
 end if
 

The interval limits can be, independently, inclusive or exclusive, so the comparisons are "<=" and "=>" or just "<" and ">".

Author:

jjct

Nested Class Summary

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

GIntervalAbstract.GStatus, GIntervalAbstract.Rule

Constructor Summary

Constructors

Constructor and Description
GIntervalDate(Date okMin, Date okMax) Constructor of the interval only with OK zone and inclusive rules in both edges.
GIntervalDate(Date okMin, Date okMax, GIntervalAbstract.Rule okMinRule, GIntervalAbstract.Rule okMaxRule) Constructor of the interval only with OK zone.
GIntervalDate(Date okMin, Date okMax, GIntervalAbstract.Rule okMinRule, GIntervalAbstract.Rule okMaxRule, Date warnMin, Date warnMax, GIntervalAbstract.Rule warnMinRule, GIntervalAbstract.Rule warnMaxRule) Constructor of the interval with OK and WARN zones.
GIntervalDate(String okMin, String okMax) Constructor of the interval only with OK zone and inclusive rules in both edges.
GIntervalDate(String okMin, String okMax, GIntervalAbstract.Rule okMinRule, GIntervalAbstract.Rule okMaxRule) Constructor of the interval only with OK zone.
GIntervalDate(String okMin, String okMax, GIntervalAbstract.Rule okMinRule, GIntervalAbstract.Rule okMaxRule, String warnMin, String warnMax, GIntervalAbstract.Rule warnMinRule, GIntervalAbstract.Rule warnMaxRule) Constructor of the interval with OK and WARN zones.

Method Summary

Modifier and Type	Method and Description
protected GIntervalDate	clone()
protected GIntervalAbstract.Rule	getMaxRule() Get the rule applying to the absolute maximum.
protected Date	getMaxValue() Get the absolute maximum value of the ok maximum and warning maximum.
String	getMessage() Get the message describing the interval checks.
protected GIntervalAbstract.Rule	getMinRule() Get the rule applying to the absolute minimum.
protected Date	getMinValue() Get the absolute minimum value of the ok minimum and warning minimum.
protected Date	getOkMax()
protected GIntervalAbstract.Rule	getOkMaxRule()
protected Date	getOkMin()
protected GIntervalAbstract.Rule	getOkMinRule()
protected Date	getWarnMax()
protected GIntervalAbstract.Rule	getWarnMaxRule()
protected Date	getWarnMin()
protected GIntervalAbstract.Rule	getWarnMinRule()
protected boolean	isWarnCheckEnabled()
boolean	overlaps(GIntervalAbstract otherInterval) Check the overlapping with another interval.
protected void	removeWarnCheck() Removes the WARN zone of the interval.
protected void	setOkMax(Date okMax) Set the absolute maximum value of the OK zone.
protected void	setOkMax(String okMax) Set the absolute maximum value of the OK zone.
protected void	setOkMaxRule(GIntervalAbstract.Rule okMaxRule) Set the rule applying to the absolute maximum of the OK zone.
protected void	setOkMin(Date okMin) Set the absolute minimum value of the OK zone.
protected void	setOkMin(String okMin) Set the absolute minimum value of the OK zone.
protected void	setOkMinRule(GIntervalAbstract.Rule okMinRule) Set the rule applying to the absolute minimum of the OK zone.
protected void	setWarnMax(Date warnMax) Set the absolute maximum value of the WARN zone.
protected void	setWarnMax(String warnMax) Set the absolute maximum value of the WARN zone.
protected void	setWarnMaxRule(GIntervalAbstract.Rule warnMaxRule) Set the rule applying to the absolute maximum of the WARN zone.
protected void	setWarnMin(Date warnMin) Set the absolute minimum value of the WARN zone.
protected void	setWarnMin(String warnMin) Set the absolute minimum value of the WARN zone.
protected void	setWarnMinRule(GIntervalAbstract.Rule warnMinRule) Set the rule applying to the absolute minimum of the WARN zone.
GIntervalAbstract.GStatus	testRange(Object object) Check the value against the interval.
void	updateMessage(GUnit currentUnit, GIntervalFormatAbstract formatter) Update the interval message using the unit, and format provided.

Methods inherited from class java.lang.Object

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

Constructor Detail

GIntervalDate

public GIntervalDate(Date okMin,
                     Date okMax,
                     GIntervalAbstract.Rule okMinRule,
                     GIntervalAbstract.Rule okMaxRule)

Constructor of the interval only with OK zone.

Parameters:

okMin - minimum value of the OK range.

okMax - maximum value of the OK range.

okMinRule - rule used for the comparison against the minimum value of the OK range.

okMaxRule - rule used for the comparison against the maximum value of the OK range.

GIntervalDate

public GIntervalDate(String okMin,
                     String okMax,
                     GIntervalAbstract.Rule okMinRule,
                     GIntervalAbstract.Rule okMaxRule)
              throws GDateFieldException

Constructor of the interval only with OK zone.

Parameters:

okMin - minimum value of the OK range.

okMax - maximum value of the OK range.

okMinRule - rule used for the comparison against the minimum value of the OK range.

okMaxRule - rule used for the comparison against the maximum value of the OK range.

Throws:

GDateFieldException - in case of error parsing the date strings.

GIntervalDate

public GIntervalDate(Date okMin,
                     Date okMax)

Constructor of the interval only with OK zone and inclusive rules in both edges.

Parameters:

okMin - minimum value of the OK range.

okMax - maximum value of the OK range.

GIntervalDate

public GIntervalDate(String okMin,
                     String okMax)
              throws GDateFieldException

Constructor of the interval only with OK zone and inclusive rules in both edges.

Parameters:

okMin - minimum value of the OK range.

okMax - maximum value of the OK range.

Throws:

GDateFieldException - in case of error parsing the date strings.

GIntervalDate

public GIntervalDate(String okMin,
                     String okMax,
                     GIntervalAbstract.Rule okMinRule,
                     GIntervalAbstract.Rule okMaxRule,
                     String warnMin,
                     String warnMax,
                     GIntervalAbstract.Rule warnMinRule,
                     GIntervalAbstract.Rule warnMaxRule)
              throws GDateFieldException

Constructor of the interval with OK and WARN zones.

Parameters:

okMin - minimum value of the OK range.

okMax - maximum value of the OK range.

okMinRule - rule used for the comparison against the minimum value of the OK range.

okMaxRule - rule used for the comparison against the maximum value of the OK range.

warnMin - minimum value of the WARN range.

warnMax - maximum value of the WARN range.

warnMinRule - rule used for the comparison against the minimum value of the WARN range.

warnMaxRule - rule used for the comparison against the maximum value of the WARN range.

Throws:

GDateFieldException - in case of error parsing the date strings.

GIntervalDate

public GIntervalDate(Date okMin,
                     Date okMax,
                     GIntervalAbstract.Rule okMinRule,
                     GIntervalAbstract.Rule okMaxRule,
                     Date warnMin,
                     Date warnMax,
                     GIntervalAbstract.Rule warnMinRule,
                     GIntervalAbstract.Rule warnMaxRule)

Constructor of the interval with OK and WARN zones.

Parameters:

okMin - minimum value of the OK range.

okMax - maximum value of the OK range.

okMinRule - rule used for the comparison against the minimum value of the OK range.

okMaxRule - rule used for the comparison against the maximum value of the OK range.

warnMin - minimum value of the WARN range.

warnMax - maximum value of the WARN range.

warnMinRule - rule used for the comparison against the minimum value of the WARN range.

warnMaxRule - rule used for the comparison against the maximum value of the WARN range.

Method Detail

getMessage

public String getMessage()

Get the message describing the interval checks.

Specified by:

getMessage in class GIntervalAbstract

Returns:

the message describing the interval checks.

testRange

public GIntervalAbstract.GStatus testRange(Object object)

Check the value against the interval.

Specified by:

testRange in class GIntervalAbstract

Parameters:

object - value to check.

Returns:

the status after the check.

overlaps

public boolean overlaps(GIntervalAbstract otherInterval)

Check the overlapping with another interval.

Specified by:

overlaps in class GIntervalAbstract

Parameters:

otherInterval - to verify the overlapping.

Returns:

true if the intervals overlap, false otherwise.

getMinValue

protected Date getMinValue()

Description copied from class: GIntervalAbstract

Get the absolute minimum value of the ok minimum and warning minimum.

Specified by:

getMinValue in class GIntervalAbstract

Returns:

the absolute minimum value of the ok minimum and warning minimum.

getMaxValue

protected Date getMaxValue()

Description copied from class: GIntervalAbstract

Get the absolute maximum value of the ok maximum and warning maximum.

Specified by:

getMaxValue in class GIntervalAbstract

Returns:

the absolute minimum value of the ok maximum and warning maximum.

getMinRule

protected GIntervalAbstract.Rule getMinRule()

Description copied from class: GIntervalAbstract

Get the rule applying to the absolute minimum.

Specified by:

getMinRule in class GIntervalAbstract

Returns:

the rule applying to the absolute minimum.

getMaxRule

protected GIntervalAbstract.Rule getMaxRule()

Description copied from class: GIntervalAbstract

Get the rule applying to the absolute maximum.

Specified by:

getMaxRule in class GIntervalAbstract

Returns:

the rule applying to the absolute maximum.

getOkMin

protected Date getOkMin()

Returns:

the m_okMin

getOkMax

protected Date getOkMax()

Returns:

the m_okMax

getOkMinRule

protected GIntervalAbstract.Rule getOkMinRule()

Returns:

the m_okMinRule

getOkMaxRule

protected GIntervalAbstract.Rule getOkMaxRule()

Returns:

the m_okMaxRule

isWarnCheckEnabled

protected boolean isWarnCheckEnabled()

Returns:

the m_warnCheckEnabled

getWarnMin

protected Date getWarnMin()

Returns:

the m_warnMin

getWarnMax

protected Date getWarnMax()

Returns:

the m_warnMax

getWarnMinRule

protected GIntervalAbstract.Rule getWarnMinRule()

Returns:

the m_warnMinRule

getWarnMaxRule

protected GIntervalAbstract.Rule getWarnMaxRule()

Returns:

the m_warnMaxRule

setOkMin

protected void setOkMin(Date okMin)

Set the absolute minimum value of the OK zone.

Parameters:

okMin - the absolute minimum value of the OK zone.

setOkMin

protected void setOkMin(String okMin)
                 throws GDateFieldException

Set the absolute minimum value of the OK zone.

Parameters:

okMin - the absolute minimum value of the OK zone.

Throws:

GDateFieldException - in case the date can not be parsed.

setOkMax

protected void setOkMax(Date okMax)

Set the absolute maximum value of the OK zone.

Parameters:

okMax - the absolute maximum value of the OK zone.

setOkMax

protected void setOkMax(String okMax)
                 throws GDateFieldException

Set the absolute maximum value of the OK zone.

Parameters:

okMax - the absolute maximum value of the OK zone.

Throws:

GDateFieldException - in case the date can not be parsed.

setOkMinRule

protected void setOkMinRule(GIntervalAbstract.Rule okMinRule)

Set the rule applying to the absolute minimum of the OK zone.

Parameters:

okMinRule - the rule applying to the absolute minimum of the OK zone.

setOkMaxRule

protected void setOkMaxRule(GIntervalAbstract.Rule okMaxRule)

Set the rule applying to the absolute maximum of the OK zone.

Parameters:

okMaxRule - the rule applying to the absolute maximum of the OK zone.

setWarnMin

protected void setWarnMin(Date warnMin)

Set the absolute minimum value of the WARN zone. If the WARN zone is undefined, it is previously initialized to the OK zone.

Parameters:

warnMin - the absolute minimum value of the WARN zone.

setWarnMin

protected void setWarnMin(String warnMin)
                   throws GDateFieldException

Set the absolute minimum value of the WARN zone. If the WARN zone is undefined, it is previously initialized to the OK zone.

Parameters:

warnMin - the absolute minimum value of the WARN zone.

Throws:

GDateFieldException - in case the date can not be parsed.

setWarnMax

protected void setWarnMax(Date warnMax)

Set the absolute maximum value of the WARN zone. If the WARN zone is undefined, it is previously initialized to the OK zone.

Parameters:

warnMax - the absolute maximum value of the WARN zone.

setWarnMax

protected void setWarnMax(String warnMax)
                   throws GDateFieldException

Set the absolute maximum value of the WARN zone. If the WARN zone is undefined, it is previously initialized to the OK zone.

Parameters:

warnMax - the absolute maximum value of the WARN zone.

Throws:

GDateFieldException - in case the date can not be parsed.

setWarnMinRule

protected void setWarnMinRule(GIntervalAbstract.Rule warnMinRule)

Set the rule applying to the absolute minimum of the WARN zone. If the WARN zone is undefined, it is previously initialized to the OK zone.

Parameters:

warnMinRule - the rule applying to the absolute minimum of the WARN zone.

setWarnMaxRule

protected void setWarnMaxRule(GIntervalAbstract.Rule warnMaxRule)

Set the rule applying to the absolute maximum of the WARN zone. If the WARN zone is undefined, it is previously initialized to the OK zone.

Parameters:

warnMaxRule - the rule applying to the absolute maximum of the WARN zone.

removeWarnCheck

protected void removeWarnCheck()

Removes the WARN zone of the interval.

clone

protected GIntervalDate clone()

Overrides:

clone in class Object

updateMessage

public void updateMessage(GUnit currentUnit,
                          GIntervalFormatAbstract formatter)

Update the interval message using the unit, and format provided.

Specified by:

updateMessage in class GIntervalAbstract

Parameters:

currentUnit - the unit to use to convert the interval limits.

formatter - Necessary data to format the message (normal/scientific format and fractional digits)