fr.cnes.genius.interval

Class GInterval

java.lang.Object

fr.cnes.genius.interval.GIntervalAbstract

fr.cnes.genius.interval.GInterval

All Implemented Interfaces:

Cloneable

public class GInterval
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
GInterval(Number okMin, Number okMax) Constructor of the interval only with OK zone and inclusive rules in both edges.
GInterval(Number okMin, Number okMax, GIntervalAbstract.Rule okMinRule, GIntervalAbstract.Rule okMaxRule) Constructor of the interval only with OK zone.
GInterval(Number okMin, Number okMax, GIntervalAbstract.Rule okMinRule, GIntervalAbstract.Rule okMaxRule, Number warnMin, Number warnMax, GIntervalAbstract.Rule warnMinRule, GIntervalAbstract.Rule warnMaxRule) Constructor of the interval with OK and WARN zones.

Method Summary

Modifier and Type	Method and Description
void	checkInterval() Checks the coherence of the Ok and Warn values and rules.
GInterval	clone()
GIntervalAbstract.Rule	getMaxRule() Get the rule applying to the absolute maximum.
Double	getMaxValue() Get the absolute maximum value of the ok maximum and warning maximum.
String	getMessage() Get the message describing the interval checks.
GIntervalAbstract.Rule	getMinRule() Get the rule applying to the absolute minimum.
Double	getMinValue() Get the absolute minimum value of the ok minimum and warning minimum.
double	getOkMax()
GIntervalAbstract.Rule	getOkMaxRule()
double	getOkMin()
GIntervalAbstract.Rule	getOkMinRule()
double	getWarnMax()
GIntervalAbstract.Rule	getWarnMaxRule()
double	getWarnMin()
GIntervalAbstract.Rule	getWarnMinRule()
boolean	isWarnCheckEnabled()
boolean	overlaps(GIntervalAbstract otherInterval) Check the overlapping with another interval.
void	removeWarnCheck() Removes the WARN zone of the interval.
void	removeWarnCheck(boolean isCheck) Removes the WARN zone of the interval.
void	setOkMax(double okMax) Set the absolute maximum value of the OK zone.
void	setOkMax(double okMax, boolean isCheck) Set the absolute maximum value of the OK zone.
void	setOkMaxRule(GIntervalAbstract.Rule okMaxRule) Set the rule applying to the absolute maximum of the OK zone.
void	setOkMaxRule(GIntervalAbstract.Rule okMaxRule, boolean isCheck) Set the rule applying to the absolute maximum of the OK zone.
void	setOkMin(double okMin) Set the absolute minimum value of the OK zone.
void	setOkMin(double okMin, boolean isCheck) Set the absolute minimum value of the OK zone.
void	setOkMinRule(GIntervalAbstract.Rule okMinRule) Set the rule applying to the absolute minimum of the OK zone.
void	setOkMinRule(GIntervalAbstract.Rule okMinRule, boolean isCheck) Set the rule applying to the absolute minimum of the OK zone.
void	setWarnMax(double warnMax) Set the absolute maximum value of the WARN zone.
void	setWarnMax(double warnMax, boolean isCheck) Set the absolute maximum value of the WARN zone.
void	setWarnMaxRule(GIntervalAbstract.Rule warnMaxRule) Set the rule applying to the absolute maximum of the WARN zone.
void	setWarnMaxRule(GIntervalAbstract.Rule warnMaxRule, boolean isCheck) Set the rule applying to the absolute maximum of the WARN zone.
void	setWarnMin(double warnMin) Set the absolute minimum value of the WARN zone.
void	setWarnMin(double warnMin, boolean isCheck) Set the absolute minimum value of the WARN zone.
void	setWarnMinRule(GIntervalAbstract.Rule warnMinRule) Set the rule applying to the absolute minimum of the WARN zone.
void	setWarnMinRule(GIntervalAbstract.Rule warnMinRule, boolean isCheck) 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

GInterval

