com.tridion.broker.querying.criteria.categorization

Class KeywordCriteria

java.lang.Object

com.tridion.broker.querying.criteria.Criteria

com.tridion.broker.querying.criteria.categorization.KeywordCriteria

public class KeywordCriteria
extends Criteria

This restricts the results of a query to all the content which is directly related to a specific keyword with the specified URI. This keyword could occur in multiple taxonomies/locations and is not context specific. For this use the TaxonomyFacetCriteria and BranchedTaxonomyFacetCriteria.

Field Summary

Fields inherited from class com.tridion.broker.querying.criteria.Criteria

EQUAL, GREATER_OR_EQUAL_THAN, GREATER_THAN, LESS_OR_EQUAL_THAN, LESS_THAN, LIKE, NOT_EQUAL

Constructor Summary

Constructors

Constructor and Description
KeywordCriteria(String categoryName, String keyword) Constructs a KeywordCriteria for the specified category name and keyword.
KeywordCriteria(String categoryName, String[] keywords) Constructs a KeywordCriteria for the specified category name and list of keywords.
KeywordCriteria(String categoryName, String[] keywords, FieldOperator operator) Constructs a Criteria, with specifying operator for it.
KeywordCriteria(String categoryName, String keyword, FieldOperator operator) Constructs a KeywordCriteria for the specified category name, keyword and operator.

Method Summary

Modifier and Type	Method and Description
String	getCategoryName() Returns category name.
List<String>	getKeywords() Returns keywords.
protected String	getSignature()
protected boolean	isLikeOperatorApplicable() Like operator is applicable to this criteria.
String	toString() Returns string presentation of the criteria.

Methods inherited from class com.tridion.broker.querying.criteria.Criteria

addCriteria, getCriteriaChildren, getCriteriaName, getFieldOperatorAsString, getParentOperator, hasAnyCriteria, isOperator, setParentOperator

Methods inherited from class java.lang.Object

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

Constructor Detail

KeywordCriteria

public KeywordCriteria(String categoryName,
                       String[] keywords)

Constructs a KeywordCriteria for the specified category name and list of keywords.

Parameters:

categoryName - Category name

keywords - array of keywords

KeywordCriteria

public KeywordCriteria(String categoryName,
                       String[] keywords,
                       FieldOperator operator)

Constructs a Criteria, with specifying operator for it.

Parameters:

categoryName - Category name

keywords - List of keywords

operator - Operator for criteria

KeywordCriteria

public KeywordCriteria(String categoryName,
                       String keyword)

Constructs a KeywordCriteria for the specified category name and keyword.

Parameters:

categoryName - category name

KeywordCriteria

public KeywordCriteria(String categoryName,
                       String keyword,
                       FieldOperator operator)

Constructs a KeywordCriteria for the specified category name, keyword and operator.

Parameters:

categoryName - Criteria name

keyword - keyword

operator - Operator for criteria

Method Detail

getCategoryName

public String getCategoryName()

Returns category name.

Returns:

Category name.

getKeywords

public List<String> getKeywords()

Returns keywords.

Returns:

List of keywords.

isLikeOperatorApplicable

protected boolean isLikeOperatorApplicable()

Like operator is applicable to this criteria.

Overrides:

isLikeOperatorApplicable in class Criteria

Returns:

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

toString

public String toString()

Returns string presentation of the criteria.

Overrides:

toString in class Criteria

Returns:

String presentation of criteria.

getSignature

protected String getSignature()

Overrides:

getSignature in class Criteria