fr.cnes.genius.interval

Class GIntervalList

java.lang.Object

fr.cnes.genius.interval.GIntervalList

public class GIntervalList
extends Object

Class used to define the list of intervals to apply to a value to determine if it is valid or not. The validity intervals list is dynamic: it is possible to insert, delete, or modify intervals of the list. The intervals cannot overlap each other otherwise an exception is thrown. The validity intervals lists are used by classes GEntryInt, GEntryReal, GEntryIntVector, GEntryRealVector.

Author:

jjct

Constructor Summary

Constructors

Constructor and Description
GIntervalList() Constructor.

Method Summary

Modifier and Type	Method and Description
void	add(GIntervalAbstract interval) Adds a validity interval to the list.
GIntervalAbstract	get(int index) Get the interval of a given index in the list.
String	getMessage() Return the error message associated with the last value checked, if the value is OK then the message is empty.
boolean	isEmpty() Check if the interval list is empty.
void	remove(GIntervalAbstract interval) Removes a validity interval of the list.
GIntervalAbstract.GStatus	testRange(Object object) Checks if the value is contained in any of the intervals.
void	update(GIntervalAbstract oldInterval, GIntervalAbstract newInterval) Update an validity interval of the list.
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

GIntervalList

public GIntervalList()

Constructor. Creates an empty interval list.

Method Detail

add

public void add(GIntervalAbstract interval)
         throws GIntervalException

Adds a validity interval to the list.

Parameters:

interval - to be added.

Throws:

GIntervalException - If the new interval overlaps with an existing interval in the list.

remove

public void remove(GIntervalAbstract interval)

Removes a validity interval of the list.

Parameters:

interval - to be removed.

get

public GIntervalAbstract get(int index)

Get the interval of a given index in the list.

Parameters:

index - of the wanted interval in the intervals list.

Returns:

wanted interval

update

public void update(GIntervalAbstract oldInterval,
                   GIntervalAbstract newInterval)
            throws GIntervalException

Update an validity interval of the list.

Parameters:

oldInterval - to be updated.

newInterval - to update oldInterval.

Throws:

GIntervalException - in case the interval to replace does not exist, the interval list is not modified.

testRange

public GIntervalAbstract.GStatus testRange(Object object)

Checks if the value is contained in any of the intervals.

Parameters:

object - to test.

Returns:

OK if the value in within an interval, WARN or ERROR in other case.

getMessage

public String getMessage()

Return the error message associated with the last value checked, if the value is OK then the message is empty.

Returns:

the error message associated with the last value checked.

updateMessage

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

isEmpty

public boolean isEmpty()

Check if the interval list is empty.

Returns:

true if the interval list is empty, false otherwise.