fr.cnes.genius.highLevel

Class GEntryDateVector

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.highLevel.GEntryVectorAbstract

fr.cnes.genius.highLevel.GEntryDateVector

All Implemented Interfaces:

MouseWheelListener, EventListener

public class GEntryDateVector
extends GEntryVectorAbstract

Vector of GIntField widgets. This class is never used alone but always in combination with a GTable1D object. The class implements save / load of values in the configuration file following the definition of the class GEntryVectorAbstract. The class inherits of class GEntryVectorAbstract which is in charge of validity range handling, Insertion / Deletion of fields.

Author:

J. Fourcade

Nested Class Summary

Nested classes/interfaces inherited from class fr.cnes.genius.main.GComponent

GComponent.CopyPasteOperation, GComponent.DisplayIndicatorStatus, GComponent.ItemType, GComponent.Operation

Field Summary

Fields inherited from class fr.cnes.genius.main.GComponent

NAME_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
GEntryDateVector(String name, ArrayList<?> valueList) Constructor.
GEntryDateVector(String name, Date[] valueArray) Constructor.
GEntryDateVector(String name, String[] valueArray) Constructor.
GEntryDateVector(String widgetId, String name, ArrayList<?> valueList) Constructor.
GEntryDateVector(String widgetId, String name, Date[] valueArray) Constructor.
GEntryDateVector(String widgetId, String name, String[] valueArray) Constructor.

Method Summary

Modifier and Type	Method and Description
void	add(int rank, Object value) Adds an item to the vector.
Date[]	getDateArray() Returns the array of values stored in the array as integers.
GPopupList	getGUnitMenu() Get the unit menu widget.
boolean	handleEvent(GEvent event) Method used by GTable1D to allow the vector to handle the events received at GTable1D level.
boolean	isModified() Gets the modification status of the component against the last set of values loaded or saved.
protected Object	parseValue(String value) Parse the value in string format and return a Number to be stored in the vector.
protected void	readVector(org.jdom.Element e, String readUnit) Reads the elements of the vector from file.
void	remove(int rank) Remove an element from the vector.
void	removeAll() Remove all the elements from the vector.
void	setDefaultValue(Object defaultValue) Set the new default value.
void	setSavedValue(int rank, Object objectValue) Sets the saved value of an element of the vector and then updates the modified indicator.
void	updateStatus() Update the status information of the vector.
protected void	writeVector(org.jdom.Element parentElement) Writes the elements of the vector to the file.

Methods inherited from class fr.cnes.genius.highLevel.GEntryVectorAbstract

addGInterval, addItem, getGComponent, getGLabelWithIndicator, getGNumberField, getIntervalList, getLabelConstraint, getName, getNameInConfigFile, getSubComponent, getUnitInConfig, getValue, getValueArray, isEnabled, read, removeAllInternal, removeGInterval, setComponentConstraint, setDefaultConstraints, setEnabled, setFieldValue, setLabelAndUnitConstraint, setLabelConstraint, setNameInConfigFile, setToolTipText, setValue, setWidgetId, size, updateGInterval, updateIntervalMessage, updateIsModifiedIndicator, updateStatus, write

Methods inherited from class fr.cnes.genius.main.GComponent

activateConstraintsByType, attachCopyPasteMenu, attachCopyPasteMenu, beginOfElement, beginOfElement, beginOfElement, beginOfElement, clearAllInnerDescendantConstraint, clearConstraint, clearInnerDescendantContraint, composeWidgetId, doDisplay, endOfElement, getCommentInConfigFile, getComponent, getConstraint, getCurrentOperation, getDisplayIndicatorStatus, getDisplayIsModifiedIndicator, getElement, getGClassName, getGPanel, getGParent, getGUnitInConfigFile, getInnerDescendantConstraint, getOperationSaveValue, getPathInConfigFile, getSimpleWidgetId, getStatus, getStringConstraint, getWidgetId, handleCopyPasteEvent, handleCopyPasteEvent, handleProcessEventException, isCopyPasteEvent, isForcedStatus, launchInvalidPositionException, mouseWheelMoved, parseSimpleConstraint, processGEvent, processMouseWheelEvent, setBusyCursor, setCommentInConfigFile, setConstraint, setCopyPasteMenuEnabled, setCurrentOperation, setDataForConstraintsByType, setDisplayIsModifiedIndicator, setElement, setForcedStatus, setGPanel, setGParent, setGUnitInConfigFile, setInnerDescendantConstraint, setName, setNameAndCommentInConfigFile, setPathInConfigFile, setStatus, setStringConstraint, setWidth, setWindowBusyCursor, writeCollection, writeCollection, writeCollection, writeCollection, writeConfigItem, writeConfigItem, writeConfigItem, writeConfigItem, writeConfigItem

