com.highqsoft.odsx

Class OdsxApplicationElement

java.lang.Object

com.highqsoft.fwk.Fwk

com.highqsoft.fwk.FwkDescription

com.highqsoft.fwk.FwkPropertyChange

com.highqsoft.fwk.FwkPersistence

com.highqsoft.fwk.FwkItem

com.highqsoft.fwk.FwkInfoBusImmediateAccess

com.highqsoft.fwk.FwkInfoBusDataAccess

com.highqsoft.fwk.FwkColumnAccess

com.highqsoft.odsx.OdsxPresentableElement

com.highqsoft.odsx.OdsxApplicationElement

All Implemented Interfaces:

FwkColumnAccessInterface, FwkColumnDataObserverInterface, FwkCompareInterface, FwkControllerInterface, FwkDescriptionInterface, FwkInfoBusDataAccessInterface, FwkInfoBusImmediateAccessInterface, FwkInfoBusItemGroupInterface, FwkInstructionInterface, FwkInterface, FwkItemInterface, FwkPersistenceInterface, FwkPresentationInterface, FwkPropertyChangeInterface, FwkTransferableInterface, FwkVetoableChangeInterface, OdsxApplicationElementInterface, OdsxChangeListenerInterface, OdsxPresentableElementInterface, java.awt.datatransfer.ClipboardOwner, java.awt.datatransfer.Transferable, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable, java.util.EventListener, javax.infobus.ArrayAccess, javax.infobus.DataItem, javax.infobus.DataItemChangeManager, javax.infobus.ImmediateAccess

Direct Known Subclasses:

OdsxRecursiveApplicationElement

public class OdsxApplicationElement
extends OdsxPresentableElement
implements OdsxApplicationElementInterface

The OdsxApplicationElement is the implementation of the OdsxApplicationElementInterface The following table lists the plugin interfaces supported by this class.

Interface	Description
OdsxApplElemMenuInterface	Classes that implements that interface controls the whole menu of the application element.
OdsxApplElemCustomizerInterface	Classes that implements that interface will be integrated as an part of the existing menu.
OdsxApplElemChildrenSelectorInterface	Classes that implements that interface will be integrated as a selector to the tree children list..

Since:

$Date: 2017/04/06 13:29:48 $

Version:

$Revision: 1.30 $

Author:

Andreas Hofmann

See Also:

, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.highqsoft.fwk.FwkColumnAccess

FwkColumnAccess.FwkSubColumnAccess

Nested classes/interfaces inherited from class com.highqsoft.fwk.FwkInfoBusImmediateAccess

FwkInfoBusImmediateAccess.ElementConsumer

Field Summary

Fields

Modifier and Type	Field and Description
protected T_LONGLONG	aeId
protected OdsxApplElemChildrenSelectorInterface	childrenSelector
protected static FwkDescriptionInterface	descriptor
protected boolean	hasSelfRef
protected boolean	hasSelfRefInitialized
protected java.lang.String	ident
protected java.lang.String	shortName
static java.lang.String	version

Fields inherited from class com.highqsoft.odsx.OdsxPresentableElement

beQueries, color, DEFAULT_COLOR, defaultObject, odsFilter, SEPARATOR, value

Fields inherited from class com.highqsoft.fwk.FwkColumnAccess

average, averageIsValid, columnName, CONSIDER_FLAGS, DESCRIPTION_COLUMN_NAME, icon, lower, minPositiveValue, observer, producer, range_lock, rangeIsValid, standardDeviation, standardDeviationIsValid, unit, upper

Fields inherited from class com.highqsoft.fwk.FwkInfoBusImmediateAccess

children, properties, valid

Fields inherited from class com.highqsoft.fwk.FwkItem

changeManager, suspendChangeManager

Fields inherited from class com.highqsoft.fwk.FwkPropertyChange

source

Fields inherited from class com.highqsoft.fwk.FwkDescription

author, buildnr, className, company, copyright, creationDate, dateFormatString, description, eMail, FWK_ICON, FWK_ICON_ARRAY, FWK_ICON_BG, FWK_ICON_BG_ARRAY, FWK_ICON_BG_LARGE, FWK_ICON_BG_LARGE_ARRAY, FWK_ICON_LARGE, FWK_ICON_LARGE_ARRAY, ICON, iconCount, iconKey, internetAddress, name, titleName

Fields inherited from interface com.highqsoft.interfaces.fwk.FwkDescriptionInterface

AUTHOR, BUILDNR, COMPANY, COPYRIGHT, DATE_FORMAT, DEFAULT_ICON, DESCRIPTION, INTERNET, LARGE_ICON, LARGE_KEY_EXT, LARGE_OPAQUE_ICON, LARGE_OPAQUE_KEY_EXT, OPAQUE_ICON, OPAQUE_KEY_EXT, RCS_DATE_FORMAT, SUPPORT_EMAIL, TITLE_NAME

Fields inherited from interface com.highqsoft.interfaces.fwk.FwkColumnAccessInterface

DATAARRAY_KEY, DEFINED_BIT, INVALID, NOT_MODIFIED_BIT, VALID, VALID_BIT, VISIBLE_BIT

Fields inherited from interface com.highqsoft.interfaces.fwk.FwkItemInterface

INFOBUS_SOURCE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OdsxApplicationElement() The constructor.
	OdsxApplicationElement(ApplicationElement ae) The constructor receiving the application element.

Method Summary

Methods

Modifier and Type	Method and Description
ApplicationElement	getApplicationElement() Get the ApplicationElement.
T_LONGLONG	getApplicationElementId() Get the application element id.
java.lang.String	getBaseName() Get the base type identifier.
FwkCommandInterface[]	getCommands() Retrieve the command array.
static FwkDescriptionInterface	getDescriptor()
java.util.Vector<OdsxPresentableElementInterface>	getElements() Get the child elements of this element.
java.lang.String	getIdentificationString() Get the identification string of the element.
void	getPresentationString(java.io.Writer w, java.lang.String spec, java.util.Locale locale, OdsxFilterInterface filter) Print out the presentation into a writer.
java.util.Vector<OdsxPresentableElementInterface>	getRelatedElements() Get the related elements of this element.
java.lang.String	getShortName() Get the short name of the element.
boolean	getTopLevelElement() Get the top level element flag.
java.lang.String	getVersion() Return the version string of the FWK component.
boolean	hasSelfReference() Return a boolean whether the elements ahs a self reference.
boolean	isTheSame(ApplicationElement aeElem) Return a boolean whether the given ApplicationElement is equal to this one.
boolean	isTheSame(OdsxPresentableElementInterface elem) Return a boolean whether the given element is the element as the incoming one.
boolean	isValid() Return a boolean wether the element is already valid.
void	setItemByCoordinates(int[] coord, java.lang.Object item) Set a new value at the specified coordinate.
void	setTopLevelElement(boolean flag) Set the application as a top level element.
void	setValueAsObject(java.lang.Object item) Set the value of the item.

Methods inherited from class com.highqsoft.odsx.OdsxPresentableElement

delete, finalize, getDimensions, getIcon, getItemByCoordinates, getODSVersion, getOdsxFilter, getPresentationString, getPresentationString, getPresentationString, getRelations, getRelations, getSession, getShortName, getValueAsObject, getValueAsString, matchBaseElement, odsChanged, release, setOdsxFilter, subdivide, toString, valueIsA

Methods inherited from class com.highqsoft.fwk.FwkColumnAccess

