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

Class CriterionFactory

java.lang.Object

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

public final class CriterionFactory
extends Object

This class implements a criterion parser.

The method parse(String) takes as input what is presumed to be the string representation of some criterion and returns an equivalent Criterion instance.

For example, CriterionFactory.parse("answer=42") is semantically equivalent to new SingleValuedCriterion("answer", "42").

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CriterionFactory.EmptyCriterionException Describes CriterionFactory.InvalidCriterionException instances that are thrown when dealing with empty criteria.
static class	CriterionFactory.InvalidCriterionException Describes IllegalArgumentException instances that are thrown when dealing with malformed string representations of criteria.

Method Summary

Modifier and Type	Method and Description
static boolean	isValidAttributeName(CharSequence str) Tells whether the given string represents a valid attribute name (or a valid function name, or a valid universe or locale ID, for that matter).
static Criterion	parse(String criterion) Converts the string representation of a criterion into an equivalent Criterion instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

parse

public static Criterion parse(String criterion)

Converts the string representation of a criterion into an equivalent Criterion instance.

Parameters:

criterion - The non-null string representation of the criterion that is to be parsed.

Returns:

A Criterion that matches the input.

Throws:

CriterionFactory.EmptyCriterionException - If criterion is null, empty, or consists of nothing but an exclamation mark (i.e., a negation without operand).

CriterionFactory.InvalidCriterionException - If criterion cannot be parsed (i.e., does not represent a valid criterion).

isValidAttributeName

public static boolean isValidAttributeName(CharSequence str)

Tells whether the given string represents a valid attribute name (or a valid function name, or a valid universe or locale ID, for that matter).

More specifically, attribute names must match the pattern [0-9a-zA-Z_]+.

Parameters:

str - The string to test.

Returns:

true if str can be an attribute name, universe or locale; false otherwise.