fr.cnes.genius.interval

Class GIntervalAbstract

java.lang.Object

fr.cnes.genius.interval.GIntervalAbstract

Direct Known Subclasses:

GInterval, GIntervalDate, GIntervalEmptyString

public abstract class GIntervalAbstract
extends Object

Abstract class for intervals so it can be extended for different inteval types. The class shall verify it is overlaps with another interval, to verify if an object is within the range returning an OK, WARN, or ERROR status. The class also returns the message with information about the intervals to display it in the tooltip of the widvget using it.

Author:

jjct

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GIntervalAbstract.GStatus Enumerate defining the condition of the value being check.
static class	GIntervalAbstract.Rule Enumerates to define the comportement of the range limits, if INCLUSIVE the test is done using "<=" or ">=", if EXCLUSIVE the test is done using "<" or ">".

Constructor Summary

Constructors

Constructor and Description
GIntervalAbstract() Constructor.

Method Summary

Modifier and Type	Method and Description
protected abstract GIntervalAbstract.Rule	getMaxRule() Get the rule applying to the absolute maximum.
protected abstract Object	getMaxValue() Get the absolute maximum value of the ok maximum and warning maximum.
abstract String	getMessage() Get the message describing the interval checks.
protected abstract GIntervalAbstract.Rule	getMinRule() Get the rule applying to the absolute minimum.
protected abstract Object	getMinValue() Get the absolute minimum value of the ok minimum and warning minimum.
abstract boolean	overlaps(GIntervalAbstract interval) Check the overlapping with another interval.
abstract GIntervalAbstract.GStatus	testRange(Object object) Check the value against the interval.
abstract void	updateMessage(GUnit currentUnit, GIntervalFormatAbstract formatter) Update the interval message using the unit, and format provided.

Methods inherited from class java.lang.Object

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

Constructor Detail

GIntervalAbstract

public GIntervalAbstract()

Constructor.

Method Detail

overlaps

public abstract boolean overlaps(GIntervalAbstract interval)

Check the overlapping with another interval.

Parameters:

interval - to verify the overlapping.

Returns:

true if the intervals overlap, false otherwise.

getMinValue

protected abstract Object getMinValue()

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

Returns:

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

getMaxValue

protected abstract Object getMaxValue()

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

Returns:

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

getMaxRule

protected abstract GIntervalAbstract.Rule getMaxRule()

Get the rule applying to the absolute maximum.

Returns:

the rule applying to the absolute maximum.

getMinRule

protected abstract GIntervalAbstract.Rule getMinRule()

Get the rule applying to the absolute minimum.

Returns:

the rule applying to the absolute minimum.

testRange

public abstract GIntervalAbstract.GStatus testRange(Object object)

Check the value against the interval.

Parameters:

object - value to check.

Returns:

the status after the check.

getMessage

public abstract String getMessage()

Get the message describing the interval checks.

Returns:

the message describing the interval checks.

updateMessage

public abstract void updateMessage(GUnit currentUnit,
                                   GIntervalFormatAbstract formatter)

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

Parameters:

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

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