createEmptyColumn, dependsOn, determineRange, getAverage, getAverageFlag, getColumnName, getCommands, getCount, getFlagAt, getFlags, getIndex, getIndexRange, getMaximum, getMinimum, getMinPositiveValue, getNativeDatatype, getNativeValues, getNativeValues, getProperty, getScale, getStandardDeviation, getStandardDeviationFlag, getTransferData, getTransferDataFlavors, getUnitString, getValueAt, getValues, independentColumns, isDataFlavorSupported, isImplicit, isIndependent, main, reshape, setColumnName, setFlagAt, setFlags, setIndependent, setItemByCoordinates, setItemByCoordinates, setItemByCoordinates, setItemByCoordinates, setItemByCoordinates, setItemByCoordinates, setName, setScale, setValue, setValueAt

Methods inherited from class com.highqsoft.fwk.FwkInfoBusImmediateAccess

addChild, addChildListener, containsChild, fireChildAdded, fireChildRemoved, getAllChildren, getAllChildren, getChildren, getChildren, getChildrenCount, hasChildren, hasValidValues, isGroup, removeAllChildren, removeChild, removeChild, removeChildListener, setChildren, setProperty, setValidValues

Methods inherited from class com.highqsoft.fwk.FwkItem

addDataItemChangeListener, fireItemAdded, fireItemDeleted, fireItemRevoked, fireItemValueChanged, getName, getPropertyGroup, getSource, isChangeManagerSuspended, removeDataItemChangeListener, setPropertyGroup, suspendChangeManager

Methods inherited from class com.highqsoft.fwk.FwkPersistence

addCommand, addCommand, addToGroup, addToGroup, addVetoableChangeListener, addVetoableChangeListener, clearCommands, commandsAvailable, compareTo, deleteGroup, destroyController, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, getAuthor, getBuild, getCommand, getCompany, getCompanyInternetAddress, getCopyright, getCreationDate, getCreationDate, getDateFormatString, getDescription, getFwkMimeTypes, getGroup, getIcon, getIconKey, getIconKey, getPersistentObjectNames, getSupportEMail, getTitle, getTitleName, getVetoableChangeArray, getVetoableChangeListenerArray, getVetoableChangeListenerArray, groupExists, removeCommand, removeFromGroup, removeVetoableChangeListener, removeVetoableChangeListener, setAuthor, setBuild, setCommands, setCompany, setCompanyInternetAddress, setCopyright, setCreationDate, setDateFormatString, setDescription, setDescriptor, setDescriptor, setIcon, setIcon, setIconKey, setIconKey, setSource, setSupportEMail, setTitleName

Methods inherited from class com.highqsoft.fwk.FwkPropertyChange

addPropertyChangeListener, addPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getPropertyChangeArray, getPropertyChangeListenerArray, getPropertyChangeListenerArray, isPropertyChangeEventSuspended, removePropertyChangeListener, removePropertyChangeListener, suspendPropertyChangeEvents

Methods inherited from class com.highqsoft.fwk.FwkDescription

getClassName, getPresentationString, lostOwnership, setClassName, setCreationDate

Methods inherited from class com.highqsoft.fwk.Fwk

getNiceVersion

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.highqsoft.interfaces.odsx.OdsxPresentableElementInterface

delete, getODSVersion, getOdsxFilter, getPresentationString, getRelations, getRelations, getSession, getShortName, getValueAsObject, matchBaseElement, setOdsxFilter, valueIsA

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkInfoBusImmediateAccessInterface

getName, hasValidValues, isGroup, setProperty, setValidValues

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkDescriptionInterface

getAuthor, getBuild, getClassName, getCompany, getCompanyInternetAddress, getCopyright, getCreationDate, getCreationDate, getDateFormatString, getDescription, getIcon, getIcon, getIconKey, getIconKey, getPresentationString, getPresentationString, getSupportEMail, getTitle, getTitleName, setAuthor, setBuild, setClassName, setCompany, setCompanyInternetAddress, setCopyright, setCreationDate, setCreationDate, setDateFormatString, setDescription, setDescriptor, setIcon, setIcon, setIconKey, setIconKey, setName, setSupportEMail, setTitleName

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkInterface

release

Methods inherited from interface java.awt.datatransfer.Transferable

getTransferData, getTransferDataFlavors, isDataFlavorSupported

