com.highqsoft.fwk

Class FwkInfoBusConsumer

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

com.highqsoft.fwk.FwkMimeType

com.highqsoft.fwk.FwkInfoBusConsumer

All Implemented Interfaces:

FwkCompareInterface, FwkControlledByInterface, FwkControllerInterface, FwkDescriptionInterface, FwkInfoBusConsumerInterface, FwkInfoBusMemberInterface, FwkInstructionInterface, FwkInterface, FwkItemInterface, FwkMimeTypeInterface, FwkPersistenceInterface, FwkPresentationInterface, FwkPropertyChangeInterface, FwkTransferableInterface, FwkVetoableChangeInterface, java.awt.datatransfer.ClipboardOwner, java.awt.datatransfer.Transferable, java.beans.PropertyChangeListener, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable, java.util.EventListener, javax.infobus.DataItem, javax.infobus.InfoBusDataConsumer, javax.infobus.InfoBusEventListener, javax.infobus.InfoBusMember

Direct Known Subclasses:

AsamCommanderOdsSessionConsumer, Cmd, ColumnDisplay.ColumnConsumer, ColumnDisplay.LayouterConsumer, FileConsumer, FwkAliasConsumer, FwkApplicationConsumer, FwkDataItemConsumer, FwkInfoBusImmediateAccess.ElementConsumer, FwkInfoBusItemList.ItemListConsumer, FwkPropertyConsumer, ItemList.ItemListConsumer, JournalConsumer, MED.LayouterConsumer, MEDCalculatorBasicPane.InfoBusChannelConsumer, MEDCalculatorBasicPane.InfoBusMarkerConsumer, MEDInfoBusSelectionDialogPane.InfoBusConsumer, OdsxPresentableElementConsumer, OdsxSelector.OdsxPathConsumer, OdsxSessionConsumer, P2DChannel.InfoBusDataConsumer, P2DComponentConsumer, P2DMarkerConsumer, ProducerSelector.MimeTypeConsumer, ProducerSelector.ProducerSelectorConsumer

public class FwkInfoBusConsumer
extends FwkMimeType
implements FwkInfoBusConsumerInterface

The FwkInfoBusConsumer is an abstract class to support the common functionality of a data consumer.

Since:

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

Version:

$Revision: 1.13 $

Author:

Andreas Hofmann

See Also:

, Serialized Form

Field Summary

Fields inherited from class com.highqsoft.fwk.FwkMimeType

FWKMIMETYPE, version

Fields inherited from class com.highqsoft.fwk.FwkInfoBusMember

infoBusMemberSupport

Fields inherited from class com.highqsoft.fwk.FwkItem

changeManager, properties, 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.FwkInfoBusConsumerInterface

BUSNAME

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

INFOBUS_SOURCE

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FwkInfoBusConsumer(java.lang.String memberName, FwkArrayInterface mimeTypes) The default constructor.
protected	FwkInfoBusConsumer(java.lang.String memberName, java.lang.String mimeType) The default constructor.
protected	FwkInfoBusConsumer(java.lang.String memberName, java.lang.String[] mimeTypes) The default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	dataItemAvailable(javax.infobus.InfoBusItemAvailableEvent ev) Invoked if an data item is available.
void	dataItemRevoked(javax.infobus.InfoBusItemRevokedEvent ev) Invoked if a dataitem is revoked.
protected void	finalize() Leave the info at the end of session.
java.lang.Object	findDataItem(java.lang.String dataItemName) Seeks a DataItem for a given data item name.
java.lang.Object	findDataItem(java.lang.String dataItemName, java.awt.datatransfer.DataFlavor[] flavors) Seeks a DataItem for a given data item name.
java.lang.Object[]	findMultipleDataItems(java.lang.String dataItemName) Seeks all available dataitems that match the pattern.
java.lang.Object[]	findMultipleDataItems(java.lang.String dataItemName, java.awt.datatransfer.DataFlavor[] flavors) Seeks all available dataitems that match the pattern.
FwkControllerInterface	getController() Get the controller instance of the application.
protected void	initialize(java.lang.String memberName) Initialize the component.
boolean	isAssignable(java.awt.datatransfer.DataFlavor[] flavors) Return a boolean whether the given data flavors are assignable from this consumer.
void	propertyChange(java.beans.PropertyChangeEvent ev) Invoked if a property changed.
void	register() Register the consumer.
void	release() Release the item.
void	setController(FwkControllerInterface controller) Set the controller instance of the application.
void	setInfoBusName(java.lang.String newName) Set the infobus name.
void	unregister() Unregister the consumer.

