com.ibm.commerce.condition

Class SimpleCondition

java.lang.Object

com.ibm.commerce.condition.Condition

com.ibm.commerce.condition.SimpleCondition

All Implemented Interfaces:

com.ibm.commerce.base.helpers.Uniquifiable, ConditionConstants, com.ibm.commerce.datatype.Hashable, com.ibm.websphere.cache.Sizeable, java.io.Serializable

public final class SimpleCondition
extends Condition
implements com.ibm.commerce.base.helpers.Uniquifiable, java.io.Serializable, com.ibm.websphere.cache.Sizeable

This class describes a simple condition boolean expression. A simple condition consists of a variable, an operator, and a value with optional qualifiers.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SimpleCondition.Qualifier This class describes a simple condition qualifier.

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

Constructor Summary

Constructors

Constructor and Description
SimpleCondition(java.lang.String variable, java.lang.String operator, java.lang.String value) This constructor takes the variable name, the operator and the value for the simple condition.
SimpleCondition(java.lang.String variable, java.lang.String operator, java.lang.String value, SimpleCondition.Qualifier qualifier) This constructor takes the variable name, the operator, the value and a single qualifier for the simple condition.
SimpleCondition(java.lang.String variable, java.lang.String operator, java.lang.String value, SimpleCondition.Qualifier[] qualifiers) This constructor takes the variable name, the operator, the value and an array of qualifiers for the simple condition.

Method Summary

Modifier and Type	Method and Description
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.
boolean	evaluate(Evaluator evaluator) This method evaluates the simple condition.
long	getObjectSize() Returns the estimated footprint size in bytes of this object and the objects it contains.
java.lang.String	getOperator() Gets the operator name.
SimpleCondition.Qualifier[]	getQualifiers() Gets the array of qualifiers.
java.lang.String	getValue() Gets the value.
java.lang.String	getVariable() Gets the variable name.
int	hashCode() Returns a hash code for this object.
void	setOperator(java.lang.String operator) Sets the operator name.
void	setQualifiers(SimpleCondition.Qualifier[] qualifiers) Sets the array of qualifiers.
void	setValue(java.lang.String value) Sets the value name.
void	setVariable(java.lang.String variable) Sets the variable name.
void	uniquify() Reduces memory footprint of this object.

Methods inherited from class com.ibm.commerce.condition.Condition

getNot, getType, getXMLFragment, loadConditionFromXML, setNot

Methods inherited from class java.lang.Object

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

SimpleCondition

public SimpleCondition(java.lang.String variable,
                       java.lang.String operator,
                       java.lang.String value)

This constructor takes the variable name, the operator and the value for the simple condition.

Parameters:

variable - The variable name.

operator - The operator name.

value - The value.

SimpleCondition

public SimpleCondition(java.lang.String variable,
                       java.lang.String operator,
                       java.lang.String value,
                       SimpleCondition.Qualifier qualifier)

This constructor takes the variable name, the operator, the value and a single qualifier for the simple condition.

Parameters:

variable - The variable name.

operator - The operator name.

value - The value.

qualifier - A qualifier for this simple condition.

SimpleCondition

public SimpleCondition(java.lang.String variable,
                       java.lang.String operator,
                       java.lang.String value,
                       SimpleCondition.Qualifier[] qualifiers)

This constructor takes the variable name, the operator, the value and an array of qualifiers for the simple condition.

Parameters:

variable - The variable name.

operator - The operator name.

value - The value.

qualifiers - An array of Qualifier objects.

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

Overrides:

getObjectSize in class Condition

Returns:

the estimated footprint size in bytes or -1 if a size cannot be determined.

clone

public java.lang.Object clone()

Description copied from class: Condition

Returns a clone of this condition object.

Specified by:

clone in class Condition

Returns:

A clone of this condition object.

getVariable

public java.lang.String getVariable()

Gets the variable name.

Returns:

The variable name.

setVariable

public void setVariable(java.lang.String variable)

Sets the variable name.

Parameters:

variable - The variable name.

getOperator

public java.lang.String getOperator()

Gets the operator name.

Returns:

Return the operator name.

setOperator

public void setOperator(java.lang.String operator)

Sets the operator name.

Parameters:

operator - The operator name.

getValue

public java.lang.String getValue()

Gets the value.

Returns:

Return the value.

setValue

public void setValue(java.lang.String value)

Sets the value name.

Parameters:

value - The value.

getQualifiers

public SimpleCondition.Qualifier[] getQualifiers()

Gets the array of qualifiers.

Returns:

An array of qualifier objects.

setQualifiers

public void setQualifiers(SimpleCondition.Qualifier[] qualifiers)

Sets the array of qualifiers.

Parameters:

qualifiers - An array of qualifier objects.

evaluate

public boolean evaluate(Evaluator evaluator)

This method evaluates the simple condition. The Evaluator implementation is called to evaluate the simple condition. Note that the result will be negated if the not property is true.

Specified by:

evaluate in class Condition

Parameters:

evaluator - An implementation of the Evaluator interface that is used to evaluate the simple conditions.

Returns:

true if the condition is true.

equals

public boolean equals(java.lang.Object aObject)

Returns true if the specified object is equivalent to this object.

Overrides:

equals in class Condition

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 Condition

Returns:

the hash code.

uniquify

public void uniquify()

Reduces memory footprint of this object.

It is expected that the implementation of this method will use the Uniquee class to replace some or all of its properties with equivalent values from the Uniquee cache, or, if equivalent values are not found, place this object's properties in the Uniquee cache.

The caller must be able to promise that this object and its properties, recursively, will never be modified again, so that it and its properties can be shared by other objects.

This method is intended to be called by the Uniquee class.

Specified by:

uniquify in interface com.ibm.commerce.base.helpers.Uniquifiable