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

Class Criterion

java.lang.Object

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

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

NegatableCriterion, SearchCriterion

public abstract class Criterion
extends Object
implements Serializable

This abstract class is the superclass of all criteria in a Location object.

Following table relates Criterion implementations to their respective syntax and semantics:

SingleValuedCriterion	attribute=value	equals to value
	attribute<value	small or equal to value
	attribute>value	greater or equal to value
	value1<attribute<value2	between values
	value1>attribute>value2	between values
MultiValuedCriterion	attribute={value1,value2,...}	equals to set
	attribute<{value1,value2,...}	contained in (subset of)
	attribute>{value1,value2,...}	contains
	attribute>{value1;value2;...}	contains at least one out of
	!attribute>{value}	does not contain
FunctionCriterion	function_name(argument,...)=value	function with arguments must be equal to value
	function_name(argument,...)<value	function with arguments must be less than a value
	function_name(argument,...)>value	function with arguments must be greater than a value
SearchCriterion	$s=search_phrase;t=profile;p=passId	search for search_phrase with profile and passId

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Criterion.Operator An enumeration of all possible criterion operators.

Field Summary

Fields

Modifier and Type	Field and Description
static char	NEGATION Deprecated. Use the more appropriately located constant NegatableCriterion.NEGATION instead.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Criterion(String attribute) Initialises a new Criterion instance that operates on the given attribute.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getAttributeName() Returns the attribute on which this criterion operates.
int	hashCode()
String	toLocation() Returns the string representation of this criterion with a leading slash.
abstract void	toLocation(StringBuilder buffer) Appends the string representation of this criterion to the given StringBuilder.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

NEGATION

@Deprecated
public static final char NEGATION

Deprecated. Use the more appropriately located constant NegatableCriterion.NEGATION instead.

The sign used to indicate negation of a criterion, as modelled by the NegatableCriterion class.

See Also:

Constant Field Values

Constructor Detail

Criterion

protected Criterion(String attribute)

Initialises a new Criterion instance that operates on the given attribute.

Parameters:

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

Throws:

IllegalArgumentException - If the attribute is null or empty.

Method Detail

getAttributeName

public final String getAttributeName()

Returns the attribute on which this criterion operates.

Returns:

The name of the attribute to which this criterion applies.

toLocation

public String toLocation()

Returns the string representation of this criterion with a leading slash.

Returns:

A well-formed FAS location criterion.

toLocation

public abstract 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!

Parameters:

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

toString

public String toString()

Overrides:

toString in class Object

Returns:

A string identical to the result of a call to toLocation().

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object