Condition

java.lang.Object
- com.ibm.commerce.condition.Condition

All Implemented Interfaces:

ConditionConstants, com.ibm.websphere.cache.Sizeable, java.io.Serializable

Direct Known Subclasses:

ConditionList, OpenCondition, SimpleCondition, TrueCondition
```
public abstract class Condition
extends java.lang.Object
implements ConditionConstants, java.io.Serializable, com.ibm.websphere.cache.Sizeable
```
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.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String COPYRIGHT
Copyright.
- Fields inherited from interface com.ibm.commerce.condition.ConditionConstants
  AND_LIST_CONDITION, FALSE_VALUE, OPEN_CONDITION, OPERATOR_CONTAINS, OPERATOR_DOES_NOT_CONTAIN, OPERATOR_DOES_NOT_END_WITH, OPERATOR_DOES_NOT_START_WITH, OPERATOR_ENDS_WITH, OPERATOR_EQUAL_TO, OPERATOR_GREATER_THAN, OPERATOR_GREATER_THAN_OR_EQUAL_TO, OPERATOR_LESS_THAN, OPERATOR_LESS_THAN_OR_EQUAL_TO, OPERATOR_NOT_EQUAL_TO, OPERATOR_STARTS_WITH, OR_LIST_CONDITION, SIMPLE_CONDITION, TRUE_CONDITION, TRUE_VALUE, XML_DTD_FRAGMENT, XML_INDENT

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COPYRIGHT` Copyright.

Constructor Summary

Constructors
Constructor and Description

Condition()
Default constructor.

Constructors
Constructor and Description
`Condition()` Default constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`abstract java.lang.Object`	`clone()` Returns a clone of this condition object.
`boolean`	`equals(java.lang.Object aObject)` Returns true if the specified object is equivalent to this 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.
`long`	`getObjectSize()` Returns the estimated footprint size in bytes of this object and the objects it contains.
`int`	`getType()` Gets the condition type.
`java.lang.String`	`getXMLFragment(java.lang.String indent)` Gets an XML fragment that describes this condition.
`int`	`hashCode()` Returns a hash code for this object.
`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
finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - COPYRIGHT
```
public static final java.lang.String COPYRIGHT
```
    Copyright.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Condition
```
public Condition()
```
    Default constructor.
- Method Detail
  - getObjectSize
```
public long getObjectSize()
```
    Returns the estimated footprint size in bytes of this object and the objects it contains.
    
    Specified by:
    
    getObjectSize in interface com.ibm.websphere.cache.Sizeable
    
    Returns:
    
    the estimated footprint size in bytes or -1 if a size cannot be determined.
  - clone
```
public abstract java.lang.Object clone()
```
    Returns a clone of this condition object.
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
    
    A clone of this condition object.
  - setType
```
protected void setType(int type)
```
    Sets the type of the condition. This protected method is called by the concrete subclasses of this class during their construction.
    
    Parameters:
    
    type - The type of this condition.
  - getType
```
public int getType()
```
    Gets the condition type. This type will be equal to one of the following constants: TRUE_CONDITION, OR_LIST_CONDITION, AND_LIST_CONDITION, SIMPLE_CONDITION or OPEN_CONDITION
  - getNot
```
public boolean getNot()
```
    Returns true if the condition should have the boolean "NOT" operator applied to the condition.
  - setNot
```
public void setNot(boolean not)
```
    Sets the "NOT" attribute of the condition. If this is set to true, then it indicates that the boolean "NOT" operator should be applied to the condition.
    
    Parameters:
    
    not - Indicates if the NOT operator should be applied.
  - evaluate
```
public abstract boolean evaluate(Evaluator evaluator)
```
    This abstract method must be implemented by subclasses of this class. Passing an appropriate implementation of the Evaluator interface to this condition will result in the condition being evaluated. The result will indicate if the condition evaluates to true or false.
    
    Parameters:
    
    evaluator - Used to evaluate instances of SimpleCondition and OpenCondition.
    
    Returns:
    
    true if the condition evaluates to true.
  - getXMLFragment
```
public java.lang.String getXMLFragment(java.lang.String indent)
```
    Gets an XML fragment that describes this condition. The XML document will conform to the following DTD fragment:
    &LT;!ELEMENT orListCondition (not?, (orListCondition | andListCondition | simpleCondition | trueCondition | openCondition)+)> &LT;!ELEMENT andListCondition (not?, (orListCondition | andListCondition | simpleCondition | trueCondition | openCondition)+)> &LT;!ELEMENT simpleCondition (not?, variable, operator, value, qualifier*)> &LT;!ELEMENT openCondition (not?, parameter*)> &LT;!ATTLIST openCondition name CDATA #REQUIRED> &LT;!ELEMENT trueCondition (not?)> &LT;!ELEMENT not EMPTY> &LT;!ELEMENT variable EMPTY> &LT;!ATTLIST variable name CDATA #REQUIRED> &LT;!ELEMENT operator EMPTY> &LT;!ATTLIST operator name CDATA #REQUIRED> &LT;!ELEMENT value EMPTY> &LT;!ATTLIST value data CDATA #REQUIRED> &LT;!ELEMENT qualifier EMPTY> &LT;!ATTLIST qualifier name CDATA #REQUIRED> &LT;!ATTLIST qualifier data CDATA #REQUIRED> &LT;!ELEMENT parameter (parameter*)> &LT;!ATTLIST parameter name CDATA #REQUIRED> &LT;!ATTLIST parameter value CDATA #REQUIRED>
    
    Parameters:
    
    indent - A string of whitespace that is prefixed to each line of XML produced by this method.
    
    Returns:
    
    An XML fragment representing this condition.
  - loadConditionFromXML
```
public static Condition loadConditionFromXML(org.w3c.dom.Element element)
```
    Loads a condition object from an XML element object.
    
    Parameters:
    
    element - An XML Element object.
    
    Returns:
    
    A condition object that matches the XML.
  - equals
```
public boolean equals(java.lang.Object aObject)
```
    Returns true if the specified object is equivalent to this object.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    aObject - the specified object.
    
    Returns:
    
    true if the specified object is equivalent to this object.
  - hashCode
```
public int hashCode()
```
    Returns a hash code for this object. Equal objects must return the same hash code.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    the hash code.

Class Condition

Field Summary

Fields inherited from interface com.ibm.commerce.condition.ConditionConstants

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

COPYRIGHT

Constructor Detail

Condition

Method Detail

getObjectSize

clone

setType

getType

getNot

setNot

evaluate

getXMLFragment

loadConditionFromXML

equals

hashCode