com.highqsoft.fwk

Class FwkInfoBusImmediateAccess

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

All Implemented Interfaces:

FwkCompareInterface, FwkControllerInterface, FwkDescriptionInterface, FwkInfoBusImmediateAccessInterface, FwkInfoBusItemGroupInterface, FwkInstructionInterface, FwkInterface, FwkItemInterface, FwkPersistenceInterface, FwkPresentationInterface, FwkPropertyChangeInterface, FwkTransferableInterface, FwkVetoableChangeInterface, java.awt.datatransfer.ClipboardOwner, java.awt.datatransfer.Transferable, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable, javax.infobus.DataItem, javax.infobus.DataItemChangeManager, javax.infobus.ImmediateAccess

Direct Known Subclasses:

FwkInfoBusDataAccess

public class FwkInfoBusImmediateAccess
extends FwkItem
implements FwkInfoBusImmediateAccessInterface

The FwkInfoBusImmediateAccess class is the default implementation of the FwkInfoBusImmediateAccessInterface.

Since:

$Date: 2017/04/28 08:47:40 $

Version:

$Revision: 1.14 $

Author:

HighQSoft GmbH

See Also:

, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	FwkInfoBusImmediateAccess.ElementConsumer The consumer class.

Field Summary

Fields

Modifier and Type	Field and Description
protected FwkArray	children
protected java.util.HashMap	properties
protected boolean	valid
static java.lang.String	version

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

INFOBUS_SOURCE

Constructor Summary

Constructors

Constructor and Description
FwkInfoBusImmediateAccess() The constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addChild(FwkInfoBusItemGroupInterface child) Add a child to group.
void	addChildListener(FwkChildListenerInterface l) Add a child listener.
boolean	containsChild(FwkInfoBusItemGroupInterface child) Return a boolean whether the given child is already in group.
protected void	fireChildAdded(java.lang.Object child) Fire a child added event.
protected void	fireChildRemoved(java.lang.Object child) Fire a child removed event.
FwkArrayInterface	getAllChildren() Returns the children of the group.
FwkArrayInterface	getAllChildren(FwkArrayInterface array) Returns the children of the group recursivly.
FwkArrayInterface	getChildren() Returns the children of the group.
FwkArrayInterface	getChildren(FwkArrayInterface array) Returns the children of the group.
int	getChildrenCount(boolean recursive) Return the total number of children.
java.lang.Object	getProperty(java.lang.String keyword) Get a property value.
java.lang.Object	getTransferData(java.awt.datatransfer.DataFlavor flavor) Returns an object which represents the data to be transferred.
java.awt.datatransfer.DataFlavor[]	getTransferDataFlavors() Returns an array of DataFlavor objects indicating the flavors the data can be provided in.
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	hasChildren() Returns a boolean that indicates whether the group has children.
boolean	hasValidValues() Returns a boolean whether the item has valid values.
boolean	isDataFlavorSupported(java.awt.datatransfer.DataFlavor dataFlavor) Returns whether or not the specified data flavor is supported for this object.
boolean	isGroup() Returns a boolean that indicates whether the item is a group.
void	removeAllChildren() Remove all children from group.
void	removeChild(FwkInfoBusItemGroupInterface child) Remove a child to group.
void	removeChild(FwkInfoBusItemGroupInterface child, boolean recursive) Remove a child recursively from group.
void	removeChildListener(FwkChildListenerInterface l) Remove a child listener.
void	setChildren(FwkArrayInterface array) Sets the children of the group.
void	setProperty(java.lang.String keyword, java.lang.Object value) Set a property value.
void	setValidValues(boolean flag) Set the flag for valid values.
void	setValue(java.lang.Object col) Set the value of the item.

Methods inherited from class com.highqsoft.fwk.FwkItem

addDataItemChangeListener, fireItemAdded, fireItemDeleted, fireItemRevoked, fireItemValueChanged, getName, getPropertyGroup, getSource, isChangeManagerSuspended, release, removeDataItemChangeListener, setName, 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, getCommands, getCommands, getCompany, getCompanyInternetAddress, getCopyright, getCreationDate, getCreationDate, getDateFormatString, getDescription, getFwkMimeTypes, getGroup, getIcon, 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, getPresentationString, lostOwnership, setClassName, setCreationDate, toString

