|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.commerce.condition.Condition
The Condition class is an abstract class that is used to describe a boolean condition. It has several subclasses that can be combined to form complex expressions. There are public methods that can be used to help convert to and from XML format. The class can also be used to evaluate the condition.
Field Summary | |
static java.lang.String |
COPYRIGHT
Copyright. |
Constructor Summary | |
Condition()
Default constructor. |
Method Summary | |
abstract java.lang.Object |
clone()
Returns a clone of this condition object. |
abstract boolean |
evaluate(Evaluator evaluator)
This abstract method must be implemented by subclasses of this class. |
boolean |
getNot()
Returns true if the condition should have the boolean "NOT" operator applied to the condition. |
int |
getType()
Gets the condition type. |
java.lang.String |
getXMLFragment(java.lang.String indent)
Gets an XML fragment that describes this condition. |
static Condition |
loadConditionFromXML(org.w3c.dom.Element element)
Loads a condition object from an XML element object. |
void |
setNot(boolean not)
Sets the "NOT" attribute of the condition. |
protected void |
setType(int type)
Sets the type of the condition. |
Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String COPYRIGHT
Constructor Detail |
public Condition()
Method Detail |
public abstract java.lang.Object clone()
clone
in class java.lang.Object
public abstract boolean evaluate(Evaluator evaluator)
evaluator
- Used to evaluate instances of SimpleCondition and OpenCondition.true
if the condition evaluates to true.public boolean getNot()
public int getType()
public java.lang.String getXMLFragment(java.lang.String indent)
<!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>
indent
- A string of whitespace that is prefixed to each line of XML produced
by this method.public static Condition loadConditionFromXML(org.w3c.dom.Element element)
element
- An XML Element object.public void setNot(boolean not)
not
- Indicates if the NOT operator should be applied.protected void setType(int type)
type
- The type of this condition.
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |