java.lang.Object | +--com.ibm.commerce.rule.RuleSet
This class describes a set of rules.
Field Summary | |
---|---|
static java.lang.String |
COPYRIGHT Copyright. |
Fields inherited from interface com.ibm.commerce.rule. RuleConstants |
XML_DTD_FRAGMENT,
XML_INDENT |
Constructor Summary | |
---|---|
RuleSet(Rule[] rules) This constructor takes an array of Rule
objects. |
Method Summary | |
---|---|
Rule[] |
getRules() Gets the array of Rule objects. |
java.lang.String |
getXMLDocument() Gets an XML document that describes this rule set. |
java.lang.String |
getXMLFragment(java.lang.String indent) Gets an XML fragment that describes the rule set. |
void |
invoke(Evaluator evaluator,
ActionHandler actionHandler) Invokes the ruleset. |
static
RuleSet |
loadRuleSetFromXML(org.w3c.dom.Element element) Loads a RuleSet object from an XML element
object. |
static
RuleSet |
loadRuleSetFromXML(java.lang.String xml) Loads a RuleSet object from an XML document. |
void |
setRules(Rule[] rules) Sets the array of Rule objects. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll,
toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String COPYRIGHT
Constructor Detail |
---|
public RuleSet(Rule[] rules)
Rule
objects.
rules
- An array of Rule
objects.Method Detail |
---|
public Rule[] getRules()
Rule
objects.
Rule
objects.public void setRules(Rule[] rules)
Rule
objects.
rules
- An array of Rule
objects.public void invoke(Evaluator evaluator, ActionHandler actionHandler)
evaluator
- The Evaluator
that is used to
evaluate the condition.actionHandler
- The ActionHandler
that is used to
perform the action.public java.lang.String getXMLDocument()
<!DOCTYPE ruleSet [
<!ELEMENT ruleSet (rule*)>
<!ELEMENT rule (comment?, (orListCondition | andListCondition |
simpleCondition | trueCondition | openCondition), action)>
<!ELEMENT comment EMPTY>
<!ATTLIST comment text CDATA #REQUIRED>
<!ELEMENT action (parameter*)>
<!ATTLIST action name CDATA #REQUIRED>
<!ELEMENT orListCondition (not?, (orListCondition | andListCondition |
simpleCondition | trueCondition | openCondition)+)>
<!ELEMENT andListCondition (not?, (orListCondition | andListCondition |
simpleCondition | trueCondition | openCondition)+)>
<!ELEMENT simpleCondition (not?, variable, operator, value,
qualifier*)>
<!ELEMENT openCondition (not?, parameter*)>
<!ATTLIST openCondition name CDATA #REQUIRED>
<!ELEMENT trueCondition (not?)>
<!ELEMENT not EMPTY>
<!ELEMENT variable EMPTY>
<!ATTLIST variable name CDATA #REQUIRED>
<!ELEMENT operator EMPTY>
<!ATTLIST operator name CDATA #REQUIRED>
<!ELEMENT value EMPTY>
<!ATTLIST value data CDATA #REQUIRED>
<!ELEMENT qualifier EMPTY>
<!ATTLIST qualifier name CDATA #REQUIRED>
<!ATTLIST qualifier data CDATA #REQUIRED>
<!ELEMENT parameter (parameter*)>
<!ATTLIST parameter name CDATA #REQUIRED>
<!ATTLIST parameter value CDATA #REQUIRED>
]>
public java.lang.String getXMLFragment(java.lang.String indent)
<!ELEMENT ruleSet (rule*)>
<!ELEMENT rule (comment?, (orListCondition | andListCondition |
simpleCondition | trueCondition | openCondition), action)>
<!ELEMENT comment EMPTY>
<!ATTLIST comment text CDATA #REQUIRED>
<!ELEMENT action (parameter*)>
<!ATTLIST action name CDATA #REQUIRED>
<!ELEMENT orListCondition (not?, (orListCondition | andListCondition |
simpleCondition | trueCondition | openCondition)+)>
<!ELEMENT andListCondition (not?, (orListCondition | andListCondition |
simpleCondition | trueCondition | openCondition)+)>
<!ELEMENT simpleCondition (not?, variable, operator, value,
qualifier*)>
<!ELEMENT openCondition (not?, parameter*)>
<!ATTLIST openCondition name CDATA #REQUIRED>
<!ELEMENT trueCondition (not?)>
<!ELEMENT not EMPTY>
<!ELEMENT variable EMPTY>
<!ATTLIST variable name CDATA #REQUIRED>
<!ELEMENT operator EMPTY>
<!ATTLIST operator name CDATA #REQUIRED>
<!ELEMENT value EMPTY>
<!ATTLIST value data CDATA #REQUIRED>
<!ELEMENT qualifier EMPTY>
<!ATTLIST qualifier name CDATA #REQUIRED>
<!ATTLIST qualifier data CDATA #REQUIRED>
<!ELEMENT parameter (parameter*)>
<!ATTLIST parameter name CDATA #REQUIRED>
<!ATTLIST parameter value CDATA #REQUIRED>
public static RuleSet loadRuleSetFromXML(java.lang.String xml)
RuleSet
object from an XML document.
xml
- An XML document.RuleSet
object that matches the XML.public static RuleSet loadRuleSetFromXML(org.w3c.dom.Element element)
RuleSet
object from an XML element object.
element
- An XML Element
object.RuleSet
object that matches the XML.