com.tridion.smarttarget.query.builder

Class AttributeCriteria

java.lang.Object

com.tridion.smarttarget.query.builder.AttributeCriteria

All Implemented Interfaces:

com.tridion.smarttarget.query.builder.Criteria, com.tridion.smarttarget.query.builder.LocationCriteria

public final class AttributeCriteria
extends Object
implements com.tridion.smarttarget.query.builder.LocationCriteria

Criteria that is used to query on attributes. Supported Value Types: - String - Date, in the format of yyyy-MM-dd'T'HH:mm:ss.SSSZZ - Double - Boolean

Constructor Summary

Constructors

Constructor and Description
AttributeCriteria(String name, List<?> values, com.tridion.smarttarget.query.builder.Operator operator, boolean negate) Constructor that can be used for all Operator types (MultiValueOperator, SingleValueOperator or RangeOperator).
AttributeCriteria(String name, Number lowerBound, Number upperBound, RangeOperator operator, boolean negate) Constructor for range operations with Number bounds.
AttributeCriteria(String name, Number value, SingleValueOperator operator, boolean negate) Constructor for Single Value operations for a Number value.
AttributeCriteria(String name, OffsetDateTime lowerBound, OffsetDateTime upperBound, RangeOperator operator, boolean negate) Constructor for range operations with OffsetDateTime bounds.
AttributeCriteria(String name, OffsetDateTime value, SingleValueOperator operator, boolean negate) Constructor for Single Value operations for an OffsetDateTime value.
AttributeCriteria(String name, String value, SingleValueOperator operator, boolean negate) Constructor for Single Value operations for a String value.
AttributeCriteria(String name, String lowerBound, String upperBound, RangeOperator operator, boolean negate) Constructor for range operations with String bounds.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getLocation(String universe)
Object	getLowerBoundValue() Gets the lower bound value of the AttributeCriteria in case of a 'Between' RangeOperator, null otherwise.
String	getName() Gets the name of the AttributeCriteria.
com.tridion.smarttarget.query.builder.Operator	getOperator() Gets the Operator of the AttributeCriteria.
Object	getUpperBoundValue() Gets the upper bound value of the AttributeCriteria in case of a 'Between' RangeOperator, null otherwise.
List<?>	getValues() Get the attributeValues of the AttributeCriteria as a list.
int	hashCode()
boolean	isNegate() A flag indicating if this Attribute's operation should be negated.
static com.tridion.smarttarget.query.builder.Operator	parseOperator(String value) Parses the string representation of a SingleValueOperator, MultiValueOperator or RangeOperator.
String	toString()
List<Object>	visitCriteria(List<Object> criteriaList)

Methods inherited from class java.lang.Object

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

Constructor Detail

AttributeCriteria

public AttributeCriteria(String name,
                         String value,
                         SingleValueOperator operator,
                         boolean negate)
                  throws com.tridion.smarttarget.SmartTargetException

Constructor for Single Value operations for a String value.

Parameters:

name - The name of the Attribute.

value - the value of the Attribute.

operator - The operation.

negate - A flag that defines if this filter should be negated.

Throws:

com.tridion.smarttarget.SmartTargetException

AttributeCriteria

public AttributeCriteria(String name,
                         Number value,
                         SingleValueOperator operator,
                         boolean negate)
                  throws com.tridion.smarttarget.SmartTargetException

Constructor for Single Value operations for a Number value. t: specific type constructors.

Parameters:

name - The name of the Attribute.

value - the value of the Attribute.

operator - The operation.

negate - A flag that defines if this filter should be negated.

Throws:

com.tridion.smarttarget.SmartTargetException

AttributeCriteria

public AttributeCriteria(String name,
                         OffsetDateTime value,
                         SingleValueOperator operator,
                         boolean negate)
                  throws com.tridion.smarttarget.SmartTargetException

Constructor for Single Value operations for an OffsetDateTime value. t: specific type constructors.

Parameters:

name - The name of the Attribute.

value - the value of the Attribute.

operator - The operation.

negate - A flag that defines if this filter should be negated.

Throws:

com.tridion.smarttarget.SmartTargetException