Methods inherited from class com.highqsoft.fwk.FwkMimeType

addMimeType, getDataFlavor, getDataFlavors, getMimeTypes, getVersion, removeMimeType

Methods inherited from class com.highqsoft.fwk.FwkInfoBusMember

addInfoBusPropertyListener, addInfoBusVetoableListener, getInfoBus, getInfoBusName, getMemberName, isConnected, joinInfoBus, removeInfoBusPropertyListener, removeInfoBusVetoableListener, setInfoBus, setMemberName, setName

Methods inherited from class com.highqsoft.fwk.FwkItem

addDataItemChangeListener, fireItemAdded, fireItemDeleted, fireItemRevoked, fireItemValueChanged, getName, getProperty, getPropertyGroup, getSource, isChangeManagerSuspended, removeDataItemChangeListener, setProperty, 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, getTransferData, getTransferDataFlavors, isDataFlavorSupported, lostOwnership, setClassName, setCreationDate, toString

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

addMimeType, getDataFlavor, getDataFlavors, getMimeTypes, removeMimeType

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

getInfoBusName, getMemberName, isConnected, setMemberName

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

fireItemAdded, fireItemDeleted, fireItemRevoked, fireItemValueChanged, getProperty, getPropertyGroup, setProperty, setPropertyGroup, suspendChangeManager

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

getAuthor, getBuild, getClassName, getCompany, getCompanyInternetAddress, getCopyright, getCreationDate, getCreationDate, getDateFormatString, getDescription, getIcon, getIcon, getIconKey, getIconKey, getName, 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 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.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

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

getVersion

Methods inherited from interface javax.infobus.DataItem

getSource

Methods inherited from interface javax.infobus.InfoBusMember

addInfoBusPropertyListener, addInfoBusVetoableListener, getInfoBus, removeInfoBusPropertyListener, removeInfoBusVetoableListener, setInfoBus

Constructor Detail

FwkInfoBusConsumer

protected FwkInfoBusConsumer(java.lang.String memberName,
                  java.lang.String[] mimeTypes)

The default constructor. It will create the FwkMimeType instance and will set the member name. The object will be added as a data consumer to the infobus instance and will be registered as a consumer.

Parameters:

memberName - The name of the infobus member. Use the member name conventions of the FwkInfoBusMember.

mimetypes - An array constaining the supported mime types.

See Also:

#FwkInfoBusMember.setMemberName

FwkInfoBusConsumer

protected FwkInfoBusConsumer(java.lang.String memberName,
                  FwkArrayInterface mimeTypes)

The default constructor. It will create the FwkMimeType instance and will set the member name. The object will be added as data consumer to the infobus instance and will be registered as consumer.

Parameters:

memberName - The name of the infobus member. Use the member name conventions of the FwkInfoBusMember.

mimetypes - An array constaining the supported mime types.

See Also:

#FwkInfoBusMember.setMemberName

FwkInfoBusConsumer

protected FwkInfoBusConsumer(java.lang.String memberName,
                  java.lang.String mimeType)

The default constructor. It will create the FwkMimeType instance and will set the member name. The object will be added as data consumer to the infobus instance and will be registered as consumer.

Parameters:

memberName - The name of the infobus member. Use the member name conventions of the FwkInfoBusMember.

mimetypes - A string constaining the supported mime types.

See Also:

#FwkInfoBusMember.setMemberName

Method Detail

finalize

protected void finalize()
                 throws java.lang.Throwable

