com.highqsoft.odsx

Class OdsxPresentableElement

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

All Implemented Interfaces:

FwkColumnAccessInterface, FwkColumnDataObserverInterface, FwkCompareInterface, FwkControllerInterface, FwkDescriptionInterface, FwkInfoBusDataAccessInterface, FwkInfoBusImmediateAccessInterface, FwkInfoBusItemGroupInterface, FwkInstructionInterface, FwkInterface, FwkItemInterface, FwkPersistenceInterface, FwkPresentationInterface, FwkPropertyChangeInterface, FwkTransferableInterface, FwkVetoableChangeInterface, 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:

OdsxApplicationElement, OdsxInstanceElement, OdsxSessionElement

public abstract class OdsxPresentableElement
extends FwkColumnAccess
implements OdsxPresentableElementInterface, OdsxChangeListenerInterface

The OdsxPresentableElement is the implementation of the OdsxPresentableElementInterface

Property Keyword	Datatype	Default	Description
OdsxATFFilter.Text.Create	String	OdsxATFFilter.Text.Create	Command text for the command that dumps to ATF.
OdsxPresentableElement.Command.Classes	colon seperated list of classnames.	null	Additional commands for each element. Each command can throw a RuntimeException if the element should not have the command. It is possible to define a constructor that receives directly the presentable element as controller. s.a. OdsxDumpMeasurementCommand

Since:

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

Version:

$Revision: 1.16 $

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 java.util.HashMap	beQueries The map to store the base element queries.
protected java.awt.Color	color The display color of the object.
java.awt.Color	DEFAULT_COLOR The default color.
protected java.lang.Object	defaultObject The default object to be administrated.
protected OdsxFilterInterface	odsFilter The selector filter.
protected static java.lang.String	SEPARATOR
protected java.lang.Object	value The value object
static java.lang.String	version The revision number.

Fields inherited from class com.highqsoft.fwk.FwkColumnAccess

average, averageIsValid, columnName, CONSIDER_FLAGS, DESCRIPTION_COLUMN_NAME, icon, lower, minPositiveValue, observer, producer, range_lock, rangeIsValid, shortName, 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	OdsxPresentableElement() The constructor.
protected	OdsxPresentableElement(java.lang.String value) The constructor receiving a string object.

Method Summary

Methods

Modifier and Type	Method and Description
void	delete(boolean flag) Delete the element.
protected void	finalize()
java.lang.String	getBaseName() Get the base type identifier.
FwkCommandInterface[]	getCommands() Retrieve the command array.
int[]	getDimensions() Get the dimension of the item.
java.util.Vector<OdsxPresentableElementInterface>	getElements() Get the child elements of this element.
FwkIconInterface	getIcon() Return the icon of the column.
java.lang.String	getIdentificationString() Get the identification of the element.
java.lang.Object	getItemByCoordinates(int[] coord) Get the value by coordinates.
java.lang.String	getODSVersion() Get the ODS version of the element
OdsxFilterInterface	getOdsxFilter() Retrieve the filter of this element.
java.lang.String	getPresentationString() Retrieves the representation string.
java.lang.String	getPresentationString(java.util.Locale l) Retrieves the representation string.
java.lang.String	getPresentationString(java.util.Locale locale, OdsxFilterInterface filter) Return the string representation of an application element.
void	getPresentationString(java.io.Writer w, java.lang.String spec, java.util.Locale l, OdsxFilterInterface f) Print out the presentation into a writer.
java.util.Vector<OdsxPresentableElementInterface>	getRelatedElements() Get the related elements of this element.
ApplicationRelation[]	getRelations() Get the relation type to the given element.
ApplicationRelation[]	getRelations(OdsxPresentableElementInterface elem) Get the relation type to the given element.
AoSession	getSession() Get the root object of the element.
java.lang.String	getShortName(int length) Retrieves a short name from element.
java.lang.Object	getValueAsObject() Get the value as object.
java.lang.String	getValueAsString() Get the vale as string.
java.lang.String	getVersion() Return the version string of the FWK component.
boolean	isTheSame(OdsxPresentableElementInterface elem) Return a boolean whether the given element is the element as the incoming one.
boolean	matchBaseElement(java.lang.String baseElementName) Ask for base element instance.
void	odsChanged(OdsxChangeEventInterface event) Invoked when ods change.
void	release() Release the item.
void	setItemByCoordinates(int[] coord, java.lang.Object item) Set a new value at the specified coordinate.
void	setOdsxFilter(OdsxFilterInterface odsFilter) Set the filter of this element.
void	setValueAsObject(java.lang.Object value) Set the value of the item.
javax.infobus.ArrayAccess	subdivide(int[] start, int[] end) Subdivide the array.
java.lang.String	toString() Get the string presentation of the presentable.
boolean	valueIsA(java.lang.Class clazz) Return a boolean whether the value is a subclass of the given class.

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