Methods inherited from interface java.awt.datatransfer.ClipboardOwner

lostOwnership

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkInfoBusItemGroupInterface

addChild, addChildListener, containsChild, getAllChildren, getAllChildren, getChildren, getChildren, getChildrenCount, hasChildren, removeAllChildren, removeChild, removeChild, removeChildListener, setChildren

Methods inherited from interface javax.infobus.DataItem

getProperty, getSource, release

Methods inherited from interface javax.infobus.ImmediateAccess

getPresentationString, getValueAsString, setValue

Methods inherited from interface javax.infobus.DataItemChangeManager

addDataItemChangeListener, removeDataItemChangeListener

Methods inherited from interface javax.infobus.ArrayAccess

getDimensions, getItemByCoordinates, subdivide

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkPropertyChangeInterface

addPropertyChangeListener, addPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getPropertyChangeArray, getPropertyChangeListenerArray, getPropertyChangeListenerArray, isPropertyChangeEventSuspended, removePropertyChangeListener, removePropertyChangeListener, setSource, suspendPropertyChangeEvents

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkInstructionInterface

addCommand, addCommand, addToGroup, addToGroup, clearCommands, commandsAvailable, deleteGroup, getCommand, getGroup, groupExists, removeCommand, removeFromGroup, setCommands

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkPresentationInterface

getPresentationString, getPresentationString

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkColumnDataObserverInterface

isChangeManagerSuspended, suspendChangeManager

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkPersistenceInterface

getPersistentObjectNames

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkControllerInterface

destroyController

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkVetoableChangeInterface

addVetoableChangeListener, addVetoableChangeListener, getVetoableChangeArray, getVetoableChangeListenerArray, getVetoableChangeListenerArray, removeVetoableChangeListener, removeVetoableChangeListener

Field Detail

version

public static final java.lang.String version

See Also:

Constant Field Values

childrenSelector

protected OdsxApplElemChildrenSelectorInterface childrenSelector

ident

protected java.lang.String ident

shortName

protected java.lang.String shortName

aeId

protected T_LONGLONG aeId

hasSelfRef

protected boolean hasSelfRef

hasSelfRefInitialized

protected boolean hasSelfRefInitialized

descriptor

protected static final FwkDescriptionInterface descriptor

Constructor Detail

OdsxApplicationElement

protected OdsxApplicationElement()

The constructor.

OdsxApplicationElement

public OdsxApplicationElement(ApplicationElement ae)

The constructor receiving the application element.

Parameters:

ae - The application element.

Method Detail

getVersion

public java.lang.String getVersion()

Description copied from interface: FwkInterface

Return the version string of the FWK component.

Specified by:

getVersion in interface FwkInterface

Overrides:

getVersion in class OdsxPresentableElement

getDescriptor

public static FwkDescriptionInterface getDescriptor()

isValid

public boolean isValid()

Return a boolean wether the element is already valid.

Specified by:

isValid in interface OdsxPresentableElementInterface

Returns:

true if valid

isTheSame

public boolean isTheSame(ApplicationElement aeElem)

Return a boolean whether the given ApplicationElement is equal to this one.

Specified by:

isTheSame in interface OdsxApplicationElementInterface

Parameters:

aeElem - The ApplicationElement

Returns:

true if the given ApplicationElement is equal to the inner one.

isTheSame

public boolean isTheSame(OdsxPresentableElementInterface elem)

Return a boolean whether the given element is the element as the incoming one.

Specified by:

isTheSame in interface OdsxPresentableElementInterface

Overrides:

isTheSame in class OdsxPresentableElement

Parameters:

elem - The element to be compared to

Returns:

true if this element is the same as the incoming.

getApplicationElementId

public T_LONGLONG getApplicationElementId()

Get the application element id.

Specified by:

getApplicationElementId in interface OdsxApplicationElementInterface

Returns:

the application element id.

getCommands

public FwkCommandInterface[] getCommands()

