fr.cnes.genius.highLevel

Class GEntryRealVector

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.highLevel.GEntryVectorAbstract

fr.cnes.genius.highLevel.GEntryRealVector

All Implemented Interfaces:

MouseWheelListener, EventListener

public class GEntryRealVector
extends GEntryVectorAbstract

This class is in charge of vector handling by means of fields to input real numbers. It is never used separately but used in coordination with a GTable1D object. This object is composed of a list of input fields of real numbers and a pull-down menu of type GPopupList to display units when units are defined for the vector. This class implements save and load of values in the configuration file following the definition of the class GEntryVectorAbstract. The class GEntryRealVector is a sub-class of GEntryVectorAbstract which is in charge of:

• Validity intervals handling,
• Add or delete fields,
• Units handling if the type of field allows units definition.

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
GEntryRealVector(String name, ArrayList<Double> valueList) Constructor.
GEntryRealVector(String name, double[] valueArray) Constructor.
GEntryRealVector(String name, double[] valueArray, GUnit[] unitArray) Constructor.
GEntryRealVector(String name, List<Double> valueList, GUnit[] unitArray) Constructor.
GEntryRealVector(String widgetId, String name, ArrayList<Double> valueList) Constructor.
GEntryRealVector(String widgetId, String name, double[] valueArray) Constructor.
GEntryRealVector(String widgetId, String name, double[] valueArray, GUnit[] unitArray) Constructor.
GEntryRealVector(String widgetId, String name, List<Double> valueList, GUnit[] unitArray) Constructor.

Method Summary

Modifier and Type	Method and Description
void	add(int rank, Object value) Adds an item to the vector.
double[]	getDoubleArray() Returns the array of values stored in the array as doubles.
GPopupList	getGUnitMenu() Get the unit menu widget.
GComponent	getSubComponent(int position) Gets the subcomponent occupying the position defined by position.
protected GUnit	getUnitInConfig() Get the unit in configuration file.
Number	getValue(int rank) Get the value of the element corresponding to the index "rank".
boolean	handleEvent(GEvent event) Handles an event provided by the GTable1D.
boolean	isModified() Gets the modification status of the component against the last set of values loaded or saved.
protected Number	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 unitString) 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	setEnabled(boolean flag) Set the enable status of the component.
void	setFormatMode(GEnvironment.Format formatMode) Sets the format allowed for the field.
void	setFracDigits(int fracDigits) Set the number of fractional digits.
void	setSavedValue(int rank, Object numberValue) Sets the saved value of an element of the vector and then updates the modified indicator.
void	setValue(int rank, Object numberValue) Sets the value of an element of the vector and then updates the status of the vector.
void	setWidgetId(String widgetId) Sets the widget identifier of the component.
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, getValueArray, isEnabled, read, removeAllInternal, removeGInterval, setComponentConstraint, setDefaultConstraints, setFieldValue, setLabelAndUnitConstraint, setLabelConstraint, setNameInConfigFile, setToolTipText, 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

GEntryRealVector

public GEntryRealVector(String name,
                        double[] valueArray)

Constructor. No units are defined for the vector. The widget identifier is automatically assigned.

Parameters:

name - of the vector.

valueArray - list of initial values.

GEntryRealVector

public GEntryRealVector(String widgetId,
                        String name,
                        double[] valueArray)

Constructor. No units are defined for the vector.

Parameters:

widgetId - widget identifier.

name - of the vector.

valueArray - list of initial values.

GEntryRealVector

public GEntryRealVector(String name,
                        ArrayList<Double> valueList)

Constructor. No units are defined for the vector. The widget identifier is automatically assigned.

Parameters:

name - of the vector.

valueList - list of initial values.

GEntryRealVector

public GEntryRealVector(String widgetId,
                        String name,
                        ArrayList<Double> valueList)

Constructor. No units are defined for the vector.

Parameters:

widgetId - widget identifier.

name - of the vector.

valueList - list of initial values.

GEntryRealVector

public GEntryRealVector(String name,
                        double[] valueArray,
                        GUnit[] unitArray)

Constructor. No units are defined for the vector. The widget identifier is automatically assigned.

Parameters:

name - of the vector.

valueArray - list of initial values.

unitArray - array containing the GUnits applicable to the field.

GEntryRealVector

public GEntryRealVector(String widgetId,
                        String name,
                        double[] valueArray,
                        GUnit[] unitArray)

Constructor. No units are defined for the vector.

Parameters:

widgetId - widget identifier.

name - of the vector.

valueArray - list of initial values.

unitArray - array containing the GUnits applicable to the field.

GEntryRealVector

public GEntryRealVector(String name,
                        List<Double> valueList,
                        GUnit[] unitArray)

Constructor. No units are defined for the vector. The widget identifier is automatically assigned.