AttributeCriteria

public AttributeCriteria(String name,
                         List<?> values,
                         com.tridion.smarttarget.query.builder.Operator operator,
                         boolean negate)
                  throws com.tridion.smarttarget.SmartTargetException

Constructor that can be used for all Operator types (MultiValueOperator, SingleValueOperator or RangeOperator). Attempts to detect and parse to type.

Parameters:

name - The name of the Attribute.

values - A list of attributeValues.

operator - The operation.

negate - A flag that defines if this filter should be negated.

Throws:

com.tridion.smarttarget.SmartTargetException

AttributeCriteria

public AttributeCriteria(String name,
                         String lowerBound,
                         String upperBound,
                         RangeOperator operator,
                         boolean negate)
                  throws com.tridion.smarttarget.SmartTargetException

Constructor for range operations with String bounds.

Parameters:

name - The name of the Attribute.

lowerBound - the lower bound of the range (inclusive).

upperBound - the upper bound of the range (exclusive).

operator - The operation.

negate - A flag that defines if this filter should be negated.

Throws:

com.tridion.smarttarget.SmartTargetException

AttributeCriteria

public AttributeCriteria(String name,
                         Number lowerBound,
                         Number upperBound,
                         RangeOperator operator,
                         boolean negate)
                  throws com.tridion.smarttarget.SmartTargetException

Constructor for range operations with Number bounds.

Parameters:

name - The name of the Attribute.

lowerBound - the lower bound of the range (inclusive).

upperBound - the upper bound of the range (exclusive).

operator - The operation.

negate - A flag that defines if this filter should be negated.

Throws:

com.tridion.smarttarget.SmartTargetException

AttributeCriteria

public AttributeCriteria(String name,
                         OffsetDateTime lowerBound,
                         OffsetDateTime upperBound,
                         RangeOperator operator,
                         boolean negate)
                  throws com.tridion.smarttarget.SmartTargetException

Constructor for range operations with OffsetDateTime bounds.

Parameters:

name - The name of the Attribute.

lowerBound - the lower bound of the range (inclusive).

upperBound - the upper bound of the range (exclusive).

operator - The operation.

negate - A flag that defines if this filter should be negated.

Throws:

com.tridion.smarttarget.SmartTargetException

Method Detail

getLocation

public String getLocation(String universe)

Specified by:

getLocation in interface com.tridion.smarttarget.query.builder.LocationCriteria

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

parseOperator

public static com.tridion.smarttarget.query.builder.Operator parseOperator(String value)
                                                                    throws com.tridion.smarttarget.SmartTargetException

Parses the string representation of a SingleValueOperator, MultiValueOperator or RangeOperator.

Parameters:

value - The string representation of an operator.

Returns:

The Operator.

Throws:

com.tridion.smarttarget.SmartTargetException - when the operator is unknown.

getName

public String getName()

Gets the name of the AttributeCriteria.

Returns:

The name of the AttributeCriteria.

getValues

public List<?> getValues()

Get the attributeValues of the AttributeCriteria as a list.

Returns:

The attributeValues of the AttributeCriteria.

getLowerBoundValue

public Object getLowerBoundValue()

Gets the lower bound value of the AttributeCriteria in case of a 'Between' RangeOperator, null otherwise.

Returns:

The lower bound value of the AttributeCriteria in case of a 'Between' operator, null otherwise.

getUpperBoundValue

public Object getUpperBoundValue()

Gets the upper bound value of the AttributeCriteria in case of a 'Between' RangeOperator, null otherwise.

Returns:

The upper bound value of the AttributeCriteria in case of a 'Between' operator, null otherwise.

getOperator

public com.tridion.smarttarget.query.builder.Operator getOperator()

Gets the Operator of the AttributeCriteria.

Returns:

The Operator of the AttributeCriteria.

isNegate

public boolean isNegate()

A flag indicating if this Attribute's operation should be negated.

Returns:

true if the Attribute's operation should be negated, false otherwise.

visitCriteria

public List<Object> visitCriteria(List<Object> criteriaList)

Specified by:

visitCriteria in interface com.tridion.smarttarget.query.builder.Criteria