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

Class NegatableCriterion

java.lang.Object

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

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

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

FunctionCriterion, MultiValuedCriterion, SingleValuedCriterion

public abstract class NegatableCriterion
extends Criterion

Superclass of Criterion instances that can be negated.

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

Modifier and Type	Field and Description
static char	NEGATION The sign used to indicate negation of a criterion.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NegatableCriterion(String attribute, boolean negation) Instantiates a new NegatableCriterion on the specified attribute.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
int	hashCode()
boolean	isNegate() Tells whether this is a negated criterion.
protected boolean	isValidAttributeName(String str) Tells whether the given attribute name is valid.
NegatableCriterion	setNegate(boolean negateParam) Sets whether this criterion is a negation.

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

getAttributeName, toLocation, toLocation, toString

Methods inherited from class java.lang.Object

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

Field Detail

NEGATION

public static final char NEGATION

The sign used to indicate negation of a criterion.

See Also:

Constant Field Values

Constructor Detail

NegatableCriterion

protected NegatableCriterion(String attribute,
                             boolean negation)

Instantiates a new NegatableCriterion on the specified attribute.

Parameters:

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

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

Method Detail

isValidAttributeName

protected boolean isValidAttributeName(String str)

Tells whether the given attribute name is valid.

Parameters:

str - A potential attribute name.

Returns:

true if str is permissible as an attribute name; false otherwise.

isNegate

public boolean isNegate()

Tells whether this is a negated criterion.

Returns:

true if this criterion is a negation; false otherwise.

setNegate

public NegatableCriterion setNegate(boolean negateParam)

Sets whether this criterion is a negation.

Parameters:

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

Returns:

This NegatableCriterion instance; useful for chained manipulations.

equals

public boolean equals(Object o)

Overrides:

equals in class Criterion

hashCode

public int hashCode()

Overrides:

hashCode in class Criterion