fr.cnes.genius.highLevel

Class GEntryVectorAbstract

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.highLevel.GEntryVectorAbstract

All Implemented Interfaces:

MouseWheelListener, EventListener

Direct Known Subclasses:

GEntryDateVector, GEntryIntVector, GEntryRealVector

public abstract class GEntryVectorAbstract
extends GComponent

Abstract class defining the common code and methods for the different GEntryVector classes. Example of specialized classes are GEntryIntVector and GEntryRealVector. The code included is :

• Display of label and list of input fields,
• Validity range handling, associated icon, and the tool tip,
• Handling of list of input fields, insertion, deletion, etc.
• Unit handling for the vector when it is the case,
• Activation and deactivation of the component,
• Common part of implementation of interfaces for save / load values from configuration files.

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
GEntryVectorAbstract(String name) Constructor.
GEntryVectorAbstract(String widgetId, String name) Constructor.

Method Summary

Modifier and Type	Method and Description
abstract void	add(int rank, Object value) Adds an item to the vector.
void	addGInterval(GIntervalAbstract interval) Adds an interval to the interval list and update the status of all the entries taking into account the new intervals.
protected void	addItem(int rank, GNumberFieldAbstract field, Object value) Adds a new element to the vector.
GComponent	getGComponent(int rank) Get the component corresponding to the specified rank.
GLabelWithIndicator	getGLabelWithIndicator() Return the GLabel associated with the vector.
GNumberFieldAbstract	getGNumberField(int rank) Get the GNumberFieldAbstract corresponding to the specified rank.
abstract GPopupList	getGUnitMenu() Get the unit menu widget.
protected GIntervalList	getIntervalList() Get the interval list.
GConstraint	getLabelConstraint() Get the constraint of the label.
String	getName() Return the name of the vector.
String	getNameInConfigFile() Get the name of the vector in the configuration file.
GComponent	getSubComponent(int position) Gets the subcomponent occupying the position defined by position.
protected GUnit	getUnitInConfig() Get the unit in configuration file.
Object	getValue(int rank) Get the value of the element corresponding to the index "rank".
Object[]	getValueArray() Return the array of the values contained in the vector.
abstract boolean	handleEvent(GEvent event) Method used by GTable1D to allow the vector to handle the events received at GTable1D level.
boolean	isEnabled() Gets the enable status of the widget.
protected abstract Object	parseValue(String stringValue) Parse the value in string format and return a Number to be stored in the vector.
void	read(org.jdom.Element e) Read the vector from file.
protected abstract 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.
abstract void	removeAll() Remove all the elements from the vector.
void	removeAllInternal() Remove all the elements of the vector.
void	removeGInterval(GIntervalAbstract interval) Remove a validity interval of the field.
void	setComponentConstraint(GTable1D.TableOrientation orientation, int rank) Set the components constraints.
protected void	setDefaultConstraints() Set default constraints.
abstract void	setDefaultValue(Object defaultValue) Set the new default value.
void	setEnabled(boolean flag) Set the enable status of the component.
protected void	setFieldValue(int rank, Object objectValue) Sets the value of a field in the vector but does not update the status of the vector.
void	setLabelAndUnitConstraint(GTable1D.TableOrientation orientation, int rank) Set the label and unit constraints.
void	setLabelConstraint(GConstraint constraint) Set the constraint of the label.
void	setNameInConfigFile(String name) Set the name of the vector in the configuration file.
abstract void	setSavedValue(int rank, Object objectValue) Sets the saved value of an element of the vector and then updates the modified indicator.
void	setToolTipText(String text) Set the tooltip text for the entry's label.
void	setValue(int rank, Object objectValue) 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.
int	size() Get the number of items in the vector.
void	updateGInterval(GIntervalAbstract oldInterval, GIntervalAbstract newInterval) Update a validity interval of the field.
protected void	updateIntervalMessage(GUnit currentUnit, GEnvironment.Format currentFormat) Updates the interval message with units and format requested.
protected void	updateIsModifiedIndicator() Updates the is modified indicator.
abstract void	updateStatus() Update the status information of the vector.
protected void	updateStatus(GUnit currentUnit, int fracDigits) Update the status information of the vector, comparing the values against the intervals.
void	write(org.jdom.Element parentElement) Write the vector to file.
protected abstract void	writeVector(org.jdom.Element e) Writes the elements of the vector to the file.

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, isModified, 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

