com.highqsoft.fwk.factory

Class FwkInfoBusConsumerFactory

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

All Implemented Interfaces:

FwkCompareInterface, FwkControlledByInterface, FwkControllerInterface, FwkDescriptionInterface, FwkInfoBusMemberInterface, FwkInfoBusProducerInterface, 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.InfoBusDataProducer, javax.infobus.InfoBusEventListener, javax.infobus.InfoBusMember

public class FwkInfoBusConsumerFactory
extends FwkMimeType
implements FwkInfoBusProducerInterface

The InfoBusConsumerFactory is the producer that publishes consumers on the infobus named ConsumerBus.

Since:

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

Version:

$Revision: 1.14 $

Author:

Andreas Hofmann

See Also:

, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONSUMERMIMETYPE
static java.lang.String	FWKMIMETYPE
static java.lang.String	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.FwkInfoBusProducerInterface

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

Method Summary

Methods

Modifier and Type	Method and Description
void	dataItemRequested(javax.infobus.InfoBusItemRequestedEvent ev) The data item request callback.
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.
void	fireItemAvailable(javax.infobus.DataItem item, java.awt.datatransfer.DataFlavor[] flavor) Fire an item revoked event on the given item name.
protected void	fireItemAvailable(FwkInfoBusConsumerInterface c, java.awt.datatransfer.DataFlavor[] flavor, java.util.Vector arr) This method fires an ItemAvailableEvent the specified component.
void	fireItemRevoked(javax.infobus.DataItem item) Fire an item revoked event on the given item name.
protected void	firePatternItemAvailable(java.lang.String pattern, java.awt.datatransfer.DataFlavor[] flavor, java.util.Vector arr) This method fires an ItemAvailableEvent for all the component match the given pattern.
FwkControllerInterface	getController() Get the controller instance of the application.
static FwkInfoBusConsumerFactory	getInstance() Get the instance of the object.
java.lang.String	getVersion() Return the version string of the FWK component.
boolean	isAssignable(java.awt.datatransfer.DataFlavor[] flavors) Return a boolean whether the given data flavors are assignable from this producer.
void	propertyChange(java.beans.PropertyChangeEvent ev) The property changed callback.
void	register() Register the producer.
void	register(FwkInfoBusConsumerInterface consumer) Publish and register a consumer.
boolean	revoke(java.lang.String itemName) This method revoke an item from producer list.
boolean	revoke(java.lang.String itemName, java.awt.datatransfer.DataFlavor[] flavor) This method revoke an item from producer list.
void	setController(FwkControllerInterface controller) Set the controller instance of the application.
void	setInfoBusName(java.lang.String newName) Overrides the setInfoBusName of the super class.
void	unregister() Unregister the producer.
void	unregister(FwkInfoBusConsumerInterface consumer) Unregister a consumer.

Methods inherited from class com.highqsoft.fwk.FwkMimeType

addMimeType, getDataFlavor, getDataFlavors, getMimeTypes, 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, release, 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

release

Methods inherited from interface javax.infobus.DataItem

getSource, release

Methods inherited from interface javax.infobus.InfoBusMember

addInfoBusPropertyListener, addInfoBusVetoableListener, getInfoBus, removeInfoBusPropertyListener, removeInfoBusVetoableListener, setInfoBus

Field Detail

version

public static final java.lang.String version

See Also:

Constant Field Values

CONSUMERMIMETYPE

public static final java.lang.String CONSUMERMIMETYPE

FWKMIMETYPE

public static final java.lang.String FWKMIMETYPE

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 FwkMimeType

finalize

public void finalize()
              throws java.lang.Throwable

Leave the info at the end of session.

Overrides:

finalize in class FwkInfoBusMember

Throws:

java.lang.Throwable

unregister

public void unregister()

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

Specified by:

unregister in interface FwkInfoBusProducerInterface

register

public void register()

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

Specified by:

register in interface FwkInfoBusProducerInterface

register

public void register(FwkInfoBusConsumerInterface consumer)

Publish and register a consumer.

Parameters:

consumer - The consumer to be registered and published.

unregister

public void unregister(FwkInfoBusConsumerInterface consumer)

Unregister a consumer.

Parameters:

consumer - The consumer to be unregistered.

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.

revoke

public boolean revoke(java.lang.String itemName,
             java.awt.datatransfer.DataFlavor[] flavor)

This method revoke an item from producer list.

The method returns a boolean that indicates whether producer supports the revokation. It is possible to test the revoke by passing a null string to that method.

Specified by:

revoke in interface FwkInfoBusProducerInterface

Parameters:

itemName - The name of the item to be revoked or null to get the support flag.

flavor - The data flavor of the item to be revoked.

Returns:

true if this operation is supported.

isAssignable

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

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

Returns:

true if one of the given data flavors are assignable.

setInfoBusName

public void setInfoBusName(java.lang.String newName)

Overrides the setInfoBusName of the super class. It enables this facility.

Specified by:

setInfoBusName in interface FwkInfoBusMemberInterface

Overrides:

setInfoBusName in class FwkInfoBusMember

Parameters:

newName - The new name of the infobus. This parameter will not be evaluated.

getInstance

public static FwkInfoBusConsumerFactory getInstance()

Get the instance of the object.

Returns:

The singleton instance of the object.

revoke

public boolean revoke(java.lang.String itemName)

This method revoke an item from producer list.

The method returns a boolean that indicates whether producer supports the revokation. It is possible to test the revoke by passing a null string to that method.

Parameters:

itemName - The name of the item to be revoked or null to get the support flag.

Returns:

true if this operation is supported.

fireItemAvailable

public void fireItemAvailable(javax.infobus.DataItem item,
                     java.awt.datatransfer.DataFlavor[] flavor)

Fire an item revoked event on the given item name.

Specified by:

fireItemAvailable in interface FwkInfoBusProducerInterface

Parameters:

itemName - The name of the item for that the event should be fired.

fireItemRevoked

public void fireItemRevoked(javax.infobus.DataItem item)

Fire an item revoked event on the given item name.

Specified by:

fireItemRevoked in interface FwkInfoBusProducerInterface

Parameters:

itemName - The name of the item for that the event should be fired.

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 FwkInfoBusProducerInterface

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 FwkInfoBusProducerInterface

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 FwkInfoBusProducerInterface

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 FwkInfoBusProducerInterface

Parameters:

pattern - The dataitem pattern.

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

firePatternItemAvailable

protected void firePatternItemAvailable(java.lang.String pattern,
                            java.awt.datatransfer.DataFlavor[] flavor,
                            java.util.Vector arr)

This method fires an ItemAvailableEvent for all the component match the given pattern.

Parameters:

pattern - The pattern string.

fireItemAvailable

protected void fireItemAvailable(FwkInfoBusConsumerInterface c,
                     java.awt.datatransfer.DataFlavor[] flavor,
                     java.util.Vector arr)

This method fires an ItemAvailableEvent the specified component.

Parameters:

pattern - The pattern string.

dataItemRequested

public void dataItemRequested(javax.infobus.InfoBusItemRequestedEvent ev)

The data item request callback.

Specified by:

dataItemRequested in interface javax.infobus.InfoBusDataProducer

Parameters:

ev - The request event.

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent ev)

The property changed callback.

Specified by:

propertyChange in interface java.beans.PropertyChangeListener

Parameters:

ev - The property change event.