com.highqsoft.fwk

Class FwkPort

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

com.highqsoft.fwk.FwkPort

All Implemented Interfaces:

FwkCompareInterface, FwkControllerInterface, FwkDescriptionInterface, FwkInfoBusMemberInterface, FwkInstructionInterface, FwkInterface, FwkIOInterface, FwkItemInterface, FwkPersistenceInterface, FwkPortInterface, FwkPortLimitInterface, 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.InfoBusDataProducer, javax.infobus.InfoBusEventListener, javax.infobus.InfoBusMember

Direct Known Subclasses:

FwkInfoBusController

public class FwkPort
extends FwkIO
implements FwkPortInterface

The FwkPort is an abstract class to support the common functionality of a port component.

Since:

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

Version:

$Revision: 1.13 $

Author:

Andreas Hofmann

See Also:

, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static FwkIconInterface	PORT
protected static byte[]	PORT_ARRAY
protected static FwkIconInterface	PORT_BG
protected static byte[]	PORT_BG_ARRAY
protected static FwkIconInterface	PORT_BG_LARGE
protected static byte[]	PORT_BG_LARGE_ARRAY
protected static FwkIconInterface	PORT_LARGE
protected static byte[]	PORT_LARGE_ARRAY
static java.lang.String	version

Fields inherited from class com.highqsoft.fwk.FwkIO

inAllowed, outAllowed

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

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	FwkPort() The default constructor.
protected	FwkPort(java.lang.String memberName) The default constructor.
protected	FwkPort(java.lang.String memberName, FwkArrayInterface producerMimeTypes, FwkArrayInterface consumerMimeTypes) The default constructor.
protected	FwkPort(java.lang.String memberName, java.lang.String[] producerMimeTypes, java.lang.String[] consumerMimeTypes) The default constructor.
protected	FwkPort(java.lang.String memberName, java.lang.String producerMimeType, java.lang.String consumerMimeType) The default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addConsumerMimeType(java.lang.String type) Add a consumer mimetype.
void	addProducerMimeType(java.lang.String type) Add a producer mimetype.
void	dataItemAvailable(javax.infobus.InfoBusItemAvailableEvent ev) Invoked if an data item is available.
void	dataItemRequested(javax.infobus.InfoBusItemRequestedEvent ev) DataItemRequestEvent handler.
void	dataItemRevoked(javax.infobus.InfoBusItemRevokedEvent ev) Invoked if a dataitem is revoked.
protected void	finalize() Leave the info at the end of session.
java.awt.datatransfer.DataFlavor	getConsumerDataFlavor(int index) Return the data flavor of the consumer mimetype.
java.awt.datatransfer.DataFlavor[]	getConsumerDataFlavors() Return the data flavor array of all consumer mimetypes.
java.lang.String[]	getConsumerMimeTypes() Get the consumer mime type string list.
java.awt.datatransfer.DataFlavor	getProducerDataFlavor(int index) Return the data flavor of the producer mimetype.
java.awt.datatransfer.DataFlavor[]	getProducerDataFlavors() Return the data flavor array of all producer mimetypes.
java.lang.String[]	getProducerMimeTypes() Get the producer mime type string list.
java.lang.String	getVersion() Return the version string of the FWK component.
protected void	initialize(java.lang.String[] producerMimeTypes, java.lang.String[] consumerMimeTypes) Initialize the component.
void	propertyChange(java.beans.PropertyChangeEvent ev) The property change callback.
void	register() Register the controller.
void	release() Release object.
void	removeConsumerMimeType(java.lang.String type) Remove a consumer mimetype.
void	removeProducerMimeType(java.lang.String type) Remove a producer mimetype.
void	setInfoBusName(java.lang.String newName) Set the infobus name.
void	unregister() Unregister the controller.

Methods inherited from class com.highqsoft.fwk.FwkIO

getInAllowed, getOutAllowed, setInAllowed, setOutAllowed

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

getInAllowed, getOutAllowed, setInAllowed, setOutAllowed

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 javax.infobus.DataItem

getSource

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

PORT_BG_LARGE_ARRAY

protected static final byte[] PORT_BG_LARGE_ARRAY

PORT_LARGE_ARRAY

protected static final byte[] PORT_LARGE_ARRAY

PORT_BG_ARRAY

protected static final byte[] PORT_BG_ARRAY

PORT_ARRAY

protected static final byte[] PORT_ARRAY

PORT

protected static final FwkIconInterface PORT

PORT_BG

protected static final FwkIconInterface PORT_BG

PORT_LARGE

protected static final FwkIconInterface PORT_LARGE

PORT_BG_LARGE

protected static final FwkIconInterface PORT_BG_LARGE

Constructor Detail

FwkPort

protected FwkPort()

The default constructor.

FwkPort

protected FwkPort(java.lang.String memberName)

The default constructor. It will create the FwkMimeType instance and will set the memeber name. The object will be added ad data producer to the infobus instance and will be registered as producer component.

Parameters:

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

See Also:

#FwkInfoBusMember.setMemberName

FwkPort

protected FwkPort(java.lang.String memberName,
       java.lang.String[] producerMimeTypes,
       java.lang.String[] consumerMimeTypes)

