|
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.rules.AbleRuleTemplate
This class allows a user to customize an AbleRule object using a template metaphor. Template variables are used to alter the base rule object and to provide the customized object
Field Summary | |
---|---|
protected java.util.Hashtable |
myGeneratedRules
The list if generated rules |
protected AbleRule |
myRule
The underlying AbleRule object (with the template attribute) used to generate new customized AbleRule object instances. |
protected AbleRuleBlock |
myRuleBlock
The ruleblock object which this rule would be added to |
protected AbleRuleSet |
myRuleSet
The ruleset object which provides the context for this template. |
protected java.util.Vector |
myTemplateVars
The list of template variables referenced by the underlying AbleRule object used to provide customized values for generating new AblRule objects. |
Fields inherited from interface com.ibm.able.rules.AbleTemplate |
---|
serialVersionUID |
Constructor Summary | |
---|---|
AbleRuleTemplate(AbleRuleSet theRuleSet,
AbleRuleBlock theRuleBlock,
AbleRule theRule)
Construct a rule template object from a base rule object |
Method Summary | |
---|---|
void |
addGeneratedRule(AbleRule theGeneratedRule)
|
AbleRule |
createInstance()
Given a list of bound template variables, construct an instance of a new AbleRule object from the template rule. |
protected AbleRule |
createOrReplaceInstance(boolean theReplacementMode)
Given a list of bound template variables, construct an instance of a new AbleRule object from the template rule. |
protected void |
ctorInitTemplateVarList()
Prepend 2 template variables, one for the rule label, and one for the rule comment The rule comment is the first {0} replacement variable The rule label is the second {1} replacement variable |
java.lang.String |
getArlString()
Retrieve the ARL text string (of the underlying rule object) |
java.lang.String |
getComment()
Retrieve the description or comment field of the template (of the underlying ruleset or rule object) |
java.util.Vector |
getGeneratedRules()
|
java.lang.String |
getName()
Retrieve the name of the template (of the underlying rule object) |
java.lang.String |
getPromptString()
Retrieve the name of the template (of the underlying rule object) |
AbleRuleBlock |
getRuleBlock()
Retrieve the ruleblock that this template belongs to |
java.lang.Object[] |
getTemplateVars()
Retrieve the template variables for this template object |
void |
removeGeneratedRule(AbleRule theGeneratedRule)
|
AbleRule |
replaceInstance()
Given a list of bound template variables, construct an instance of a new AbleRule object from the template rule and replace an existing rule with the same label. |
void |
resetTemplateVars()
Calls reset on all template vars to insure they hold the initial values as coded in the ruleset. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected AbleRule myRule
protected AbleRuleSet myRuleSet
protected AbleRuleBlock myRuleBlock
protected java.util.Vector myTemplateVars
protected java.util.Hashtable myGeneratedRules
Constructor Detail |
public AbleRuleTemplate(AbleRuleSet theRuleSet, AbleRuleBlock theRuleBlock, AbleRule theRule) throws AbleDataException
Method Detail |
protected void ctorInitTemplateVarList() throws AbleDataException
protected AbleRule createOrReplaceInstance(boolean theReplacementMode) throws AbleParException
theTemplateVars
- A hashtable containing bound template variablestheReplacementMode
- A boolean true value if we are replacing an existing rule, or false if it is a new rulecreateInstance()
public AbleRule createInstance() throws AbleParException
public AbleRule replaceInstance() throws AbleParException
public java.lang.Object[] getTemplateVars() throws AbleDataException
AbleTemplate
getTemplateVars
in interface AbleTemplate
public void resetTemplateVars() throws AbleDataException
public java.lang.String getName() throws AbleDataException
getName
in interface AbleTemplate
public java.lang.String getComment() throws java.rmi.RemoteException
getComment
in interface AbleTemplate
public java.lang.String getPromptString() throws AbleDataException
public java.lang.String getArlString() throws AbleDataException
getArlString
in interface AbleTemplate
public AbleRuleBlock getRuleBlock()
public void addGeneratedRule(AbleRule theGeneratedRule) throws AbleDataException
public void removeGeneratedRule(AbleRule theGeneratedRule) throws AbleDataException
public java.util.Vector getGeneratedRules()
|
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 |