public GInterval(Number okMin,
                 Number 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.

GInterval

public GInterval(Number okMin,
                 Number 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.

GInterval

public GInterval(Number okMin,
                 Number okMax,
                 GIntervalAbstract.Rule okMinRule,
                 GIntervalAbstract.Rule okMaxRule,
                 Number warnMin,
                 Number 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

checkInterval

public final void checkInterval()
                         throws GIntervalException

Checks the coherence of the Ok and Warn values and rules.

Throws:

GIntervalException - if:
okMax < okMin,
(okMinRule=EXCLUSIVE or okMaxRule=EXCLUSIVE) and okMax=okMin,
warnMax < warnMin,
(warnMinRule=EXCLUSIVE or warnMaxRule=EXCLUSIVE) and warnMax=warnMin,
okMin < warnMin,
okMinRule=INCLUSIVE and warnMinRule=EXCLUSIVE and okMin=warnMin,
warnMax < okMax,
or okMaxRule=INCLUSIVE and warnMaxRule=EXCLUSIVE and warnMax=okMax.

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

public Double 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

public Double 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

public 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

public 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

public double getOkMin()

Returns:

the m_okMin

getOkMax

public double getOkMax()

Returns:

the m_okMax

getOkMinRule

public GIntervalAbstract.Rule getOkMinRule()

Returns:

the m_okMinRule

getOkMaxRule

public GIntervalAbstract.Rule getOkMaxRule()

Returns:

the m_okMaxRule

isWarnCheckEnabled

public boolean isWarnCheckEnabled()

Returns:

the m_warnCheckEnabled

getWarnMin

public double getWarnMin()

Returns:

the m_warnMin

getWarnMax

public double getWarnMax()

Returns:

the m_warnMax

getWarnMinRule

public GIntervalAbstract.Rule getWarnMinRule()

Returns:

the m_warnMinRule

getWarnMaxRule

public GIntervalAbstract.Rule getWarnMaxRule()

Returns:

the m_warnMaxRule

setOkMin

public void setOkMin(double okMin)
              throws GIntervalException

Set the absolute minimum value of the OK zone.

Parameters:

okMin - the absolute minimum value of the OK zone.

Throws:

GIntervalException - if the interval is not valid

setOkMin

public void setOkMin(double okMin,
                     boolean isCheck)
              throws GIntervalException

Set the absolute minimum value of the OK zone.

Parameters:

okMin - the absolute minimum value of the OK zone.

isCheck - check if true.

Throws:

GIntervalException - if the interval is not valid

setOkMax

public void setOkMax(double okMax)
              throws GIntervalException

Set the absolute maximum value of the OK zone.

Parameters:

okMax - the absolute maximum value of the OK zone.

Throws:

GIntervalException - if the interval is not valid

setOkMax

public void setOkMax(double okMax,
                     boolean isCheck)
              throws GIntervalException

Set the absolute maximum value of the OK zone.

Parameters:

okMax - the absolute maximum value of the OK zone.

isCheck - check if true.

Throws:

GIntervalException - if the interval is not valid

setOkMinRule

public void setOkMinRule(GIntervalAbstract.Rule okMinRule)
                  throws GIntervalException

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.

Throws:

GIntervalException - if the interval is not valid

setOkMinRule

public void setOkMinRule(GIntervalAbstract.Rule okMinRule,
                         boolean isCheck)
                  throws GIntervalException

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.

isCheck - check if true.

Throws:

GIntervalException - if the interval is not valid

setOkMaxRule

public void setOkMaxRule(GIntervalAbstract.Rule okMaxRule)
                  throws GIntervalException

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.

Throws:

GIntervalException - if the interval is not valid

setOkMaxRule

public void setOkMaxRule(GIntervalAbstract.Rule okMaxRule,
                         boolean isCheck)
                  throws GIntervalException

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.

isCheck - check if true.

Throws:

GIntervalException - if the interval is not valid

setWarnMin

public void setWarnMin(double warnMin)
                throws GIntervalException

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:

GIntervalException - if the interval is not valid

setWarnMin

public void setWarnMin(double warnMin,
                       boolean isCheck)
                throws GIntervalException

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.

isCheck - check if true.

Throws:

GIntervalException - if the interval is not valid

setWarnMax

public void setWarnMax(double warnMax)
                throws GIntervalException

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:

GIntervalException - if the interval is not valid

setWarnMax

public void setWarnMax(double warnMax,
                       boolean isCheck)
                throws GIntervalException

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.

isCheck - check if true.

Throws:

GIntervalException - if the interval is not valid

setWarnMinRule

public void setWarnMinRule(GIntervalAbstract.Rule warnMinRule)
                    throws GIntervalException

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.

Throws:

GIntervalException - if the interval is not valid

setWarnMinRule

public void setWarnMinRule(GIntervalAbstract.Rule warnMinRule,
                           boolean isCheck)
                    throws GIntervalException

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.

isCheck - check if true.

Throws:

GIntervalException - if the interval is not valid

setWarnMaxRule

public void setWarnMaxRule(GIntervalAbstract.Rule warnMaxRule)
                    throws GIntervalException

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.

Throws:

GIntervalException - if the interval is not valid

setWarnMaxRule

public void setWarnMaxRule(GIntervalAbstract.Rule warnMaxRule,
                           boolean isCheck)
                    throws GIntervalException

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.

isCheck - check if true.

Throws:

GIntervalException - if the interval is not valid

removeWarnCheck

public void removeWarnCheck()
                     throws GIntervalException

Removes the WARN zone of the interval.

Throws:

GIntervalException - if the interval is not valid

removeWarnCheck

public void removeWarnCheck(boolean isCheck)
                     throws GIntervalException

Removes the WARN zone of the interval.

Parameters:

isCheck - check if true.

Throws:

GIntervalException - if the interval is not valid

clone

public GInterval 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)