Methods inherited from class java.lang.Object

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

Constructor Detail

GEntryDateVector

public GEntryDateVector(String name,
                        Date[] valueArray)

Constructor. The widget identifier is automatically assigned.

Parameters:

name - of the vector.

valueArray - list of initial values.

GEntryDateVector

public GEntryDateVector(String name,
                        String[] valueArray)

Constructor. The widget identifier is automatically assigned.

Parameters:

name - of the vector.

valueArray - list of initial values.

GEntryDateVector

public GEntryDateVector(String widgetId,
                        String name,
                        Date[] valueArray)

Constructor.

Parameters:

widgetId - widget identifier.

name - of the vector.

valueArray - list of initial values.

GEntryDateVector

public GEntryDateVector(String widgetId,
                        String name,
                        String[] valueArray)

Constructor.

Parameters:

widgetId - widget identifier.

name - of the vector.

valueArray - list of initial values.

GEntryDateVector

public GEntryDateVector(String name,
                        ArrayList<?> valueList)

Constructor. The widget identifier is automatically assigned.

Parameters:

name - of the vector.

valueList - list of initial values.

GEntryDateVector

public GEntryDateVector(String widgetId,
                        String name,
                        ArrayList<?> valueList)

Constructor.

Parameters:

widgetId - widget identifier.

name - of the vector.

valueList - list of initial values.

Method Detail

getDateArray

public Date[] getDateArray()

Returns the array of values stored in the array as integers.

Returns:

the array of values stored in the array as integers.

add

public void add(int rank,
                Object value)
         throws GDateFieldException

Adds an item to the vector.

Specified by:

add in class GEntryVectorAbstract

Parameters:

rank - of the new item.

value - of the new item.

Throws:

GDateFieldException - in case the date can not be parsed.

remove

public void remove(int rank)

Description copied from class: GEntryVectorAbstract

Remove an element from the vector.

Overrides:

remove in class GEntryVectorAbstract

Parameters:

rank - of the element to remove.

removeAll

public void removeAll()

Description copied from class: GEntryVectorAbstract

Remove all the elements from the vector.

Specified by:

removeAll in class GEntryVectorAbstract

getGUnitMenu

public GPopupList getGUnitMenu()

Get the unit menu widget.

Specified by:

getGUnitMenu in class GEntryVectorAbstract

Returns:

the unit menu widget, or null if there is not unit menu.

writeVector

protected void writeVector(org.jdom.Element parentElement)

Writes the elements of the vector to the file.

Specified by:

writeVector in class GEntryVectorAbstract

Parameters:

parentElement - where the values are stored.

See Also:

GEntryVectorAbstract.readVector(Element, String).

readVector

protected void readVector(org.jdom.Element e,
                          String readUnit)
                   throws GException

Reads the elements of the vector from file.

Specified by:

readVector in class GEntryVectorAbstract

Parameters:

e - from where the values are read.

readUnit - unit read from the configuration file, that shall be used to set the current unit at vector level.

Throws:

GException

See Also:

GEntryVectorAbstract.writeVector(Element).

parseValue

protected Object parseValue(String value)
                     throws GDateFieldException

Parse the value in string format and return a Number to be stored in the vector. This method shall be implmented for each derived class.

Specified by:

parseValue in class GEntryVectorAbstract

Parameters:

value - string containing the value to be parsed.

Returns:

the Number corresponding to stringValue.

Throws:

GDateFieldException - in case of error parsing the value.

isModified

public boolean isModified()

Description copied from class: GComponent

Gets the modification status of the component against the last set of values loaded or saved.

Overrides:

isModified in class GComponent

Returns:

the modification status of the component against the last set of values loaded or saved.

handleEvent

public boolean handleEvent(GEvent event)

Description copied from class: GEntryVectorAbstract

Method used by GTable1D to allow the vector to handle the events received at GTable1D level.

Specified by:

handleEvent in class GEntryVectorAbstract

Parameters:

event - to process.

Returns:

true if the event was processed, false otherwise.

updateStatus

public void updateStatus()

Description copied from class: GEntryVectorAbstract

Update the status information of the vector.

Specified by:

updateStatus in class GEntryVectorAbstract

setDefaultValue

public void setDefaultValue(Object defaultValue)

Set the new default value.

Specified by:

setDefaultValue in class GEntryVectorAbstract

Parameters:

defaultValue - new default value.

setSavedValue

public void setSavedValue(int rank,
                          Object objectValue)
                   throws GException

Sets the saved value of an element of the vector and then updates the modified indicator.

Specified by:

setSavedValue in class GEntryVectorAbstract

Parameters:

rank - of the value to update its saved status.

objectValue - the value in SI units.

Throws:

GArithmeticException - if objectValue is NaN

GException - if the rank is out of bounds