com.ibm.able.rules
Class AbleWhileDoRule

java.lang.Object
  com.ibm.able.rules.AbleRule
      com.ibm.able.rules.AbleWhileDoRule

All Implemented Interfaces:

AbleIterationRule, java.io.Serializable

public class AbleWhileDoRule

extends AbleRule

implements AbleIterationRule, java.io.Serializable

This class defines a while/do "iteration" rule consisting of a boolean test expression and one or more consequent clauses (the body). The conditions are tested before the body is executed. The rule iterates until the test expression evaluates to false.

See Also:

Serialized Form

Field Summary

protected java.util.Vector	myConsequents myConsequents is a list of consequent clauses (AbleConsequentClause objects).
protected AbleExpression	myTestExpression myTestExpression is a boolean expression used to control the loop.

Fields inherited from class com.ibm.able.rules.AbleRule

myBooleanTruth, myBreakpoint, myComment, myEnabled, myFinalFlag, myFiredCount, myFiredFlag, myId, myLabel, myLocation, myPreConditions, myPriority, myPrompt, myProperties, myRdRefs, myRuleBlock, myRuleSet, myTemplateFlag, myTemplateName, myTemplateValues, myWrRefs, PriorityDefault, RuleIdInitial

Constructor Summary

AbleWhileDoRule(java.lang.String theLabel, AbleRd thePriority, AbleExpression theTestExpression, java.util.Vector theConsequents)
Create a new conditional rule with the specified priority, a Boolean test expression, and consequent clauses.

Method Summary

java.lang.String	arlString() Return a formal Able Rule Language (ARL) String.
java.lang.String	armlString() Return a formal XML string.
java.util.Vector	getDoActions() Retrieve the rule's list of "do" action (AbleConsequent) clauses.
int	getNumberOfDoActions() Retrieve the number of "do" actions in this rule.
java.lang.String	getTemplateString(java.util.Vector theTemplateVars) Retrieve a text format string for use by rule templates.
AbleExpression	getTestExpression() Retrieve the rule's test expression.
java.lang.String	toString() Retrieve a string describing (the contents of) the object.
java.lang.String	traceString(int theTraceStringFlavor) Retrieve a string describing (the contents of) the object.
java.lang.String	xmlString() Return a formal XML string.

Methods inherited from class com.ibm.able.rules.AbleRule

addHeaderRdReferences, addRdReference, addRdReferences, addWrReference, addWrReferences, arlActionBlockString, arlPreConditionsString, armlPreConditionsString, armlPriorityString, armlPropertiesString, checkTimePeriodPreConditions, clearBreakpoint, getArlComment, getBooleanTruth, getBreakpoint, getComment, getId, getIdLabelString, getLabel, getLocation, getMetaData, getPreConditions, getPriority, getPrompt, getPromptString, getProperties, getProperty, getRdReferences, getTemplateActionBlockString, getTemplateHeaderString, getTemplateName, getTemplateValues, getTemplateVars, getWrReferences, isDefaultPriority, isEnabled, isFinal, isFired, isGeneratedFromTemplate, isTemplate, logTrace, removeProperty, reset, setBooleanTruth, setBreakpoint, setComment, setEnabled, setFinal, setFired, setId, setLocation, setMetaData, setPreConditions, setPriority, setPrompt, setProperties, setProperty, setTemplate, setTemplateName, setTemplateValues, xmlPreConditionsString, xmlPriorityString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

myTestExpression

protected AbleExpression myTestExpression

myTestExpression is a boolean expression used to control the loop.

myConsequents

protected java.util.Vector myConsequents

myConsequents is a list of consequent clauses (AbleConsequentClause objects).

Constructor Detail

AbleWhileDoRule

public AbleWhileDoRule(java.lang.String theLabel,
                       AbleRd thePriority,
                       AbleExpression theTestExpression,
                       java.util.Vector theConsequents)

Create a new conditional rule with the specified priority, a Boolean test expression, and consequent clauses.

Parameters:

theLabel - The unique label, or name, of this rule.

thePriority - The priority of this rule.

theTestExpression - A boolean expression.

theConsequents - A list of AbleConsequentClause objects that define the consequents of this rule. The list is cloned.

Method Detail

getTestExpression

public final AbleExpression getTestExpression()

Retrieve the rule's test expression.

Specified by:

getTestExpression in interface AbleIterationRule

Returns:

A reference to the test expression.

getNumberOfDoActions

public int getNumberOfDoActions()

Retrieve the number of "do" actions in this rule.

Specified by:

getNumberOfDoActions in interface AbleIterationRule

Returns:

The number of "do" actions.

getDoActions

public final java.util.Vector getDoActions()

Retrieve the rule's list of "do" action (AbleConsequent) clauses.

Specified by:

getDoActions in interface AbleIterationRule

Returns:

A reference to the actual list of do action clauses. This list may not be empty.

arlString

public java.lang.String arlString()

Return a formal Able Rule Language (ARL) String.

Specified by:

arlString in class AbleRule

Returns:

A String describing the object in Able rule language.

xmlString

public java.lang.String xmlString()

Return a formal XML string.

Specified by:

xmlString in class AbleRule

Returns:

A String describing the object in XML.

armlString

public java.lang.String armlString()

Return a formal XML string.

Specified by:

armlString in class AbleRule

Returns:

A String describing the object in XML.

getTemplateString

public java.lang.String getTemplateString(java.util.Vector theTemplateVars)
                                   throws AbleDataException

Retrieve a text format string for use by rule templates. The string contains "{n}" strings, where the index 'n' corresponds to the template variables defined in the rule template. This string is based on the standard arlString() representation of the rule. After replacement of the template variable values, the resulting string must be a valid ARL format string that can be parsed.

Specified by:

getTemplateString in class AbleRule

Parameters:

theTemplateVars - An ordered list of template variables referenced by this rule.

Returns:

A Text format string used to create a new rule instance.

Throws:

AbleDataException

See Also:

AbleRuleTemplate

toString

public java.lang.String toString()

Retrieve a string describing (the contents of) the object.

Overrides:

toString in class AbleRule

Returns:

A String containing the current contents of the object.

traceString

public java.lang.String traceString(int theTraceStringFlavor)

Retrieve a string describing (the contents of) the object.

Specified by:

traceString in class AbleRule

Parameters:

theTraceStringFlavor - An AbleRuleSet.TraceStringFlavor value.

Returns:

A String containing the current contents of the object.