com.altair.hwm.beans.utils
Class HWMBaseDataItem

java.lang.Object
  extended by com.altair.hwm.beans.utils.HWMBaseDataItem
All Implemented Interfaces:
javax.infobus.DataItem, javax.infobus.DataItemChangeManager, javax.infobus.ImmediateAccess, javax.infobus.InfoBusPropertyMap

public class HWMBaseDataItem
extends java.lang.Object
implements javax.infobus.ImmediateAccess, javax.infobus.DataItem, javax.infobus.DataItemChangeManager, javax.infobus.InfoBusPropertyMap

Title: HWMBaseDataItem

Description: This is a generic DataItem class. Producer Beans using InfoBus can use this class as a base class or as a wrapper for the DataItems that they produce

Company: Altair Engineering, Inc.


Constructor Summary
HWMBaseDataItem()
           
HWMBaseDataItem(java.lang.Object objData, java.lang.String strDataItemName, javax.infobus.InfoBusEventListener infobusEvtListenerSrc)
           
 
Method Summary
 void addDataItemChangeListener(javax.infobus.DataItemChangeListener diChangeListener)
          Registers a DataItemChagnedListener so as to get events whenever the data changes
 java.lang.Object get(java.lang.Object key)
          Stub
 java.awt.datatransfer.DataFlavor[] getDataFlavors()
          Stub
 java.lang.String getPresentationString(java.util.Locale locale)
          Returns the data as a String
 java.lang.Object getProperty(java.lang.String strPropertyName)
          Returns a property or metadata information about the item.
 javax.infobus.InfoBusEventListener getSource()
          Returns the InfoBusEventListener which offers this DataItem on the InfoBus
 java.awt.datatransfer.Transferable getTransferable()
          Stub methods
 java.lang.Object getValueAsObject()
          Returns the data as an Object
 java.lang.String getValueAsString()
          Returns the data as a String
 void release()
          Stub
 void removeDataItemChangeListener(javax.infobus.DataItemChangeListener diChangeListener)
          Removes a DataItemChagnedListener so that the listener will not receive anymore events when data changes
 void setValue(java.lang.Object objData)
          Sets the Value property and sends a DataItemChangeEvent to all registered DataItemChangeListeners
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HWMBaseDataItem

public HWMBaseDataItem()

HWMBaseDataItem

public HWMBaseDataItem(java.lang.Object objData,
                       java.lang.String strDataItemName,
                       javax.infobus.InfoBusEventListener infobusEvtListenerSrc)
Method Detail

setValue

public void setValue(java.lang.Object objData)
Sets the Value property and sends a DataItemChangeEvent to all registered DataItemChangeListeners

Specified by:
setValue in interface javax.infobus.ImmediateAccess
Parameters:
objData - The data object that needs to be passed on the infobus

getValueAsObject

public java.lang.Object getValueAsObject()
Returns the data as an Object

Specified by:
getValueAsObject in interface javax.infobus.ImmediateAccess
Returns:
Object the encapsulated data that needs to be put on the infobus

getValueAsString

public java.lang.String getValueAsString()
Returns the data as a String

Specified by:
getValueAsString in interface javax.infobus.ImmediateAccess
Returns:
String the encapsulated data as a String

getPresentationString

public java.lang.String getPresentationString(java.util.Locale locale)
Returns the data as a String

Specified by:
getPresentationString in interface javax.infobus.ImmediateAccess
Returns:
String the encapsulated data as a String

addDataItemChangeListener

public void addDataItemChangeListener(javax.infobus.DataItemChangeListener diChangeListener)
Registers a DataItemChagnedListener so as to get events whenever the data changes

Specified by:
addDataItemChangeListener in interface javax.infobus.DataItemChangeManager
Parameters:
diChangeListener - the Listener who is interested in an event whenever data changes

removeDataItemChangeListener

public void removeDataItemChangeListener(javax.infobus.DataItemChangeListener diChangeListener)
Removes a DataItemChagnedListener so that the listener will not receive anymore events when data changes

Specified by:
removeDataItemChangeListener in interface javax.infobus.DataItemChangeManager
Parameters:
diChangeListener - the Listener to remove

getTransferable

public java.awt.datatransfer.Transferable getTransferable()
Stub methods


getSource

public javax.infobus.InfoBusEventListener getSource()
Returns the InfoBusEventListener which offers this DataItem on the InfoBus

Specified by:
getSource in interface javax.infobus.DataItem
Returns:
the InfoBusEventListener source for this DataItem

getProperty

public java.lang.Object getProperty(java.lang.String strPropertyName)
Returns a property or metadata information about the item. It is recommended that the "Name" property be supported for announced data items, and that it return the String representing the data item name used for announcement or request. Support for other properties and the "Name" property for sub-items is optional.

Specified by:
getProperty in interface javax.infobus.DataItem
Parameters:
propertyName - - the name of the property requested. Property names must not contain the '*' character
Returns:
String This returns the name of the data item if strPropertyName = "name"

get

public java.lang.Object get(java.lang.Object key)
Stub

Specified by:
get in interface javax.infobus.InfoBusPropertyMap

getDataFlavors

public java.awt.datatransfer.DataFlavor[] getDataFlavors()
Stub


release

public void release()
Stub

Specified by:
release in interface javax.infobus.DataItem