|
ABLE 2.0.0 07/02/2003 10:25:01 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The AbleBean interface represents the basic ABLE object, and is a
composite of interfaces that defines the methods for passing data
between beans with either databuffers or synchronous or asynchronous events.
It also has specific methods for its name, comment, logging, tracing,
parentage, and methods which result in state changes such as init()
,
suspendAll()
and reset()
.
Method Summary | |
---|---|
java.lang.String |
getComment()
Returns the comment associated with this bean. |
AbleLogger |
getLogger()
Returns the current message logger. |
java.lang.String |
getName()
Returns the name of this bean. |
AbleBeanContainer |
getParent()
Returns the containing parent of this bean. |
int |
getState()
Returns the current state of this bean. |
AbleLogger |
getTraceLogger()
Returns the current trace logger. |
void |
init()
Initialize and configure the bean. |
void |
init(java.lang.Object theArg)
Initialize and configure the bean, using the specified Object. |
boolean |
isChanged()
Indicates if the bean has been changed since the last serialization operation. |
void |
process()
Performs the main, synchronous, standard processing function performed by this bean. |
java.lang.Object |
process(java.lang.Object theArg)
Performs the main, standard processing function performed by this bean, using the argument Object, which usually would be passed via an AbleEvent. |
void |
quitAll()
Stop all of the bean's asynchronous threads of control. |
void |
removeAllConnections()
Removes all Property, Buffer, and Event connections. |
void |
reset()
Reset this bean. |
void |
resumeAll()
Resume all of the bean's suspended asynchronous threads of control. |
void |
setChanged(boolean theChangedFlag)
Set the changed flag. |
void |
setComment(java.lang.String theComment)
Sets (or changes) the comment associated with this bean. |
void |
setLogger(AbleLogger theLogger)
Sets the logger to be used for message output. |
void |
setName(java.lang.String theName)
Set or change the name of this bean. |
void |
setParent(AbleBeanContainer theAbleBeanContainer)
Sets the containing parent of this bean. |
void |
setState(int theState)
Sets the state of this bean. |
void |
setTraceLogger(AbleLogger theLogger)
Sets the logger to be used for tracing program-level output. |
void |
suspendAll()
Temporarily suspend all of the bean's asynchronous threads of control. |
Methods inherited from interface com.ibm.able.AbleEventListener |
---|
handleAbleEvent |
Methods inherited from interface com.ibm.able.AbleEventListenerManager |
---|
addAbleEventListener, dataChanged, getAbleEventListeners, notifyAbleEventListeners, removeAbleEventListener |
Methods inherited from interface com.ibm.able.AbleEventQueueProcessor |
---|
processAbleEvent, processNoEventProcessingEnabledSituation, processTimerEvent |
Methods inherited from interface com.ibm.able.AblePropertyChangeManager |
---|
addPropertyChangeListener, addPropertyConnection, getPropertyConnectionManager, removeAllPropertyConnections, removePropertyChangeListener, removePropertyConnection |
Methods inherited from interface com.ibm.able.AbleSerializable |
---|
getFileName, restoreFromFile, restoreFromFile, saveToFile, saveToFile, setFileName |
Method Detail |
public void setName(java.lang.String theName)
theName
- The new name of this bean. This
name replaces the current name.public java.lang.String getName()
public void setComment(java.lang.String theComment)
theComment
- The new comment for this bean.
This comment replaces the current comment.public java.lang.String getComment()
public void setChanged(boolean theChangedFlag)
theChangedFlag
- The value indicating whether this bean is to be
marked as modified. If true
, the bean will be
marked as modified; otherwise, the bean will be marked
as unmodified. Saving or serializing the bean should reset
the change flag to unmodified.public boolean isChanged()
true
if the bean has been changed since the
last save; false
otherwise.public void setLogger(AbleLogger theLogger)
If a logger is available and is active, it will be used to log translated messages.
theLogger
- A logger that can be used to record translated messages. The
value cannot be null.public AbleLogger getLogger()
getLogger
in interface AbleEventQueueProcessor
public void setTraceLogger(AbleLogger theLogger)
If a logger is available and is active, base ABLE code will use it to log trace messages.
theLogger
- A logger that can be used to trace base ABLE code. The
value cannot be null.public AbleLogger getTraceLogger()
public void setParent(AbleBeanContainer theAbleBeanContainer)
theAbleBeanContainer
- An ABLE bean container object in which this bean
currently resides. Note that a bean may only
have one parent at any given time, so this new parent
completely replaces the current parent.public AbleBeanContainer getParent()
public void setState(int theState)
setState
in interface AbleEventQueueProcessor
theState
- An AbleState
value.public int getState()
getState
in interface AbleEventQueueProcessor
AbleState
value.public void removeAllConnections() throws AbleException
AbleException
- If an error occurs.public void init() throws AbleException
AbleState.Initiated
or
AbleState.Waiting
.
If the implementation provides property change notification, decide whether to send only one property change event or an event for each property.
A bean implementing AbleBeanContainer
may choose to call this method
on each bean it contains and accumulate errors from each contained bean.
AbleException
- If an error occurs.public void init(java.lang.Object theArg) throws AbleException
AbleEventQueueManager.startEnabledEventProcessing()
The bean's state changes to AbleState.Initiated
or
AbleState.Waiting
.
A bean implementing AbleBeanContainer
may choose to call this method
on each bean it contains and accumulate errors from each contained bean.
theArg
- An Object used to initialize the bean, typically by
getting parameters of interest.AbleException
- If an error occurs.public void reset() throws AbleException
init()
to be called next?
Should reset itself call init()
?
AbleState
?
A bean implementing AbleBeanContainer
should reset
each bean it contains and accumulate errors from each contained bean.
AbleException
- If an error occurs.public void process() throws AbleException
AbleEvent.DATACHANGED
event should be propagated
to registered listeners.
A bean implementing AbleBeanContainer
may choose to call process
on each bean it contains and accumulate errors from each contained bean.
AbleException
- If an error occurs.public java.lang.Object process(java.lang.Object theArg) throws AbleException
A bean implementing AbleBeanContainer
may choose to call process
on each bean it contains and accumulate errors from each contained bean.
theArg
- An Object used to provide data for the bean derive a result.AbleException
- If an error occurs.public void quitAll() throws AbleException
AbleState.Unknown
.
If the bean is a simple AbleBean, this method just calls
AbleEventQueueManager.quitEnabledEventProcessing()
.
A bean implementing AbleBeanContainer
should call quitAll
on each bean it contains and accumulate errors from each contained bean.
AbleException
- If an error occurs.public void suspendAll() throws AbleException
AbleState.Suspended
.
If the bean is a simple AbleBean, this method just calls its
AbleEventQueueManager.suspendEnabledEventProcessing()
method.
A bean implementing AbleBeanContainer
should call this method
on each bean it contains and accumulate errors from each contained bean.
AbleException
- If an error occurs.public void resumeAll() throws AbleException
AbleState.Suspended
to
AbleState.Waiting
.
If the bean is a simple AbleBean, this method just calls its
AbleEventQueueManager.resumeEnabledEventProcessing()
method.
A bean implementing AbleBeanContainer
should call this method
on each bean it contains and accumulate errors from each contained bean.
AbleException
- If an error occurs.
|
ABLE 2.0.0 07/02/2003 10:25:01 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |