com.highqsoft.interfaces.fwk

Interface FwkInfoBusProducerInterface

All Superinterfaces:

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

All Known Subinterfaces:

FwkApplicationProducerInterface, FwkInfoBusDropProducerInterface, OdsxPresentableElementProducerInterface, OdsxSelectorInterface, OdsxSessionProducerInterface

All Known Implementing Classes:

FwkAliasProducer, FwkApplicationProducer, FwkColumnAccessProducer, FwkEnvironmentPropertyProducer, FwkInfoBusConsumerFactory, FwkInfoBusControllerFactory, FwkInfoBusPortFactory, FwkInfoBusProducer, FwkInfoBusProducerFactory, FwkPropertyProducer, FwkSystemPropertyProducer, OdsxApplicationElementProducer, OdsxColumnProducer, OdsxInstanceProducer, OdsxPresentableElementProducer, OdsxPresentor.OdsxPathProducer, OdsxResultSetProducer, OdsxSelector, OdsxSessionProducer, P2DComponentProducer, P2DMarkerProducer, RpcIIIColumnProducer

public interface FwkInfoBusProducerInterface
extends FwkMimeTypeInterface, FwkControlledByInterface, javax.infobus.InfoBusDataProducer, javax.infobus.InfoBusEventListener

The FwkInfoBusProducerInterface describes the functionality of an infobus data item producer.

Since:

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

Version:

$Revision: 1.10 $

Author:

Andreas Hofmann

See Also:

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BUSNAME The name of the ProducerBus.

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
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.
void	fireItemRevoked(javax.infobus.DataItem item) Fire an item revoked event on the given item name.
void	register() Register the producer.
boolean	revoke(java.lang.String itemName, java.awt.datatransfer.DataFlavor[] dataFlavor) This method revoke an item from producer list.
void	unregister() Unregister the producer.

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, setInfoBusName, 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, release

Methods inherited from interface javax.infobus.DataItem

getSource, release

Methods inherited from interface javax.infobus.InfoBusMember

addInfoBusPropertyListener, addInfoBusVetoableListener, getInfoBus, removeInfoBusPropertyListener, removeInfoBusVetoableListener, setInfoBus

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

getController, setController

Methods inherited from interface javax.infobus.InfoBusDataProducer

dataItemRequested

Methods inherited from interface java.beans.PropertyChangeListener

propertyChange

Field Detail

BUSNAME

static final java.lang.String BUSNAME

The name of the ProducerBus.

See Also:

Constant Field Values

Method Detail

unregister

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.

register

void register()

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

revoke

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

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.

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

Returns:

true if this operation is supported.

fireItemAvailable

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

Fire an item revoked event on the given item name.

Parameters:

item - The item for that the event should be fired.

fireItemRevoked

void fireItemRevoked(javax.infobus.DataItem item)

Fire an item revoked event on the given item name.

Parameters:

item - The item for that the event should be fired.

findDataItem

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.

Parameters:

dataItemName - The item to be found.

findDataItem

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

Seeks a DataItem for a given data item name.

Parameters:

dataItemName - The item to be found.

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

findMultipleDataItems

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.

Parameters:

pattern - The dataitem pattern.

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

findMultipleDataItems

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

Seeks all available dataitems that match the pattern.

Parameters:

pattern - The dataitem pattern.

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