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

Class FunctionCriterion

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

All Implemented Interfaces:

Serializable

public class FunctionCriterion
extends NegatableCriterion

Class the represents function criteria.

An example of a function criterion is functionName(param1,param2)<0.

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
FunctionCriterion(String function, String[] parameters, String low, String high, boolean negation) Instantiates a FunctionCriterion for some function call function(parameters).

Method Summary

Modifier and Type	Method and Description
FunctionCriterion	addParameter(String parameter) Adds an extra function parameter to the end of the parameter list.
boolean	equals(Object o)
String	getGreaterThan() Returns the internal low value.
String	getLessThan() Returns the internal high value.
List	getParameters() Returns a reference to the internal list of function parameters.
int	hashCode()
boolean	isEqual() Tells whether this criterion is an equality test.
protected StringBuilder	renderCall(StringBuilder builder) Appends a string representation of the function call to the given StringBuilder.
FunctionCriterion	setEqualTo(String value) Sets this criterion to test for equality against the given value.
FunctionCriterion	setGreaterThan(String lowParam) Sets the lower bound of this criterion.
FunctionCriterion	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

FunctionCriterion

public FunctionCriterion(String function,
                         String[] parameters,
                         String low,
                         String high,
                         boolean negation)

Instantiates a FunctionCriterion for some function call function(parameters).

This criterion will select items for which execution of the specified function call yields a values that 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:

function - The function that is to be called in order to evaluate this criterion.

parameters - A (possibly empty) array of parameters that is to be supplied to function as part of the function call.

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 function is not a valid function 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.

renderCall

protected StringBuilder renderCall(StringBuilder builder)

Appends a string representation of the function call to the given StringBuilder.

Important: the method will append the function call (i.e. the function name followed by comma-separated parameters, wrapped inside parenthesis) only.

Parameters:

builder - The StringBuilder to which the string representation of the function call is to be appended.

Returns:

The same StringBuilder reference that was passed in, i.e. buffer.

addParameter

public FunctionCriterion addParameter(String parameter)

Adds an extra function parameter to the end of the parameter list.

Parameters:

parameter - A new additional parameter.

Returns:

This MultiValuedCriterion instance; useful for chained manipulations.

Throws:

IllegalArgumentException - If parameter is null or empty.

getParameters

public List getParameters()

Returns a reference to the internal list of function parameters.

Returns:

A (possibly empty) list that contains all parameters supplied to the function, in order.

setGreaterThan

public FunctionCriterion 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 FunctionCriterion setLessThan(String highParam)

Sets the upper bound of this criterion.

Parameters:

highParam - The upper bound for this criterion.

Returns:

This FunctionCriterion 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 FunctionCriterion 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