The default constructor. It will create the FwkMimeType instance and will set the memeber name. The object will be added ad data producer to the infobus instance and will be registered as producer fwk.

Parameters:

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

producerMimetypes - An string array containing the supported producer mime types.

consumerMimetypes - An string array containing the supported consumer mime types.

See Also:

#FwkInfoBusMember.setMemberName

FwkPort

protected FwkPort(java.lang.String memberName,
       FwkArrayInterface producerMimeTypes,
       FwkArrayInterface consumerMimeTypes)

The default constructor. It will create the FwkMimeType instance and will set the memeber name. The object will be added ad data producer to the infobus instance and will be registered as producer component.

Parameters:

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

producerMimetypes - An array containing the supported producer mime types.

consumerMimetypes - An array containing the supported consumer mime types.

See Also:

#FwkInfoBusMember.setMemberName

FwkPort

protected FwkPort(java.lang.String memberName,
       java.lang.String producerMimeType,
       java.lang.String consumerMimeType)

The default constructor. It will create the FwkMimeType instance and will set the memeber name. The object will be added ad data producer to the infobus instance and will be registered as producer component.

Parameters:

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

producerMimetype - An string containing the supported producer mime types.

consumerMimetype - An string containing the supported consumer mime types.

See Also:

#FwkInfoBusMember.setMemberName

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 FwkIO

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

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[] producerMimeTypes,
              java.lang.String[] consumerMimeTypes)

Initialize the component.

Parameters:

producerMimeTypes - A string array constaining the producer mimetypes.

consumerMimeTypes - A string array constaining the consumer mimetypes.

unregister

public void unregister()

Unregister the controller. This procedure unregisters the controller as DataItem from the controller bus. Use this method before disconnect or finalize the instance.

register

public void register()

Register the controller. This procedure registers the controller as DataItem at the controller bus.

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.

dataItemRequested

public void dataItemRequested(javax.infobus.InfoBusItemRequestedEvent ev)

DataItemRequestEvent handler. A request of a data item is given. Get the data item look for the key and search in the properies for the value of the property.

Specified by:

dataItemRequested in interface javax.infobus.InfoBusDataProducer

Parameters:

ev - The infobus dataitem, the name of the item is the key.

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)

The property change callback.

Specified by:

propertyChange in interface java.beans.PropertyChangeListener

Parameters:

ev - The property change event.

getConsumerDataFlavor

public java.awt.datatransfer.DataFlavor getConsumerDataFlavor(int index)
                                                       throws FwkException

Return the data flavor of the consumer mimetype.

Specified by:

getConsumerDataFlavor in interface FwkPortInterface

Parameters:

index - The index of the consumer mime type.

Throws:

FwkException - with the error number CANNOT_CREATE_DATAFLAVOR.

getConsumerDataFlavors

public java.awt.datatransfer.DataFlavor[] getConsumerDataFlavors()
                                                          throws FwkException

Return the data flavor array of all consumer mimetypes.

Specified by:

getConsumerDataFlavors in interface FwkPortInterface

Returns:

The dataflavor array of all known consumer mimetypes.

Throws:

FwkException - with the error number AO_EVENT.

addConsumerMimeType

public void addConsumerMimeType(java.lang.String type)

Add a consumer mimetype.

Specified by:

addConsumerMimeType in interface FwkPortInterface

Parameters:

type - Mimetype string to be added.

removeConsumerMimeType

public void removeConsumerMimeType(java.lang.String type)

Remove a consumer mimetype.

Specified by:

removeConsumerMimeType in interface FwkPortInterface

Parameters:

type - Consumer mimetype to be removed.

getConsumerMimeTypes

public java.lang.String[] getConsumerMimeTypes()

Get the consumer mime type string list.

Specified by:

getConsumerMimeTypes in interface FwkPortInterface

Returns:

The consumer mime type string list.

getProducerDataFlavor

public java.awt.datatransfer.DataFlavor getProducerDataFlavor(int index)
                                                       throws FwkException

Return the data flavor of the producer mimetype.

Specified by:

getProducerDataFlavor in interface FwkPortInterface

Parameters:

index - The index of the producer mime type.

Throws:

FwkException - with the error number CANNOT_CREATE_DATAFLAVOR.

getProducerDataFlavors

public java.awt.datatransfer.DataFlavor[] getProducerDataFlavors()
                                                          throws FwkException

Return the data flavor array of all producer mimetypes.

Specified by:

getProducerDataFlavors in interface FwkPortInterface

Returns:

The dataflavor array of all known producer mimetypes.

Throws:

FwkException - with the error number AO_EVENT.

addProducerMimeType

public void addProducerMimeType(java.lang.String type)

Add a producer mimetype.

Specified by:

addProducerMimeType in interface FwkPortInterface

Parameters:

type - Mimetype string to be added.

removeProducerMimeType

public void removeProducerMimeType(java.lang.String type)

Remove a producer mimetype.

Specified by:

removeProducerMimeType in interface FwkPortInterface

Parameters:

type - producer mimetype to be removed.

getProducerMimeTypes

public java.lang.String[] getProducerMimeTypes()

Get the producer mime type string list.

Specified by:

getProducerMimeTypes in interface FwkPortInterface

Returns:

The producer mime type string list.