GEntryVectorAbstract

public GEntryVectorAbstract(String name)

Constructor. The widget identifier is automatically assigned.

Parameters:

name - of the array used to group the values in the configuration file.

GEntryVectorAbstract

public GEntryVectorAbstract(String widgetId,
                            String name)

Constructor.

Parameters:

widgetId - widget identifier.

name - of the array used to group the values in the configuration file.

Method Detail

setDefaultConstraints

protected void setDefaultConstraints()

Set default constraints.

Overrides:

setDefaultConstraints in class GComponent

setWidgetId

public void setWidgetId(String widgetId)

Sets the widget identifier of the component.

Overrides:

setWidgetId in class GComponent

Parameters:

widgetId - the widget identifier of the component.

setNameInConfigFile

public final void setNameInConfigFile(String name)

Set the name of the vector in the configuration file.

Overrides:

setNameInConfigFile in class GComponent

Parameters:

name - of the vector in the configuration file.

getNameInConfigFile

public String getNameInConfigFile()

Get the name of the vector in the configuration file.

Overrides:

getNameInConfigFile in class GComponent

Returns:

the name of the vector in the configuration file.

getIntervalList

protected GIntervalList getIntervalList()

Get the interval list. The list can be consulted but shall not be modified.

Returns:

the interval list.

getValue

public Object getValue(int rank)

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

Parameters:

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

Returns:

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

getValueArray

public Object[] getValueArray()

Return the array of the values contained in the vector.

Returns:

the array of the values contained in the vector.

getGUnitMenu

public abstract GPopupList getGUnitMenu()

Get the unit menu widget.

Returns:

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

getUnitInConfig

protected GUnit getUnitInConfig()

Get the unit in configuration file.

Returns:

the unit in configuration file or null.

setValue

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

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

Parameters:

rank - of the value to update.

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

Throws:

GArithmeticException - in case the values in NaN.

setDefaultValue

public abstract void setDefaultValue(Object defaultValue)
                              throws GArithmeticException

Set the new default value.

Parameters:

defaultValue - new default value.

Throws:

GArithmeticException - if defaultValue is NaN.

setEnabled

public void setEnabled(boolean flag)

Description copied from class: GComponent

Set the enable status of the component.

Overrides:

setEnabled in class GComponent

Parameters:

flag - new enable status of the component.

isEnabled

public boolean isEnabled()

Description copied from class: GComponent

Gets the enable status of the widget.

Overrides:

isEnabled in class GComponent

Returns:

true if the component is enabled, false otherwise.

size

public int size()

Get the number of items in the vector.

Returns:

the number of items in the vector.

updateIntervalMessage

protected void updateIntervalMessage(GUnit currentUnit,
                                     GEnvironment.Format currentFormat)

Updates the interval message with units and format requested.

Parameters:

currentUnit - the current unit

currentFormat - the current format of field

handleEvent

public abstract boolean handleEvent(GEvent event)

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

Parameters:

event - to process.

Returns:

true if the event was processed, false otherwise.

getGComponent

public GComponent getGComponent(int rank)

Get the component corresponding to the specified rank.

Parameters:

rank - to get the GComponent.

Returns:

the GComponent corresponding to the rank.

getGNumberField

public GNumberFieldAbstract getGNumberField(int rank)

Get the GNumberFieldAbstract corresponding to the specified rank.

Parameters:

rank - to get the GNumberFieldAbstract.

Returns:

the GComponent corresponding to the rank.

getName

public String getName()

Return the name of the vector.

Overrides:

getName in class GComponent

Returns:

the name of the vector.

getGLabelWithIndicator

public GLabelWithIndicator getGLabelWithIndicator()

Return the GLabel associated with the vector.

Returns:

the GLabel associated with the vector.

add

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

Adds an item to the vector.