Retrieve the command array.

Specified by:

getCommands in interface FwkInstructionInterface

Overrides:

getCommands in class OdsxPresentableElement

Returns:

The array containing the commands.

hasSelfReference

public boolean hasSelfReference()
                         throws AoException

Return a boolean whether the elements ahs a self reference.

Returns:

true if the element a self reference.

Throws:

AoException

getApplicationElement

public ApplicationElement getApplicationElement()

Get the ApplicationElement.

Specified by:

getApplicationElement in interface OdsxApplicationElementInterface

Returns:

the ASAM-ODS ApplicationElement.

getBaseName

public java.lang.String getBaseName()

Get the base type identifier.

Specified by:

getBaseName in interface OdsxPresentableElementInterface

Overrides:

getBaseName in class OdsxPresentableElement

Returns:

The base type string.

setItemByCoordinates

public void setItemByCoordinates(int[] coord,
                        java.lang.Object item)
                          throws FwkException

Set a new value at the specified coordinate.

Specified by:

setItemByCoordinates in interface javax.infobus.ArrayAccess

Overrides:

setItemByCoordinates in class OdsxPresentableElement

Parameters:

coord - The coordinates where the new value should be placed.

value - The new value.

Throws:

FwkException

setValueAsObject

public void setValueAsObject(java.lang.Object item)
                      throws FwkException

Set the value of the item.

Specified by:

setValueAsObject in interface OdsxPresentableElementInterface

Overrides:

setValueAsObject in class OdsxPresentableElement

Parameters:

item - the new value.

Throws:

FwkException

getPresentationString

public void getPresentationString(java.io.Writer w,
                         java.lang.String spec,
                         java.util.Locale locale,
                         OdsxFilterInterface filter)
                           throws java.io.IOException

Print out the presentation into a writer.

Specified by:

getPresentationString in interface OdsxPresentableElementInterface

Overrides:

getPresentationString in class OdsxPresentableElement

Parameters:

w - The writer.

spec - This string allows the caller to specify the kind of output. Currently there are to values allowed All or Header Only. The All keyword is the default. If the keyword Header Only is specify it will print out no values and flags.

l - The Locale object or null.

f - An ODSFilterInterface object.

Throws:

java.io.IOException

getElements

public java.util.Vector<OdsxPresentableElementInterface> getElements()

Get the child elements of this element.

Specified by:

getElements in interface OdsxPresentableElementInterface

Overrides:

getElements in class OdsxPresentableElement

Returns:

an array containing the child elements, that are implement OdsxPresentableElementInterface. if there are no children the method returns null.

setTopLevelElement

public void setTopLevelElement(boolean flag)

Set the application as a top level element.

Specified by:

setTopLevelElement in interface OdsxApplicationElementInterface

Parameters:

flag - if true the application element must be a top level element.

getTopLevelElement

public boolean getTopLevelElement()

Get the top level element flag.

Specified by:

getTopLevelElement in interface OdsxApplicationElementInterface

Returns:

true if the element is marked as top level element.

getRelatedElements

public java.util.Vector<OdsxPresentableElementInterface> getRelatedElements()

Get the related elements of this element.

Specified by:

getRelatedElements in interface OdsxPresentableElementInterface

Overrides:

getRelatedElements in class OdsxPresentableElement

Returns:

an array containing the related elements, that are implement OdsxPresentableElementInterface if there are no elements the method returns null.

getShortName

public java.lang.String getShortName()

Get the short name of the element.

Specified by:

getShortName in interface FwkColumnAccessInterface

Specified by:

getShortName in interface OdsxPresentableElementInterface

Overrides:

getShortName in class FwkColumnAccess

Returns:

the short name

getIdentificationString

public java.lang.String getIdentificationString()

Get the identification string of the element.

Specified by:

getIdentificationString in interface OdsxPresentableElementInterface

Overrides:

getIdentificationString in class OdsxPresentableElement

Returns:

the identification