getShortName, isValid

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

Methods inherited from interface javax.infobus.ImmediateAccess

setValue

Methods inherited from interface javax.infobus.DataItemChangeManager

addDataItemChangeListener, removeDataItemChangeListener

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.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

SEPARATOR

protected static final java.lang.String SEPARATOR

See Also:

Constant Field Values

DEFAULT_COLOR

public final java.awt.Color DEFAULT_COLOR

The default color.

version

public static final java.lang.String version

The revision number.

See Also:

Constant Field Values

defaultObject

protected java.lang.Object defaultObject

The default object to be administrated.

value

protected java.lang.Object value

The value object

odsFilter

protected OdsxFilterInterface odsFilter

The selector filter.

color

protected java.awt.Color color

The display color of the object.

beQueries

protected java.util.HashMap beQueries

The map to store the base element queries.

Constructor Detail

OdsxPresentableElement

protected OdsxPresentableElement()

The constructor.

OdsxPresentableElement

protected OdsxPresentableElement(java.lang.String value)

The constructor receiving a string object.

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 FwkColumnAccess

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

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

Parameters:

elem - The element to be compared to

Returns:

true if this element is the same as the incoming.

setOdsxFilter

public void setOdsxFilter(OdsxFilterInterface odsFilter)

Set the filter of this element.

Specified by:

setOdsxFilter in interface OdsxPresentableElementInterface

Parameters:

odsFilter - the filter.

getOdsxFilter

public OdsxFilterInterface getOdsxFilter()

Retrieve the filter of this element.

Specified by:

getOdsxFilter in interface OdsxPresentableElementInterface

Returns:

the filter.

getBaseName

public java.lang.String getBaseName()

Get the base type identifier.

Specified by:

getBaseName in interface OdsxPresentableElementInterface

Returns:

The base type string.

getIcon

public FwkIconInterface getIcon()

Return the icon of the column.

Specified by:

getIcon in interface FwkDescriptionInterface

Overrides:

getIcon in class FwkPersistence

Returns:

The icon of the application.

See Also:

FwkPersistence.setIcon(FwkIconInterface)

getValueAsString

public java.lang.String getValueAsString()

Get the vale as string.

Specified by:

getValueAsString in interface javax.infobus.ImmediateAccess

Overrides:

getValueAsString in class FwkColumnAccess

Returns:

The string value of the item.

getItemByCoordinates

public java.lang.Object getItemByCoordinates(int[] coord)

Get the value by coordinates.

Specified by:

getItemByCoordinates in interface javax.infobus.ArrayAccess

Overrides:

getItemByCoordinates in class FwkColumnAccess

Parameters:

coord - The coordinates of the values to be returned.

Returns:

The value object.

getDimensions

public int[] getDimensions()

Get the dimension of the item.

Specified by:

getDimensions in interface javax.infobus.ArrayAccess

Overrides:

getDimensions in class FwkColumnAccess

Returns:

an integer array containing the dimension of the data item.

subdivide

public javax.infobus.ArrayAccess subdivide(int[] start,
                                  int[] end)

Subdivide the array.

Specified by:

subdivide in interface javax.infobus.ArrayAccess

Overrides:

subdivide in class FwkColumnAccess

Parameters:

start - The starting coordinates.

end - The starting coordinates.

Returns:

The sub array.

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 FwkColumnAccess

Parameters:

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

value - The new value.

Throws:

FwkException

setValueAsObject

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

Set the value of the item.

Specified by:

setValueAsObject in interface OdsxPresentableElementInterface

Parameters:

value - the new value.

Throws:

FwkException

getValueAsObject

public java.lang.Object getValueAsObject()

Get the value as object.

Specified by:

getValueAsObject in interface OdsxPresentableElementInterface

Specified by:

getValueAsObject in interface javax.infobus.ImmediateAccess

Overrides:

getValueAsObject in class FwkColumnAccess

Returns:

The value object.

getPresentationString

public java.lang.String getPresentationString()

Retrieves the representation string.

Specified by:

getPresentationString in interface FwkDescriptionInterface

Specified by:

getPresentationString in interface FwkPresentationInterface

Overrides:

getPresentationString in class FwkDescription

Returns:

The presentation string.

getPresentationString

public java.lang.String getPresentationString(java.util.Locale l)

Retrieves the representation string. Currently it returns the name.

Specified by:

getPresentationString in interface FwkDescriptionInterface

Specified by:

getPresentationString in interface FwkPresentationInterface

Specified by:

getPresentationString in interface javax.infobus.ImmediateAccess

Overrides:

getPresentationString in class FwkColumnAccess

Parameters:

l - The Locale object or null.

f - An ODSFilterInterface object.

Returns:

The presentation string.

getPresentationString

public java.lang.String getPresentationString(java.util.Locale locale,
                                     OdsxFilterInterface filter)

Return the string representation of an application element.

Specified by:

getPresentationString in interface OdsxPresentableElementInterface

Parameters:

ae - The application element to be added.

locale - The locale.

Returns:

The presentation string.

getODSVersion

public java.lang.String getODSVersion()

Get the ODS version of the element

Specified by:

getODSVersion in interface OdsxPresentableElementInterface

Returns:

the ods version of the element.

toString

public java.lang.String toString()

Get the string presentation of the presentable.

Overrides:

toString in class FwkColumnAccess

Returns:

The presentation string.

getPresentationString

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

Print out the presentation into a writer.

Specified by:

getPresentationString in interface OdsxPresentableElementInterface

Parameters:

w - The writer.

spec - This string allows the caller to specify the kind of output. This implementation does not pay attention on this value. Overwrite this method to evaluate it.

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

Returns:

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

getRelatedElements

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

Get the related elements of this element.

Specified by:

getRelatedElements in interface OdsxPresentableElementInterface

Returns:

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

getRelations

public ApplicationRelation[] getRelations()

Get the relation type to the given element.

Specified by:

getRelations in interface OdsxPresentableElementInterface

Returns:

the relation type.

getSession

public AoSession getSession()

Get the root object of the element.

Specified by:

getSession in interface OdsxPresentableElementInterface

Returns:

the session belongs to the element.

getRelations

public ApplicationRelation[] getRelations(OdsxPresentableElementInterface elem)

Get the relation type to the given element.

Specified by:

getRelations in interface OdsxPresentableElementInterface

Parameters:

elem - The element to that the relation should be determined.

Returns:

the relation type.

getShortName

public java.lang.String getShortName(int length)

Retrieves a short name from element.

Specified by:

getShortName in interface OdsxPresentableElementInterface

Parameters:

length - the maximum length of the name.

Returns:

The short name of the element.

getIdentificationString

public java.lang.String getIdentificationString()

Get the identification of the element.

Specified by:

getIdentificationString in interface OdsxPresentableElementInterface

Returns:

the identification string

getCommands

public FwkCommandInterface[] getCommands()

Retrieve the command array.

Specified by:

getCommands in interface FwkInstructionInterface

Overrides:

getCommands in class FwkPersistence

Returns:

The array containing the commands.

delete

public void delete(boolean flag)

Delete the element.

Specified by:

delete in interface OdsxPresentableElementInterface

Parameters:

flag - true if the element should be deleted with references.

matchBaseElement

public boolean matchBaseElement(java.lang.String baseElementName)

Ask for base element instance.

Specified by:

matchBaseElement in interface OdsxPresentableElementInterface

Returns:

true if the element is an instance of the base element with the given name.

valueIsA

public boolean valueIsA(java.lang.Class clazz)

Return a boolean whether the value is a subclass of the given class.

Specified by:

valueIsA in interface OdsxPresentableElementInterface

Parameters:

clazz - The class to be implemented by the value.

release

public void release()

Release the item.

Specified by:

release in interface FwkColumnDataObserverInterface

Specified by:

release in interface FwkInterface

Specified by:

release in interface javax.infobus.DataItem

Overrides:

release in class FwkColumnAccess

odsChanged

public void odsChanged(OdsxChangeEventInterface event)

Invoked when ods change.

Specified by:

odsChanged in interface OdsxChangeListenerInterface

Parameters:

event - the change event.