Parameters:

name - of the vector.

valueList - list of initial values.

unitArray - array containing the GUnits applicable to the field.

GEntryRealVector

public GEntryRealVector(String widgetId,
                        String name,
                        List<Double> valueList,
                        GUnit[] unitArray)

Constructor. No units are defined for the vector.

Parameters:

widgetId - widget identifier.

name - of the vector.

valueList - list of initial values.

unitArray - array containing the GUnits applicable to the field.

Method Detail

getDoubleArray

public double[] getDoubleArray()

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

Returns:

the array of values stored in the array as doubles.

add

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

Adds an item to the vector.

Specified by:

add in class GEntryVectorAbstract

Parameters:

rank - of the new item.

value - of the new item.

Throws:

GArithmeticException - if memoryValue is NaN

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

Description copied from class: GEntryVectorAbstract

Get the unit menu widget.

Specified by:

getGUnitMenu in class GEntryVectorAbstract

Returns:

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

getUnitInConfig

protected GUnit getUnitInConfig()

Description copied from class: GEntryVectorAbstract

Get the unit in configuration file.

Overrides:

getUnitInConfig in class GEntryVectorAbstract

Returns:

the unit in configuration file or null.

getValue

public Number getValue(int rank)

Description copied from class: GEntryVectorAbstract

Get the value of the element corresponding to the index "rank".

Overrides:

getValue in class GEntryVectorAbstract

Parameters:

rank - index of the element for which the value is returned.

Returns:

the value of the element corresponding to the index "rank".

setValue

public void setValue(int rank,
                     Object numberValue)
              throws GArithmeticException

Sets the value of an element of the vector and then updates the status of the vector.

Overrides:

setValue in class GEntryVectorAbstract

Parameters:

rank - of the value to update.

numberValue - the value in SI units, it will be displayed in the field after the appropriate unit transformation.

Throws:

GArithmeticException - if numberValue is NaN

setSavedValue

public void setSavedValue(int rank,
                          Object numberValue)
                   throws GArithmeticException,
                          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.

numberValue - the value in SI units.

Throws:

GArithmeticException - if numberValue is NaN.

GException - if numberValue is NaN or if rank is out of bounds.

setEnabled

public void setEnabled(boolean flag)

Description copied from class: GComponent

Set the enable status of the component.

Overrides:

setEnabled in class GEntryVectorAbstract

Parameters:

flag - new enable status of the component.

writeVector

protected void writeVector(org.jdom.Element parentElement)

Description copied from class: GEntryVectorAbstract

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 unitString)
                   throws GException

Description copied from class: GEntryVectorAbstract

Reads the elements of the vector from file.

Specified by:

readVector in class GEntryVectorAbstract

Parameters:

e - from where the values are read.

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

Throws:

GException - in case of problem reading the vector from file.

See Also:

GEntryVectorAbstract.writeVector(Element).

parseValue

protected Number parseValue(String value)

Description copied from class: GEntryVectorAbstract

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.

setWidgetId

public void setWidgetId(String widgetId)

Sets the widget identifier of the component.

Overrides:

setWidgetId in class GEntryVectorAbstract

Parameters:

widgetId - the widget identifier of the component.

setFracDigits

public void setFracDigits(int fracDigits)
                   throws GEntryRealException

Set the number of fractional digits.

Parameters:

fracDigits - number of fractional digits.

Throws:

GEntryRealException - in case the number of fractionary digits is bigger than the MAX_FRAC_DIGITS (defaults to 15).

setFormatMode

public void setFormatMode(GEnvironment.Format formatMode)

Sets the format allowed for the field. If the format is NORMAL the value is formatted using the standard format. If the format is SCIENTIFIC the value is formatted using the scientific format. If the format is BOTH then a menu is enabled allowing the user to change between formats.

Parameters:

formatMode - allowed for the field.

handleEvent

public boolean handleEvent(GEvent event)

Handles an event provided by the GTable1D. It handles the events coming from the getGUnitMenu and the components.

Specified by:

handleEvent in class GEntryVectorAbstract

Parameters:

event - to treat.

Returns:

true if the event is treated, false otherwise.

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.

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)
                     throws GArithmeticException

Set the new default value.

Specified by:

setDefaultValue in class GEntryVectorAbstract

Parameters:

defaultValue - new default value.

Throws:

GArithmeticException - if defaultValue is NaN

getSubComponent

public GComponent getSubComponent(int position)
                           throws GComponentException

Gets the subcomponent occupying the position defined by position.

Overrides:

getSubComponent in class GEntryVectorAbstract

Parameters:

position - position of the requested component.

Returns:

the subcomponent occupying the position defined by position.

Throws:

GComponentException - in case the position argument is invalid.