Parameters:

rank - of the new item.

value - of the new item.

Throws:

GArithmeticException - if value is NaN

GException - in case the value can not be parsed.

remove

public void remove(int rank)

Remove an element from the vector.

Parameters:

rank - of the element to remove.

removeAll

public abstract void removeAll()

Remove all the elements from the vector.

removeAllInternal

public void removeAllInternal()

Remove all the elements of the vector.

parseValue

protected abstract Object parseValue(String stringValue)
                              throws GException

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.

Parameters:

stringValue - string containing the value to be parsed.

Returns:

the Number corresponding to stringValue.

Throws:

GException - in case of error parsing the value.

setFieldValue

protected void setFieldValue(int rank,
                             Object objectValue)

Sets the value of a field in the vector but does not update the status of the vector. This method is intended to be used from the setValue method.

Parameters:

rank - of the value to update.

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

write

public void write(org.jdom.Element parentElement)
           throws GException

Write the vector to file.

Parameters:

parentElement - where the vector is written.

Throws:

GException - in case of problem writing the vector to file.

read

public void read(org.jdom.Element e)
          throws GException

Read the vector from file.

Parameters:

e - from where the vector is read.

Throws:

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

addGInterval

public void addGInterval(GIntervalAbstract interval)
                  throws GIntervalException

Adds an interval to the interval list and update the status of all the entries taking into account the new intervals.

Parameters:

interval - to add to the list.

Throws:

GIntervalException - in case the interval overlaps with an existing one.

updateGInterval

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

Update a validity interval of the field.

Parameters:

oldInterval - to update.

newInterval - to update newInterval.

Throws:

GIntervalException - in case oldInterval is not found in the list of intervals defined for the field.

removeGInterval

public void removeGInterval(GIntervalAbstract interval)

Remove a validity interval of the field.

Parameters:

interval - to be removed

setLabelConstraint

public void setLabelConstraint(GConstraint constraint)

Set the constraint of the label.

Parameters:

constraint - of the label.

getLabelConstraint

public GConstraint getLabelConstraint()

Get the constraint of the label.

Returns:

the constraint of the label.

setLabelAndUnitConstraint

public void setLabelAndUnitConstraint(GTable1D.TableOrientation orientation,
                                      int rank)

Set the label and unit constraints.

Parameters:

orientation - of the table using the vector.

rank - of the vector within the table.

setComponentConstraint

public void setComponentConstraint(GTable1D.TableOrientation orientation,
                                   int rank)

Set the components constraints.

Parameters:

orientation - of the table using the vector.

rank - of the vector within the table.

setToolTipText

public void setToolTipText(String text)

Set the tooltip text for the entry's label.

Overrides:

setToolTipText in class GComponent

Parameters:

text - the tooltip text for the entry's label.

addItem

protected void addItem(int rank,
                       GNumberFieldAbstract field,
                       Object value)

Adds a new element to the vector.

Parameters:

rank - where the element shall be added.

field - the field to use for the element.

value - to assign to the new element.

writeVector

protected abstract void writeVector(org.jdom.Element e)
                             throws GException

Writes the elements of the vector to the file.

Parameters:

e - where the values are stored.

Throws:

GException - in case of problem writing the vector to file.

See Also:

readVector(Element, String).

readVector

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

Reads the elements of the vector from file.

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 - in case of problem reading the vector from file.

See Also:

writeVector(Element).

updateIsModifiedIndicator

protected void updateIsModifiedIndicator()

Updates the is modified indicator.

Overrides:

updateIsModifiedIndicator in class GComponent

updateStatus

public abstract void updateStatus()

Update the status information of the vector.

updateStatus

protected void updateStatus(GUnit currentUnit,
                            int fracDigits)

Update the status information of the vector, comparing the values against the intervals.

Parameters:

currentUnit - the current unit of the field.

fracDigits - the number of fract digits of the field.

getSubComponent

public GComponent getSubComponent(int position)
                           throws GComponentException

Gets the subcomponent occupying the position defined by position.

Overrides:

getSubComponent in class GComponent

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.

setSavedValue

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

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

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