com.tridion.smarttarget.entitymodel.query.location.criteria

Class SingleValuedCriterion

java.lang.Object

com.tridion.smarttarget.entitymodel.query.location.criteria.Criterion

com.tridion.smarttarget.entitymodel.query.location.criteria.NegatableCriterion

com.tridion.smarttarget.entitymodel.query.location.criteria.SingleValuedCriterion

All Implemented Interfaces:

Serializable

public class SingleValuedCriterion
extends NegatableCriterion

Class that represents single-valued criteria, as commonly applied to attributes of type int, float and text.

A SingleValuedCriterion can encode that an attribute value must be less than, equal to or greater than or equal to some value. Double bounded ranges can also be represented.

Examples of multi-valued criteria include attribute=tennis, attribute<42 and 4<attribute<17.

Author:

pavel, martin

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.tridion.smarttarget.entitymodel.query.location.criteria.Criterion

Criterion.Operator

Field Summary

Fields inherited from class com.tridion.smarttarget.entitymodel.query.location.criteria.NegatableCriterion

NEGATION

Constructor Summary

Constructors

Constructor and Description
SingleValuedCriterion(String attribute, String value) Instantiates a SingleValuedCriterion that represents an equality test on the given attribute.
SingleValuedCriterion(String attribute, String low, String high, boolean negation) Instantiates a SingleValuedCriterion on the given (int/float/text) attribute.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getGreaterThan() Returns the internal low value.
String	getLessThan() Returns the internal high value.
int	hashCode()
boolean	isEqual() Tells whether this criterion is an equality test.
SingleValuedCriterion	setEqualTo(String value) Sets this criterion to test for equality against the given value.
SingleValuedCriterion	setGreaterThan(String lowParam) Sets the lower bound of this criterion.
SingleValuedCriterion	setLessThan(String highParam) Sets the upper bound of this criterion.
void	toLocation(StringBuilder builder) Appends the string representation of this criterion to the given StringBuilder.

Methods inherited from class com.tridion.smarttarget.entitymodel.query.location.criteria.NegatableCriterion

isNegate, isValidAttributeName, setNegate

Methods inherited from class com.tridion.smarttarget.entitymodel.query.location.criteria.Criterion

getAttributeName, toLocation, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SingleValuedCriterion

public SingleValuedCriterion(String attribute,
                             String value)

Instantiates a SingleValuedCriterion that represents an equality test on the given attribute.

Parameters:

attribute - The non-ML name of the attribute on which this criterion operates.

value - The value to test against.

See Also:

SingleValuedCriterion(String, String, String, boolean)

SingleValuedCriterion

public SingleValuedCriterion(String attribute,
                             String low,
                             String high,
                             boolean negation)

Instantiates a SingleValuedCriterion on the given (int/float/text) attribute.

This criterion will select items which value for the specified attribute is bounded by the given lower and upper bound. These bounds are called the low and high, respectively. The lower bound is inclusive, the upper bound is exclusive. As a special exception, if low equals high then this criterion represents an equality test.

Parameters:

attribute - The non-ML name of the attribute on which this criterion operates.

low - The lower bound for this criterion; null if no lower bound.

high - The upper bound for this criterion; null if no upper bound.

negation - If true this criterion will be configured to be a negation.

Throws:

IllegalArgumentException - If attribute is not a valid attribute name or both low and high are null.

Method Detail

toLocation

public void toLocation(StringBuilder builder)

Appends the string representation of this criterion to the given StringBuilder.

The general contract of this method is that if the StringBuilder contains a valid location ending in a forward slash string prior to invocation of this method, then its contents must also form a valid location string upon completion of this method.

Important: this method will not itself insert a leading slash!

Specified by:

toLocation in class Criterion

Parameters:

builder - The StringBuilder to which the string representation of this criterion is to be appended.

setGreaterThan

public SingleValuedCriterion setGreaterThan(String lowParam)

Sets the lower bound of this criterion.

Parameters:

lowParam - The lower bound for this criterion.

Returns:

This MultiValuedCriterion instance; useful for chained manipulations.

Throws:

IllegalArgumentException - If low is null while the internal high value is null as well.

getGreaterThan

public String getGreaterThan()

Returns the internal low value.

Returns:

The lower bound defined for this criterion; null if no lower bound is set.

setLessThan

public SingleValuedCriterion setLessThan(String highParam)

Sets the upper bound of this criterion.

Parameters:

highParam - The upper bound for this criterion.

Returns:

This MultiValuedCriterion instance; useful for chained manipulations.

Throws:

IllegalArgumentException - If high is null while the internal low value is null as well.

getLessThan

public String getLessThan()

Returns the internal high value.

Returns:

The upper bound defined for this criterion; null if no upper bound is set.

setEqualTo

public SingleValuedCriterion setEqualTo(String value)

Sets this criterion to test for equality against the given value.

Parameters:

value - The value to test against.

Returns:

This SingleValuedCriterion instance; useful for chained manipulations.

Throws:

IllegalArgumentException - If value is null.

isEqual

public boolean isEqual()

Tells whether this criterion is an equality test.

Returns:

true if the internal low and high values are equal; false otherwise.

equals

public boolean equals(Object o)

Overrides:

equals in class NegatableCriterion

hashCode

public int hashCode()

Overrides:

hashCode in class NegatableCriterion