|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.dse.base.DSENotifier | +--com.ibm.dse.automaton.DSEAction
Default implementation of an Action. User Actions can inherit this and implement the execute().
Additional description
Field Summary | |
protected Context |
context
|
protected Tag |
inputMapFmtTag
|
protected Tag |
operationTag
|
protected Tag |
outputMapFmtTag
|
protected DSEEventObject |
sourceEvent
|
protected Tag |
tag
|
Fields inherited from class com.ibm.dse.base.DSENotifier |
handlersList,
name |
Constructor Summary | |
DSEAction()
Creates an instance of type DSEAction. |
|
DSEAction(boolean mustRegister)
Creates an instance of type DSEAction. |
|
DSEAction(java.lang.String aName)
Creates an instance of type DSEAction. |
|
DSEAction(java.lang.String aName,
java.lang.String aTID)
Creates an instance of type DSEAction. |
Method Summary | |
boolean |
chainOrAssignContext()
This method checks to see if the action has an externally defined context, if not then the processor's is assigned. |
boolean |
chainOrAssignContext(Action thisAction)
Deprecated. |
void |
close()
This method is for closing actions and releasing the processor and context objects. |
void |
close(boolean wasChained)
This method is for actions that had their context's chained to the processor's. |
boolean |
evaluateGuardCondition(GuardCondition gc)
Evaluate the guardCondition specified. |
abstract void |
execute()
Abstract execute method to be implemented by concrete instantiations to do whatever this Action is supposed to do. |
Externalizer |
externalizer()
This method gets the externalizer instance used to build. |
Context |
getContext()
Returns the value of the context property. |
Vector |
getGuardConditions()
Returns a Vector containing the GuardConditions for this Action |
Tag |
getInputMapFmtTag()
This method returns the value of the inputMapFmtTag |
Tag |
getOperationTag()
This method returns the value of the operationTag |
Tag |
getOutputMapFmtTag()
This method returns the value of the outputMapFmtTag |
java.util.Hashtable |
getParms()
Returns a hashtable of the Action's parameters. |
Processor |
getProcessor()
Returns the value of the processor property. |
DSEEventObject |
getSourceEvent()
Returns the value of the sourceEvent property. |
java.lang.Object |
initializeFrom(Tag aTag)
The action tag's id is used as the Notifier name of the action for the inherited method setName(). |
protected void |
mapTheInput(Context actionContext,
Context opContext)
This method is used for sharing data between contexts. |
protected void |
mapTheOutput(Context opContext,
Context processorContext)
This method is used for sharing data between contexts. |
void |
preProcess()
This is invoked just before the execute method. |
void |
readExternal()
This method will find the tag that corresponds to the name of THIS entity. |
void |
readExternal(java.io.ObjectInput in)
Invokes the object creation from an ObjectInput. |
void |
removeExternal()
Removes the Externalizer. |
void |
setContext(Context newContext)
Sets the value of the context property. |
void |
setGuardConditions(Vector newGuardConditions)
Sets the value of the guardConditions property. |
void |
setInputMapFmtTag(Tag nextSubTag)
This method sets the value of the inputMapFmtTag |
void |
setOperationTag(Tag nextSubTag)
This method sets the value of the operationTag |
void |
setOutputMapFmtTag(Tag nextSubTag)
This method sets the value of the outputMapFmtTag |
void |
setParms(java.util.Hashtable newParms)
This method sets the hashtable of the Action's parameters. |
void |
setProcessor(Processor newProcessor)
Sets the value of the processor property. |
void |
setSourceEvent(DSEEventObject newSourceEvent)
Sets the value of the sourceEvent property. |
java.lang.String |
toString()
Returns a String representing the action. |
Vector |
toStrings()
Returns a Vector with the String representation of the object. |
Vector |
toTags()
Returns a Vector with the object represented as a Tag. |
void |
writeExternal()
Writes this instance (converted into tags) to a file. |
void |
writeExternal(java.io.ObjectOutput out)
Provides concrete serialization handling for DSEAction. |
Methods inherited from class com.ibm.dse.base.DSENotifier |
addHandler,
getHandlersList,
getName,
removeHandler,
setName,
signalEvent,
signalEvent,
signalEvent,
terminate |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
wait,
wait,
wait |
Field Detail |
protected DSEEventObject sourceEvent
protected Context context
protected Tag tag
protected Tag inputMapFmtTag
protected Tag outputMapFmtTag
protected Tag operationTag
Constructor Detail |
public DSEAction()
public DSEAction(java.lang.String aName)
aName
- java.lang.Stringpublic DSEAction(java.lang.String aName, java.lang.String aTID)
aName
- java.lang.StringaTID
- java.lang.Stringpublic DSEAction(boolean mustRegister)
mustRegister
- booleanMethod Detail |
public boolean chainOrAssignContext()
public boolean chainOrAssignContext(Action thisAction)
public void close()
public void close(boolean wasChained)
wasChained
- booleanpublic boolean evaluateGuardCondition(GuardCondition gc)
gc
- com.ibm.dse.automaton.GuardConditionpublic abstract void execute() throws java.lang.Exception
public Externalizer externalizer() throws java.io.IOException
public Context getContext()
public Vector getGuardConditions()
public Tag getInputMapFmtTag()
public Tag getOperationTag()
public Tag getOutputMapFmtTag()
public java.util.Hashtable getParms()
public Processor getProcessor()
public DSEEventObject getSourceEvent()
public java.lang.Object initializeFrom(Tag aTag) throws java.io.IOException, DSEException
aTag
- com.ibm.dse.base.Tag Contains the name and attributes of the object to be created.protected void mapTheInput(Context actionContext, Context opContext) throws DSEInvalidRequestException
actionContext
- com.ibm.dse.base.ContextOpContext
- com.ibm.dse.base.Contextprotected void mapTheOutput(Context opContext, Context processorContext) throws DSEInvalidRequestException
OpContext
- com.ibm.dse.base.ContextactionContext
- com.ibm.dse.base.Contextpublic void preProcess() throws java.lang.Exception
public void readExternal() throws java.io.IOException
public void readExternal(java.io.ObjectInput in) throws java.io.IOException, java.lang.ClassNotFoundException
in
- java.io.ObjectInputpublic void removeExternal() throws java.io.IOException
public void setContext(Context newContext)
newContext
- com.ibm.dse.base.Contextpublic void setGuardConditions(Vector newGuardConditions)
newGuardConditions
- com.ibm.dse.base.Vectorpublic void setInputMapFmtTag(Tag nextSubTag)
public void setOperationTag(Tag nextSubTag)
public void setOutputMapFmtTag(Tag nextSubTag)
public void setParms(java.util.Hashtable newParms)
newParms
- java.util.Hashtablepublic void setProcessor(Processor newProcessor)
newProcessor
- com.ibm.dse.automaton.Processorpublic void setSourceEvent(DSEEventObject newSourceEvent)
newSourceEvent
- com.ibm.dse.base.DSEEventObjectpublic java.lang.String toString()
public Vector toStrings()
public Vector toTags() throws java.io.IOException
public void writeExternal() throws java.io.IOException
public void writeExternal(java.io.ObjectOutput out) throws java.io.IOException
out
- java.io.ObjectOutput
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |