|
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 |
java.lang.Object | +--com.ibm.able.AbleObject | +--com.ibm.able.AbleDefaultAgent | +--com.ibm.able.agents.AbleScriptAgent
The AbleScriptAgent behavior is defined by (up to) 3 separate AbleRuleSets
Field Summary | |
---|---|
static java.lang.String |
defaultName
Value assigned to name by default. |
protected AbleRuleSet |
initScript
The initScript object is created from a ruleset named by the initScriptFileName when the agent is initialized. |
protected java.lang.String |
initScriptFileName
A String used to construct and initialize the bean used to initialize the agent. |
protected AbleRuleSet |
processScript
The processScript object is created from a ruleset named by the processScriptFileName when the agent is initialized. |
protected java.lang.String |
processScriptFileName
A String used to construct and initialize the bean used to process the agent. |
protected AbleRuleSet |
processTimerScript
The processTimerScript object is created from a ruleset named by the processTimerScriptFileName when the agent is initialized. |
protected java.lang.String |
processTimerScriptFileName
A String used to construct and initialize the bean used to process agent timer events. |
protected static long |
serialVersionUID
Serialized version identifier in form YYYYMMDDVerRelModxx |
Fields inherited from class com.ibm.able.AbleDefaultAgent |
---|
activeDataSource, eventConnections, myBeans, numEpochs, processList, processListOK, userDefinedFunctions |
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, trace |
Constructor Summary | |
---|---|
AbleScriptAgent()
|
|
AbleScriptAgent(java.lang.String aName)
|
Method Summary | |
---|---|
static java.lang.String |
Copyright()
Determine the copyright of this class. |
java.lang.Object |
getInitScript()
Get the object processed when the agent is initialized. |
java.lang.String |
getInitScriptFileName()
Get the file name used to construct and initialize the bean called when the agent is initialized. |
java.lang.Object |
getProcessScript()
Get the object processed when the agent is processed. |
java.lang.String |
getProcessScriptFileName()
Get the file name used to construct and initialize the bean called when the agent is processed. |
java.lang.Object |
getProcessTimerScript()
Get the object processed when the agent receives a timer event. |
java.lang.String |
getProcessTimerScriptFileName()
Get the file name used to construct and initialize the bean called when the agent is is to process a timer event. |
void |
init()
Initialize the Script agent by constructing and initializing the init, process, and processTimer beans if they are specified. |
void |
process()
Invoke the processRuleSet so user can completely define the process() behavior of this agent (and contained beans) The AbleScriptAgent inputBuffer is passed to the processRuleSet (if any) The processRuleSet outputBuffer (if any) is passed to the Agent's outputBuffer |
void |
processTimerEvent()
Invoke the process method on the processTimerScript. |
void |
reset()
Reset the init, process, and processTimerEvent ruleset beans in the agent if they exist. |
protected void |
setDefaults()
Set processing options to default values. |
void |
setInitScriptFileName(java.lang.String fileName)
Set the file name used to construct and initialize the bean called when the agent is initialized. |
void |
setProcessScriptFileName(java.lang.String fileName)
Set the file name used to construct and initialize the bean called when the agent is processed. |
void |
setProcessTimerScriptFileName(java.lang.String fileName)
Set the file name used to construct and initialize the bean called when the agent is is to process a timer event. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.ibm.able.AbleBean |
---|
getComment, getLogger, getName, getParent, getState, getTraceLogger, init, isChanged, process, setChanged, setComment, setLogger, setName, setParent, setState, setTraceLogger |
Methods inherited from interface com.ibm.able.AbleEventListenerManager |
---|
addAbleEventListener, dataChanged, getAbleEventListeners, notifyAbleEventListeners, removeAbleEventListener |
Methods inherited from interface com.ibm.able.AbleEventQueueProcessor |
---|
processAbleEvent, processNoEventProcessingEnabledSituation |
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 |
Methods inherited from interface com.ibm.able.AbleBeanContainer |
---|
getName |
Field Detail |
public static final java.lang.String defaultName
protected static final long serialVersionUID
protected AbleRuleSet initScript
protected AbleRuleSet processScript
protected AbleRuleSet processTimerScript
protected java.lang.String initScriptFileName
protected java.lang.String processScriptFileName
protected java.lang.String processTimerScriptFileName
Constructor Detail |
public AbleScriptAgent() throws AbleException
public AbleScriptAgent(java.lang.String aName) throws AbleException
Method Detail |
public void setInitScriptFileName(java.lang.String fileName)
public java.lang.String getInitScriptFileName()
public void setProcessScriptFileName(java.lang.String fileName)
public java.lang.String getProcessScriptFileName()
public void setProcessTimerScriptFileName(java.lang.String fileName)
public java.lang.String getProcessTimerScriptFileName()
public java.lang.Object getInitScript()
public java.lang.Object getProcessScript()
public java.lang.Object getProcessTimerScript()
public void init() throws AbleException
init
in class AbleObject
com.ibm.able.AbleBean
AbleException
- If an error occurs.public void reset() throws AbleException
reset
in class AbleDefaultAgent
com.ibm.able.AbleDefaultAgent
AbleException
- If an error occurs when resetting
a contained bean. All errors are
collected and insert into the exception
so that one bean's error does not
prevent another from being reset.protected void setDefaults() throws AbleException
public void process() throws AbleException
process
in class AbleDefaultAgent
com.ibm.able.AbleDefaultAgent
AbleException
- If an error occurs. Errors from each contained
bean are accumulated.public void processTimerEvent() throws AbleException
processTimerEvent
in class AbleObject
com.ibm.able.AbleEventQueueProcessor
AbleException
- If an error occurs.public static java.lang.String Copyright()
|
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 |