com.tridion.broker.querying.criteria

Class Criteria

java.lang.Object

com.tridion.broker.querying.criteria.Criteria

Direct Known Subclasses:

AbstractTaxonomyKeywordCriteria, BinaryTypeCriteria, CategorizationCriteria, CategoryCriteria, ContentItemCriteria, CriteriaOperator, CustomMetaKeyCriteria, CustomMetaKeyStringCriteria, CustomMetaValueCriteria, DateCriteria, ItemReferenceCriteria, ItemSchemaCriteria, ItemTemplateCriteria, ItemTitleCriteria, ItemTypeCriteria, KeywordCriteria, LegacyCustomMetaValueCriteria, MetadataRangeCriteria, MultimediaCriteria, NamespaceCriteria, PageTemplateCriteria, PageURLCriteria, PublicationCriteria, PublicationKeyCriteria, PublicationMultimediaPathCriteria, PublicationMultimediaURLCriteria, PublicationPathCriteria, PublicationTitleCriteria, PublicationURLCriteria, SchemaTitleCriteria, TaxonomyCriteria, TaxonomyUsedForIdentificationCriteria

public abstract class Criteria
extends Object

The Criteria provides the structure of the QueryTree, this is used by all query criteria and operators. It makes it possible to structure a QueryTree containing nested conditions.

Field Summary

Fields

Modifier and Type	Field and Description
static FieldOperator	EQUAL Equal.
static FieldOperator	GREATER_OR_EQUAL_THAN Greater than or equal.
static FieldOperator	GREATER_THAN Greater than.
static FieldOperator	LESS_OR_EQUAL_THAN Less than or equal.
static FieldOperator	LESS_THAN Less than.
static FieldOperator	LIKE Like.
static FieldOperator	NOT_EQUAL Not equal.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Criteria(String criteriaName) Constructs a Criteria, with a specified name.
protected	Criteria(String criteriaName, boolean isOperator) This constructs the Criteria object with a given name and if this behaves like an operator.
	Criteria(String criteriaName, FieldOperator operator) Constructs a Criteria, with specifying operator for it.

Method Summary

Modifier and Type	Method and Description
void	addCriteria(Criteria childCriteria) Add criteria to the current Criteria, as a nested Child.
List<Criteria>	getCriteriaChildren() Returns a list of children for the Criteria.
String	getCriteriaName() Returns the Name of the Criteria.
String	getFieldOperatorAsString() Returns operator for field.
CriteriaOperator	getParentOperator() Gets the parent operator of this criteria, if itself is an operator will return itself.
protected String	getSignature()
boolean	hasAnyCriteria(String name) Check that this criteria or any children criteria has the given name.
protected boolean	isLikeOperatorApplicable() Tests if like operator is applicable for the criteria.
boolean	isOperator() Returns if this Criteria is an operator.
void	setParentOperator(CriteriaOperator parentOperator) Sets the parent of this Criteria.
String	toString() Return a String representation of this Criteria.

Methods inherited from class java.lang.Object

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

Field Detail

EQUAL

public static final FieldOperator EQUAL

Equal.

GREATER_THAN

public static final FieldOperator GREATER_THAN

Greater than.

LESS_THAN

public static final FieldOperator LESS_THAN

Less than.

GREATER_OR_EQUAL_THAN

public static final FieldOperator GREATER_OR_EQUAL_THAN

Greater than or equal.

LESS_OR_EQUAL_THAN

public static final FieldOperator LESS_OR_EQUAL_THAN

Less than or equal.

LIKE

public static final FieldOperator LIKE

Like.

NOT_EQUAL

public static final FieldOperator NOT_EQUAL

Not equal.

Constructor Detail

Criteria

protected Criteria(String criteriaName,
                   boolean isOperator)

This constructs the Criteria object with a given name and if this behaves like an operator.

Parameters:

criteriaName - The name of the Criteria

isOperator - True if Criteria is an operator, false if not

Criteria

protected Criteria(String criteriaName)

Constructs a Criteria, with a specified name.

Parameters:

criteriaName - The name of the Criteria

Criteria

public Criteria(String criteriaName,
                FieldOperator operator)

Constructs a Criteria, with specifying operator for it.

Parameters:

criteriaName - The name of the Criteria

operator - Operator for field of the criteria

See Also:

(

Method Detail

getFieldOperatorAsString

public String getFieldOperatorAsString()

Returns operator for field.

Returns:

criteria operator

addCriteria

public void addCriteria(Criteria childCriteria)

Add criteria to the current Criteria, as a nested Child.

Parameters:

childCriteria - The child Criteria to add a a nested Child

getCriteriaChildren

public List<Criteria> getCriteriaChildren()

Returns a list of children for the Criteria.

Returns:

The list containing all the children of the criteria

getCriteriaName

public String getCriteriaName()

Returns the Name of the Criteria.

Returns:

The name of the Criteria

isOperator

public boolean isOperator()

Returns if this Criteria is an operator.

Returns:

True if Criteria is an operator, false if not

getParentOperator

public CriteriaOperator getParentOperator()

Gets the parent operator of this criteria, if itself is an operator will return itself.

Returns:

The parent of the operator or returns itself if Criteria is an operator

hasAnyCriteria

public boolean hasAnyCriteria(String name)

Check that this criteria or any children criteria has the given name.

Parameters:

name - the name to check

Returns:

true if this criteria or any children criteria has the given name.

setParentOperator

public void setParentOperator(CriteriaOperator parentOperator)

Sets the parent of this Criteria.

Parameters:

parentOperator - The parent of this Criteria

toString

public String toString()

Return a String representation of this Criteria.

Overrides:

toString in class Object

getSignature

protected String getSignature()

isLikeOperatorApplicable

protected boolean isLikeOperatorApplicable()

Tests if like operator is applicable for the criteria.

Returns:

if the like operator is applicable. By default it is not applicable. This method should be overided by criteria classes.