Methods inherited from class com.highqsoft.fwk.Fwk

getNiceVersion

Methods inherited from class java.lang.Object

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

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

getName

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

lostOwnership

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface javax.infobus.DataItem

getSource, release

Methods inherited from interface javax.infobus.ImmediateAccess

getPresentationString

Methods inherited from interface javax.infobus.DataItemChangeManager

addDataItemChangeListener, removeDataItemChangeListener

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

getCommands, getPersistentObjectNames

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

destroyController

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

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

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

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

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

getPresentationString, getPresentationString

Field Detail

version

public static final java.lang.String version

See Also:

Constant Field Values

properties

protected java.util.HashMap properties

children

protected FwkArray children

valid

protected boolean valid

Constructor Detail

FwkInfoBusImmediateAccess

public FwkInfoBusImmediateAccess()

The constructor.

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 FwkItem

getValueAsString

public java.lang.String getValueAsString()

Get the vale as string.

Specified by:

getValueAsString in interface javax.infobus.ImmediateAccess

Returns:

The string value of the item.

setValue

public void setValue(java.lang.Object col)
              throws javax.infobus.InvalidDataException

Set the value of the item.

Specified by:

setValue in interface javax.infobus.ImmediateAccess

Parameters:

value - the new value.

Throws:

javax.infobus.InvalidDataException

getValueAsObject

public java.lang.Object getValueAsObject()

Get the value as object.

Specified by:

getValueAsObject in interface javax.infobus.ImmediateAccess

Returns:

The value object.

hasValidValues

public boolean hasValidValues()

Returns a boolean whether the item has valid values.

Specified by:

hasValidValues in interface FwkInfoBusImmediateAccessInterface

Returns:

true if the values are valid.

setValidValues

public void setValidValues(boolean flag)

Set the flag for valid values.

Specified by:

setValidValues in interface FwkInfoBusImmediateAccessInterface

Parameters:

flag - true if the values should be valid.

isGroup

public boolean isGroup()

Returns a boolean that indicates whether the item is a group.

Specified by:

isGroup in interface FwkInfoBusImmediateAccessInterface

Returns:

true if the item is group.

hasChildren

public boolean hasChildren()

Returns a boolean that indicates whether the group has children.

Specified by:

hasChildren in interface FwkInfoBusItemGroupInterface

Returns:

true if the group has children.

getChildrenCount

public int getChildrenCount(boolean recursive)

Return the total number of children.

Specified by:

getChildrenCount in interface FwkInfoBusItemGroupInterface

Parameters:

recursive - if true the counter will parse the child groups.

getChildren

public FwkArrayInterface getChildren()

Returns the children of the group.

Specified by:

getChildren in interface FwkInfoBusItemGroupInterface

Returns:

An array containing the children of the group.

getChildren

public FwkArrayInterface getChildren(FwkArrayInterface array)

Returns the children of the group.

Specified by:

getChildren in interface FwkInfoBusItemGroupInterface

Parameters:

array - An array to store the children. If this parameter is null the routine must create it. The parameter or the newly created array will be returned.

Returns:

the array containing the children.

getAllChildren

public FwkArrayInterface getAllChildren()

Returns the children of the group.

Specified by:

getAllChildren in interface FwkInfoBusItemGroupInterface

Returns:

An array containing the children of the group.

getAllChildren

public FwkArrayInterface getAllChildren(FwkArrayInterface array)

Returns the children of the group recursivly.

Specified by:

getAllChildren in interface FwkInfoBusItemGroupInterface

Parameters:

array - An array to store the recursive children. If this parameter is null the routine must create it. The parameter or the newly created array will be returned.

Returns:

the array containing the children.

setChildren

public void setChildren(FwkArrayInterface array)

Sets the children of the group.

Specified by:

setChildren in interface FwkInfoBusItemGroupInterface

Parameters:

array - An array containing the names of children of the group.

addChild

public boolean addChild(FwkInfoBusItemGroupInterface child)

Add a child to group. This method prevents recursive structure.

