public class OdsxInstanceElement extends OdsxPresentableElement implements OdsxInstanceElementInterface
| Interface | Description |
|---|---|
| OdsxInstElemMenuInterface | Classes that implements that interface controls the whole menu of the instance element. |
| OdsxInstElemCustomizerInterface | Classes that implements that interface will be integrated as an part of the existing menu. |
| OdsxInstElemChildrenSelectorInterface | Classes that implements that interface will be integrated as a selector to the tree children list.. |
,
Serialized FormFwkColumnAccess.FwkSubColumnAccessFwkInfoBusImmediateAccess.ElementConsumer| Modifier and Type | Field and Description |
|---|---|
protected T_LONGLONG |
aeId |
protected ApplicationElement |
aeObj |
protected java.lang.String |
asamPath |
protected java.lang.String |
baseName |
protected OdsxInstElemChildrenSelectorInterface |
childrenSelector |
protected static FwkDescriptionInterface |
descriptor |
protected java.lang.String |
odsVersion |
static java.lang.String |
version |
beQueries, color, DEFAULT_COLOR, defaultObject, odsFilter, SEPARATOR, valueaverage, averageIsValid, columnName, CONSIDER_FLAGS, DESCRIPTION_COLUMN_NAME, icon, lower, minPositiveValue, observer, producer, range_lock, rangeIsValid, shortName, standardDeviation, standardDeviationIsValid, unit, upperchildren, properties, validchangeManager, suspendChangeManagersourceauthor, 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, titleNameAUTHOR, 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_NAMEDATAARRAY_KEY, DEFINED_BIT, INVALID, NOT_MODIFIED_BIT, VALID, VALID_BIT, VISIBLE_BITINFOBUS_SOURCE| Modifier | Constructor and Description |
|---|---|
protected |
OdsxInstanceElement()
The constructor.
|
|
OdsxInstanceElement(InstanceElement ie)
The constructor receiving the instance element.
|
|
OdsxInstanceElement(InstanceElement ie,
ApplicationElement aeObj,
java.lang.String type,
java.lang.String version)
The constructor receiving the instance element.
|
|
OdsxInstanceElement(InstanceElement ie,
java.lang.String type)
The constructor receiving the instance element.
|
|
OdsxInstanceElement(T_LONGLONG id,
java.lang.String name,
AoSession aoSession,
ApplicationElement aeObj,
java.lang.String type,
java.lang.String version)
The constructor receiving the instance element.
|
|
OdsxInstanceElement(T_LONGLONG id,
java.lang.String name,
AoSession aoSession,
ApplicationElement aeObj,
T_LONGLONG aeId,
java.lang.String type,
java.lang.String version)
The constructor receiving the instance element.
|
| Modifier and Type | Method and Description |
|---|---|
void |
cloneInstanceElement()
Clone the instance
|
void |
delete(boolean flag)
Delete the instance
|
protected void |
determineName() |
protected void |
finalize()
Finalize the object.
|
ApplicationElement |
getApplicationElement()
Get the ApplicationElement.
|
T_LONGLONG |
getApplicationElementId()
Get the application element id.
|
ApplicationStructure |
getApplicationStructure()
Get the applicatoin Structure.
|
java.lang.String |
getBaseName()
Get the base type identifier.
|
java.lang.String |
getBuild()
Get the build number.
|
FwkCommandInterface[] |
getCommands()
Retrieve the command array.
|
java.lang.String |
getCreationDate()
Get the creation date.
|
static FwkDescriptionInterface |
getDescriptor() |
java.util.Vector |
getElements()
Get the children of this element.
|
java.lang.String |
getIdentificationString()
Get the identification string of the element.
|
InstanceElement |
getInstanceElement()
Get the InstanceElement.
|
T_LONGLONG |
getInstanceElementId()
Get the instance element id.
|
java.lang.String |
getInstanceElementName()
Get the instance element name.
|
java.lang.String |
getInstancePath(boolean flag)
Get the instance path of the element.
|
java.lang.String |
getODSVersion()
Get the ODS version 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 children of this element.
|
AoSession |
getSession()
Get the root object of the element.
|
java.lang.String |
getShortName()
Get the short name of the column
|
java.lang.String |
getShortName(int length)
Retrieves a short name from element.
|
java.lang.Object |
getValueAsObject()
Get the value as object.
|
java.lang.String |
getVersion()
Return the version string of the FWK component.
|
boolean |
isTheSame(InstanceElement ieElem)
Return a boolean whether the given InstanceElement 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 |
odsChanged(OdsxChangeEventInterface event)
Invoked when ods change.
|
void |
release()
Release the item.
|
void |
reload()
Reload data.
|
void |
setItemByCoordinates(int[] coord,
java.lang.Object item)
Set a new value at the specified coordinate.
|
void |
setValueAsObject(java.lang.Object item)
Set the value of the item.
|
void |
writeString(java.io.Writer w,
int i,
boolean val,
short[] flags,
short flagF,
short globalFlag,
int flagLen)
Writes out a boolean value including the header.
|
void |
writeString(java.io.Writer w,
int i,
byte val,
short[] flags,
short flagF,
short globalFlag,
int flagLen)
Writes out a byte value including the header.
|
void |
writeString(java.io.Writer w,
int i,
double val,
short[] flags,
short flagF,
short globalFlag,
int flagLen)
Writes out a double value including the header.
|
void |
writeString(java.io.Writer w,
int i,
float val,
short[] flags,
short flagF,
short globalFlag,
int flagLen)
Writes out a float value including the header.
|
void |
writeString(java.io.Writer w,
int i,
int val,
short[] flags,
short flagF,
short globalFlag,
int flagLen)
Writes out a integer value including the header.
|
void |
writeString(java.io.Writer w,
int i,
short[] flags,
short flagF,
short globalFlag,
int flagLen)
Writes out the data value header.
|
void |
writeString(java.io.Writer w,
int i,
short val,
short[] flags,
short flagF,
short globalFlag,
int flagLen)
Writes out a short value including the header.
|
void |
writeString(java.io.Writer w,
int i,
java.lang.String val,
short[] flags,
short flagF,
short globalFlag,
int flagLen)
Writes out a string value including the header.
|
void |
writeString(java.io.Writer w,
int i,
T_COMPLEX val,
short[] flags,
short flagF,
short globalFlag,
int flagLen)
Writes out a T_COMPLEX value including the header.
|
void |
writeString(java.io.Writer w,
int i,
T_DCOMPLEX val,
short[] flags,
short flagF,
short globalFlag,
int flagLen)
Writes out a T_DCOMPLEX value including the header.
|
void |
writeString(java.io.Writer w,
int i,
T_LONGLONG val,
short[] flags,
short flagF,
short globalFlag,
int flagLen)
Writes out a T_LONGLONG value including the header.
|
getDimensions, getIcon, getItemByCoordinates, getOdsxFilter, getPresentationString, getPresentationString, getPresentationString, getRelations, getRelations, getValueAsString, matchBaseElement, setOdsxFilter, subdivide, toString, valueIsAcreateEmptyColumn, 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, setValueAtaddChild, addChildListener, containsChild, fireChildAdded, fireChildRemoved, getAllChildren, getAllChildren, getChildren, getChildren, getChildrenCount, hasChildren, hasValidValues, isGroup, removeAllChildren, removeChild, removeChild, removeChildListener, setChildren, setProperty, setValidValuesaddDataItemChangeListener, fireItemAdded, fireItemDeleted, fireItemRevoked, fireItemValueChanged, getName, getPropertyGroup, getSource, isChangeManagerSuspended, removeDataItemChangeListener, setPropertyGroup, suspendChangeManageraddCommand, addCommand, addToGroup, addToGroup, addVetoableChangeListener, addVetoableChangeListener, clearCommands, commandsAvailable, compareTo, deleteGroup, destroyController, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, getAuthor, getCommand, getCompany, getCompanyInternetAddress, getCopyright, 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, setTitleNameaddPropertyChangeListener, addPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getPropertyChangeArray, getPropertyChangeListenerArray, getPropertyChangeListenerArray, isPropertyChangeEventSuspended, removePropertyChangeListener, removePropertyChangeListener, suspendPropertyChangeEventsgetClassName, getPresentationString, lostOwnership, setClassName, setCreationDategetNiceVersionclone, equals, getClass, hashCode, notify, notifyAll, wait, wait, waitgetOdsxFilter, getPresentationString, getRelations, getRelations, matchBaseElement, setOdsxFilter, valueIsAgetName, hasValidValues, isGroup, setProperty, setValidValuesgetAuthor, getClassName, getCompany, getCompanyInternetAddress, getCopyright, 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, setTitleNamegetTransferData, getTransferDataFlavors, isDataFlavorSupportedaddChild, addChildListener, containsChild, getAllChildren, getAllChildren, getChildren, getChildren, getChildrenCount, hasChildren, removeAllChildren, removeChild, removeChild, removeChildListener, setChildrengetPresentationString, getValueAsString, setValueaddDataItemChangeListener, removeDataItemChangeListenergetDimensions, getItemByCoordinates, subdivideaddPropertyChangeListener, addPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getPropertyChangeArray, getPropertyChangeListenerArray, getPropertyChangeListenerArray, isPropertyChangeEventSuspended, removePropertyChangeListener, removePropertyChangeListener, setSource, suspendPropertyChangeEventsaddCommand, addCommand, addToGroup, addToGroup, clearCommands, commandsAvailable, deleteGroup, getCommand, getGroup, groupExists, removeCommand, removeFromGroup, setCommandsgetPresentationString, getPresentationStringisChangeManagerSuspended, suspendChangeManagergetPersistentObjectNamesdestroyControlleraddVetoableChangeListener, addVetoableChangeListener, getVetoableChangeArray, getVetoableChangeListenerArray, getVetoableChangeListenerArray, removeVetoableChangeListener, removeVetoableChangeListenerpublic static final java.lang.String version
protected static final FwkDescriptionInterface descriptor
protected ApplicationElement aeObj
protected OdsxInstElemChildrenSelectorInterface childrenSelector
protected java.lang.String baseName
protected java.lang.String asamPath
protected T_LONGLONG aeId
protected java.lang.String odsVersion
protected OdsxInstanceElement()
public OdsxInstanceElement(InstanceElement ie) throws AoException
ie - The instance element.AoExceptionpublic OdsxInstanceElement(InstanceElement ie, java.lang.String type)
ie - The instance element.public OdsxInstanceElement(InstanceElement ie, ApplicationElement aeObj, java.lang.String type, java.lang.String version)
ie - The instance element.public OdsxInstanceElement(T_LONGLONG id, java.lang.String name, AoSession aoSession, ApplicationElement aeObj, java.lang.String type, java.lang.String version)
ie - The instance element.public OdsxInstanceElement(T_LONGLONG id, java.lang.String name, AoSession aoSession, ApplicationElement aeObj, T_LONGLONG aeId, java.lang.String type, java.lang.String version)
ie - The instance element.public java.lang.String getVersion()
FwkInterfacegetVersion in interface FwkInterfacegetVersion in class OdsxPresentableElementpublic static FwkDescriptionInterface getDescriptor()
protected void finalize()
throws java.lang.Throwable
finalize in class OdsxPresentableElementjava.lang.Throwablepublic void release()
release in interface FwkColumnDataObserverInterfacerelease in interface FwkInterfacerelease in interface javax.infobus.DataItemrelease in class OdsxPresentableElementprotected void determineName()
public java.lang.String getShortName(int length)
getShortName in interface OdsxPresentableElementInterfacegetShortName in class OdsxPresentableElementlength - the maximum length of the name.public java.lang.String getShortName()
FwkColumnAccessgetShortName in interface FwkColumnAccessInterfacegetShortName in interface OdsxPresentableElementInterfacegetShortName in class FwkColumnAccesspublic boolean isTheSame(InstanceElement ieElem)
isTheSame in interface OdsxInstanceElementInterfaceaeElem - The InstanceElementpublic boolean isValid()
isValid in interface OdsxPresentableElementInterfacepublic java.lang.String getODSVersion()
getODSVersion in interface OdsxPresentableElementInterfacegetODSVersion in class OdsxPresentableElementpublic boolean isTheSame(OdsxPresentableElementInterface elem)
isTheSame in interface OdsxPresentableElementInterfaceisTheSame in class OdsxPresentableElementelem - The element to be compared topublic ApplicationStructure getApplicationStructure()
public AoSession getSession()
getSession in interface OdsxPresentableElementInterfacegetSession in class OdsxPresentableElementpublic java.lang.Object getValueAsObject()
getValueAsObject in interface OdsxPresentableElementInterfacegetValueAsObject in interface javax.infobus.ImmediateAccessgetValueAsObject in class OdsxPresentableElementpublic InstanceElement getInstanceElement()
getInstanceElement in interface OdsxInstanceElementInterfacepublic java.util.Vector<OdsxPresentableElementInterface> getRelatedElements()
getRelatedElements in interface OdsxPresentableElementInterfacegetRelatedElements in class OdsxPresentableElementpublic java.lang.String getBaseName()
getBaseName in interface OdsxPresentableElementInterfacegetBaseName in class OdsxPresentableElementpublic void setItemByCoordinates(int[] coord,
java.lang.Object item)
throws FwkException
setItemByCoordinates in interface javax.infobus.ArrayAccesssetItemByCoordinates in class OdsxPresentableElementcoord - The coordinates where the new value should be placed.value - The new value.FwkExceptionpublic void setValueAsObject(java.lang.Object item)
throws FwkException
setValueAsObject in interface OdsxPresentableElementInterfacesetValueAsObject in class OdsxPresentableElementitem - the new value.FwkExceptionpublic void writeString(java.io.Writer w,
int i,
short[] flags,
short flagF,
short globalFlag,
int flagLen)
throws java.lang.Exception
java.lang.Exceptionpublic void writeString(java.io.Writer w,
int i,
boolean val,
short[] flags,
short flagF,
short globalFlag,
int flagLen)
throws java.lang.Exception
java.lang.Exceptionpublic void writeString(java.io.Writer w,
int i,
byte val,
short[] flags,
short flagF,
short globalFlag,
int flagLen)
throws java.lang.Exception
java.lang.Exceptionpublic void writeString(java.io.Writer w,
int i,
double val,
short[] flags,
short flagF,
short globalFlag,
int flagLen)
throws java.lang.Exception
java.lang.Exceptionpublic void writeString(java.io.Writer w,
int i,
float val,
short[] flags,
short flagF,
short globalFlag,
int flagLen)
throws java.lang.Exception
java.lang.Exceptionpublic void writeString(java.io.Writer w,
int i,
short val,
short[] flags,
short flagF,
short globalFlag,
int flagLen)
throws java.lang.Exception
java.lang.Exceptionpublic void writeString(java.io.Writer w,
int i,
int val,
short[] flags,
short flagF,
short globalFlag,
int flagLen)
throws java.lang.Exception
java.lang.Exceptionpublic void writeString(java.io.Writer w,
int i,
T_DCOMPLEX val,
short[] flags,
short flagF,
short globalFlag,
int flagLen)
throws java.lang.Exception
java.lang.Exceptionpublic void writeString(java.io.Writer w,
int i,
T_COMPLEX val,
short[] flags,
short flagF,
short globalFlag,
int flagLen)
throws java.lang.Exception
java.lang.Exceptionpublic void writeString(java.io.Writer w,
int i,
T_LONGLONG val,
short[] flags,
short flagF,
short globalFlag,
int flagLen)
throws java.lang.Exception
java.lang.Exceptionpublic void writeString(java.io.Writer w,
int i,
java.lang.String val,
short[] flags,
short flagF,
short globalFlag,
int flagLen)
throws java.lang.Exception
java.lang.Exceptionpublic void getPresentationString(java.io.Writer w,
java.lang.String spec,
java.util.Locale locale,
OdsxFilterInterface filter)
throws java.io.IOException
getPresentationString in interface OdsxPresentableElementInterfacegetPresentationString in class OdsxPresentableElementw - 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.
It is possible to enclose the total number of displayed local column value in brackes (e.g. [100])l - The Locale object or null.f - An ODSFilterInterface object.java.io.IOExceptionpublic java.util.Vector getElements()
getElements in interface OdsxPresentableElementInterfacegetElements in class OdsxPresentableElementpublic java.lang.String getBuild()
getBuild in interface FwkDescriptionInterfacegetBuild in class FwkPersistence#setBuild(int)public java.lang.String getCreationDate()
getCreationDate in interface FwkDescriptionInterfacegetCreationDate in class FwkPersistence#setCreationDate(Date)public FwkCommandInterface[] getCommands()
getCommands in interface FwkInstructionInterfacegetCommands in class OdsxPresentableElementpublic void delete(boolean flag)
delete in interface OdsxInstanceElementInterfacedelete in interface OdsxPresentableElementInterfacedelete in class OdsxPresentableElementflag - true if the instance should delete with references.public void cloneInstanceElement()
cloneInstanceElement in interface OdsxInstanceElementInterfacepublic java.lang.String getIdentificationString()
getIdentificationString in interface OdsxPresentableElementInterfacegetIdentificationString in class OdsxPresentableElementpublic java.lang.String getInstancePath(boolean flag)
getInstancePath in interface OdsxInstanceElementInterfaceflag - If true the path will contain the environment.public void odsChanged(OdsxChangeEventInterface event)
odsChanged in interface OdsxChangeListenerInterfaceodsChanged in class OdsxPresentableElementevent - the change event.public T_LONGLONG getApplicationElementId()
getApplicationElementId in interface OdsxInstanceElementInterfacepublic T_LONGLONG getInstanceElementId()
getInstanceElementId in interface OdsxInstanceElementInterfacepublic java.lang.String getInstanceElementName()
public ApplicationElement getApplicationElement()
getApplicationElement in interface OdsxInstanceElementInterfaceThe - ASAM-ODS application element.public void reload()
reload in interface OdsxInstanceElementInterface