ABLE, Version 1.1b

com.ibm.able.examples
Class AbleBeanWrapper

java.lang.Object
  |
  +--java.rmi.server.RemoteObject
        |
        +--java.rmi.server.RemoteServer
              |
              +--java.rmi.server.UnicastRemoteObject
                    |
                    +--com.ibm.able.AbleObject
                          |
                          +--com.ibm.able.examples.AbleBeanWrapper

public class AbleBeanWrapper
extends AbleObject
implements java.io.Serializable

This class is a wrapper for custom algorithms. Its intended to allow the developer to implement the interfaces needed to incorporate an algorithm in Able with minimal changes to the original class. To use this class, substitute your own package in place of com\ibm\able\examples, and globally change the string BeanWrapper with the name of your algorithm's class in these class and html files.

Version:
$Revision: 1.2 $, $Date: 2000/09/28 13:17:26 $
See Also:
Serialized Form

Field Summary
static java.lang.String Copyright
          Provide a copyright statement for your package to satisfy intellectual property requirements.
 
Fields inherited from class com.ibm.able.AbleObject
changed, chgSupport, comment, dataFlowEnabled, destBufferConnections, eventQueue, fileName, inputBuffer, listeners, logger, name, outputBuffer, parent, propertyConnectionMgr, sourceBufferConnections, state, stateChgSupport
 
Fields inherited from class java.rmi.server.RemoteObject
ref
 
Constructor Summary
AbleBeanWrapper()
          Construct an AbleBeanWrapper.
AbleBeanWrapper(java.lang.String aName)
          Construct an AbleBeanWrapper with specified name.
 
Method Summary
static java.lang.String Copyright()
          Determine the copyright of this class.
 java.lang.String getSomeProperty()
          Get the value for some String property from the BeanWrapper
 void handleAbleEvent(AbleEvent theEvent)
          Process an AbleEvent sent by another Able bean.
 void init()
          Call any methods in BeanWrapper to initialize the algorithm.
 void process()
          Perform the bean processing function for data buffers.
 void processTimerEvent()
          Perform the bean processing function to do when the timer interval expires.
 void reset()
          Reset the bean to a known initialized state.
 void setSomeProperty(java.lang.String newValue)
          Set the value for some String property in BeanWrapper, and fire a propertyChange event to notify any propertyChange listeners.
 
Methods inherited from class com.ibm.able.AbleObject
addAbleEventListener, addDestBufferConnection, addPropertyChangeListener, addPropertyConnection, addSourceBufferConnection, addStateChangeListener, dataChanged, firePropertyChange, flushAbleEventQueue, getAbleEventListeners, getAbleEventProcessingEnabled, getAbleEventQueueSize, getBuffer, getBufferContents, getComment, getDestBufferConnections, getFileName, getInputBuffer, getInputBuffer, getInputBufferAsStringArray, getInputBufferContents, getLogger, getName, getOutputBuffer, getOutputBuffer, getOutputBufferAsStringArray, getOutputBufferContents, getParent, getPropertyConnectionManager, getSleepTime, getSourceBufferConnections, getState, hasInputBuffer, hasOutputBuffer, init, isAbleEventPostingEnabled, isAbleEventProcessingEnabled, isChanged, isConnectable, isDataFlowEnabled, isTimerEventProcessingEnabled, notifyAbleEventListeners, processAbleEvent, processBufferConnections, processNoEventProcessingEnabledSituation, propertyChange, quitAll, quitEnabledEventProcessing, removeAbleEventListener, removeAllAbleEventListeners, removeAllBufferConnections, removeAllPropertyConnections, removeDestBufferConnection, removePropertyChangeListener, removePropertyConnection, removeSourceBufferConnection, removeStateChangeListener, restartEnabledEventProcessing, restoreFromFile, restoreFromFile, restoreFromSerializedFile, restoreFromStream, resumeAll, resumeEnabledEventProcessing, saveToFile, saveToFile, setAbleEventProcessingEnabled, setChanged, setComment, setDataFlowEnabled, setFileName, setInputBuffer, setInputBuffer, setLogger, setName, setOutputBuffer, setOutputBuffer, setParent, setSleepTime, setState, setTimerEventProcessingEnabled, sourceConnectionsOK, startEnabledEventProcessing, suspendAll, suspendEnabledEventProcessing, toString
 
Methods inherited from class java.rmi.server.UnicastRemoteObject
clone, exportObject, exportObject, exportObject, unexportObject
 
Methods inherited from class java.rmi.server.RemoteServer
getClientHost, getLog, setLog
 
Methods inherited from class java.rmi.server.RemoteObject
equals, getRef, hashCode, toStub
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

Copyright

public static final java.lang.String Copyright
Provide a copyright statement for your package to satisfy intellectual property requirements. Declare it in this class and reference it from others.
Constructor Detail

AbleBeanWrapper

public AbleBeanWrapper()
                throws java.rmi.RemoteException
Construct an AbleBeanWrapper.

AbleBeanWrapper

public AbleBeanWrapper(java.lang.String aName)
                throws java.rmi.RemoteException
Construct an AbleBeanWrapper with specified name. This method may include a call to the init method. Construct the underlying object
Parameters:
aName - A String object specifying the object name

Method Detail

init

public void init()
          throws java.rmi.RemoteException
Call any methods in BeanWrapper to initialize the algorithm. For Able:
  1. Allocate input and output buffers if data buffers will be used
  2. Set processing options for timer events and sleep interval
  3. Set AbleEvent processing options
Overrides:
init in class AbleObject

reset

public void reset()
           throws java.rmi.RemoteException
Reset the bean to a known initialized state. Fire a global property change event.
Overrides:
reset in class AbleObject

process

public void process()
             throws java.rmi.RemoteException
Perform the bean processing function for data buffers.
Throws:
java.rmi.RemoteException -  
Overrides:
process in class AbleObject

processTimerEvent

public void processTimerEvent()
                       throws java.rmi.RemoteException
Perform the bean processing function to do when the timer interval expires.
Throws:
java.rmi.RemoteException -  
Overrides:
processTimerEvent in class AbleObject

handleAbleEvent

public void handleAbleEvent(AbleEvent theEvent)
Process an AbleEvent sent by another Able bean. This is primarily for remote agent use.
Overrides:
handleAbleEvent in class AbleObject

setSomeProperty

public void setSomeProperty(java.lang.String newValue)
                     throws java.rmi.RemoteException
Set the value for some String property in BeanWrapper, and fire a propertyChange event to notify any propertyChange listeners.

getSomeProperty

public java.lang.String getSomeProperty()
Get the value for some String property from the BeanWrapper

Copyright

public static java.lang.String Copyright()
Determine the copyright of this class.
Returns:
A String containing this class's copyright statement.


ABLE, Version 1.1b

ABLE: Produced by Joe, Don, and Jeff who say, 'Thanks for your support.'