Specified by:

addChild in interface FwkInfoBusItemGroupInterface

Parameters:

child - The new child.

Returns:

true if successful.

containsChild

public boolean containsChild(FwkInfoBusItemGroupInterface child)

Return a boolean whether the given child is already in group.

Specified by:

containsChild in interface FwkInfoBusItemGroupInterface

Parameters:

child - the child to be checked.

Returns:

true if the child is a member of group.

removeChild

public void removeChild(FwkInfoBusItemGroupInterface child)

Remove a child to group.

Specified by:

removeChild in interface FwkInfoBusItemGroupInterface

Parameters:

child - The new child.

removeChild

public void removeChild(FwkInfoBusItemGroupInterface child,
               boolean recursive)

Remove a child recursively from group.

Specified by:

removeChild in interface FwkInfoBusItemGroupInterface

Parameters:

child - The new child.

removeAllChildren

public void removeAllChildren()

Remove all children from group.

Specified by:

removeAllChildren in interface FwkInfoBusItemGroupInterface

addChildListener

public void addChildListener(FwkChildListenerInterface l)

Add a child listener.

Specified by:

addChildListener in interface FwkInfoBusItemGroupInterface

Parameters:

l - The listener to be added.

removeChildListener

public void removeChildListener(FwkChildListenerInterface l)

Remove a child listener.

Specified by:

removeChildListener in interface FwkInfoBusItemGroupInterface

Parameters:

l - The listener to be removed.

fireChildAdded

protected void fireChildAdded(java.lang.Object child)

Fire a child added event.

Parameters:

child - the child that was added.

fireChildRemoved

protected void fireChildRemoved(java.lang.Object child)

Fire a child removed event.

Parameters:

child - the child that was removed.

getTransferData

public java.lang.Object getTransferData(java.awt.datatransfer.DataFlavor flavor)
                                 throws java.io.IOException,
                                        java.awt.datatransfer.UnsupportedFlavorException

Returns an object which represents the data to be transferred. The class of the object returned is defined by the representation class of the flavor.

Specified by:

getTransferData in interface java.awt.datatransfer.Transferable

Overrides:

getTransferData in class FwkDescription

Parameters:

flavor - the requested flavor for the data

Throws:

java.io.IOException - - if the data is no longer available in the requested flavor. UnsupportedFlavorException - if the requested data flavor is not supporte

java.awt.datatransfer.UnsupportedFlavorException

See Also:

java.awt.datatransfer.DataFlavor.getRepresentationClass()

getTransferDataFlavors

public java.awt.datatransfer.DataFlavor[] getTransferDataFlavors()

Returns an array of DataFlavor objects indicating the flavors the data can be provided in. The array should be ordered according to preference for providing the data (from most richly descriptive to least descriptive).

Specified by:

getTransferDataFlavors in interface java.awt.datatransfer.Transferable

Overrides:

getTransferDataFlavors in class FwkDescription

Returns:

an array of data flavors in which this data can be transferred

isDataFlavorSupported

public boolean isDataFlavorSupported(java.awt.datatransfer.DataFlavor dataFlavor)

Returns whether or not the specified data flavor is supported for this object.

Specified by:

isDataFlavorSupported in interface java.awt.datatransfer.Transferable

Overrides:

isDataFlavorSupported in class FwkDescription

Parameters:

flavor - the requested flavor for the data

Returns:

boolean indicating wjether or not the data flavor is supported

setProperty

public void setProperty(java.lang.String keyword,
               java.lang.Object value)

Set a property value.

Specified by:

setProperty in interface FwkInfoBusImmediateAccessInterface

Specified by:

setProperty in interface FwkItemInterface

Overrides:

setProperty in class FwkItem

Parameters:

keyword - The keyword of the new property value.

value - Thge value belongs to the keyword.

getProperty

public java.lang.Object getProperty(java.lang.String keyword)

Get a property value.

Specified by:

getProperty in interface FwkItemInterface

Specified by:

getProperty in interface javax.infobus.DataItem

Overrides:

getProperty in class FwkItem

Parameters:

keyword - The keyword to that a property value is searched.

Returns:

The value of the property.