Leave the info at the end of session.

Overrides:

finalize in class FwkInfoBusMember

Throws:

java.lang.Throwable

release

public void release()

Release the item.

Specified by:

release in interface FwkInterface

Specified by:

release in interface javax.infobus.DataItem

Overrides:

release in class FwkItem

initialize

protected void initialize(java.lang.String memberName)

Initialize the component.

Parameters:

memberName - The membername of the component.

unregister

public void unregister()

Unregister the consumer. This procedure unregisters the consumer as consumer at the consumer bus. Use this method before disconnect or finalize the instance.

Specified by:

unregister in interface FwkInfoBusConsumerInterface

register

public void register()

Register the consumer. This procedure registers the consumer as consumer at the consumer bus.

Specified by:

register in interface FwkInfoBusConsumerInterface

getController

public FwkControllerInterface getController()

Get the controller instance of the application. The controller must implement the FwkWindowInterface.

Specified by:

getController in interface FwkControlledByInterface

Returns:

The controller instance of the application.

setController

public void setController(FwkControllerInterface controller)

Set the controller instance of the application. The controller must implement the FwkWindowInterface.

Specified by:

setController in interface FwkControlledByInterface

Parameters:

controller - The controller instance of the application.

isAssignable

public boolean isAssignable(java.awt.datatransfer.DataFlavor[] flavors)

Return a boolean whether the given data flavors are assignable from this consumer.

Specified by:

isAssignable in interface FwkInfoBusConsumerInterface

Returns:

true if one of the given data flavors are assignable.

setInfoBusName

public void setInfoBusName(java.lang.String newName)

Set the infobus name.

Specified by:

setInfoBusName in interface FwkInfoBusMemberInterface

Overrides:

setInfoBusName in class FwkInfoBusMember

Parameters:

The - new name of the infobus.

findDataItem

public java.lang.Object findDataItem(java.lang.String dataItemName)

Seeks a DataItem for a given data item name. The method looks for data items that support one of the flavors supported by this producer.

Specified by:

findDataItem in interface FwkInfoBusConsumerInterface

Parameters:

dataItemName - The item to be found.

findDataItem

public java.lang.Object findDataItem(java.lang.String dataItemName,
                            java.awt.datatransfer.DataFlavor[] flavors)

Seeks a DataItem for a given data item name.

Specified by:

findDataItem in interface FwkInfoBusConsumerInterface

Parameters:

dataItemName - The item to be found.

flavors - The flavors that should be support by the item.

findMultipleDataItems

public java.lang.Object[] findMultipleDataItems(java.lang.String dataItemName)

Seeks all available dataitems that match the pattern. The method looks for data items that support one of the flavors supported by this producer.

Specified by:

findMultipleDataItems in interface FwkInfoBusConsumerInterface

Parameters:

pattern - The dataitem pattern.

flavors - The flavors that should be support by the item.

findMultipleDataItems

public java.lang.Object[] findMultipleDataItems(java.lang.String dataItemName,
                                       java.awt.datatransfer.DataFlavor[] flavors)

Seeks all available dataitems that match the pattern.

Specified by:

findMultipleDataItems in interface FwkInfoBusConsumerInterface

Parameters:

pattern - The dataitem pattern.

flavors - The flavors that should be support by the item.

dataItemRevoked

public void dataItemRevoked(javax.infobus.InfoBusItemRevokedEvent ev)

Invoked if a dataitem is revoked.

Specified by:

dataItemRevoked in interface javax.infobus.InfoBusDataConsumer

Parameters:

ev - The infobus data item revoked event.

dataItemAvailable

public void dataItemAvailable(javax.infobus.InfoBusItemAvailableEvent ev)

Invoked if an data item is available.

Specified by:

dataItemAvailable in interface javax.infobus.InfoBusDataConsumer

Parameters:

ev - The infobus data item available event.

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent ev)

Invoked if a property changed.

Specified by:

propertyChange in interface java.beans.PropertyChangeListener

Parameters:

ev - The property change event