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

Class MultiValuedCriterion

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.MultiValuedCriterion

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

CategoryCriterion

public class MultiValuedCriterion
extends NegatableCriterion

Class that represents multi-valued criteria, as commonly applied to attributes of type list, set and category.

Examples of multi-valued criteria include {a,b}<attribute<{a,b,c}, !attribute>{d,e} and attribute={a;b}.

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
MultiValuedCriterion(String attribute, ValueSet lowSet, ValueSet highSet, boolean negation) Instantiates a MultiValuedCriterion on the given attribute.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
ValueSet	getGreaterThan() Returns a reference to the internal lowSet.
ValueSet	getLessThan() Returns a reference to the internal highSet.
int	hashCode()
boolean	isEqual() Tells whether this criterion is an equality test.
MultiValuedCriterion	setEqualTo(ValueSet valueSet) Sets this criterion to test for equality with the given ValueSet.
MultiValuedCriterion	setGreaterThan(ValueSet lowSetParam) Sets the lower bound of this criterion.
MultiValuedCriterion	setLessThan(ValueSet highSetParam) Sets the upper bound of this criterion.
void	toLocation(StringBuilder buffer) 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

MultiValuedCriterion

public MultiValuedCriterion(String attribute,
                            ValueSet lowSet,
                            ValueSet highSet,
                            boolean negation)

Instantiates a MultiValuedCriterion on the given 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 lowSet and highSet, respectively. If lowSet equals highSet then this criterion represents an equality test.

Parameters:

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

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

highSet - The upper bound ValueSet 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 lowSet and highSet are null.

Method Detail

toLocation

public void toLocation(StringBuilder buffer)

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:

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

setGreaterThan

public MultiValuedCriterion setGreaterThan(ValueSet lowSetParam)

Sets the lower bound of this criterion.

Parameters:

lowSetParam - The lower bound ValueSet for this criterion.

Returns:

This MultiValuedCriterion instance; useful for chained manipulations.

Throws:

IllegalArgumentException - If lowSet is null while the internal highSet is null as well.

getGreaterThan

public ValueSet getGreaterThan()

Returns a reference to the internal lowSet.

Returns:

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

setLessThan

public MultiValuedCriterion setLessThan(ValueSet highSetParam)

Sets the upper bound of this criterion.

Parameters:

highSetParam - The upper bound ValueSet for this criterion.

Returns:

This MultiValuedCriterion instance; useful for chained manipulations.

Throws:

IllegalArgumentException - If highSet is null while the internal lowSet is null as well.

getLessThan

public ValueSet getLessThan()

Returns a reference to the internal highSet.

Returns:

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

setEqualTo

public MultiValuedCriterion setEqualTo(ValueSet valueSet)

Sets this criterion to test for equality with the given ValueSet.

Parameters:

valueSet - The ValueSet to test against.

Returns:

This MultiValuedCriterion instance; useful for chained manipulations.

Throws:

IllegalArgumentException - If valueSet is null.

isEqual

public boolean isEqual()

Tells whether this criterion is an equality test.

Returns:

true if the internal lowSet and highSet are equal; false otherwise.

equals

public boolean equals(Object o)

Overrides:

equals in class NegatableCriterion

hashCode

public int hashCode()

Overrides:

hashCode in class NegatableCriterion