com.tridion.broker.querying.criteria.taxonomy

Class TaxonomyKeywordKeyCriteria

java.lang.Object

com.tridion.broker.querying.criteria.Criteria

com.tridion.broker.querying.criteria.taxonomy.AbstractTaxonomyKeywordCriteria

com.tridion.broker.querying.criteria.taxonomy.TaxonomyKeywordKeyCriteria

public class TaxonomyKeywordKeyCriteria
extends AbstractTaxonomyKeywordCriteria

This is the criteria which can be used to retrieve all content related to any keyword with the given key.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CRITERIA_NAME Criteria name.

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
TaxonomyKeywordKeyCriteria(int publicationId, int taxonomyId, String keywordKey, boolean includeKeywordBranches) Constructs a TaxonomyKeywordKeyCriteria for the specified keyword key.
TaxonomyKeywordKeyCriteria(int publicationId, int taxonomyId, String keywordKey, boolean includeKeywordBranches, FieldOperator operator) Constructs a TaxonomyKeywordKeyCriteria for the specified keyword key and with a certain field operator to be used.
TaxonomyKeywordKeyCriteria(String taxonomyURI, String keywordKey, boolean includeKeywordBranches) Constructs a TaxonomyKeywordKeyCriteria for the specified keyword key.
TaxonomyKeywordKeyCriteria(String taxonomyURI, String keywordKey, boolean includeKeywordBranches, FieldOperator operator) Constructs a TaxonomyKeywordKeyCriteria for the specified keyword key.

Method Summary

Modifier and Type	Method and Description
String	getKeywordKey() This returns the keyword key used for querying.
Integer	getPublicationId() This returns the publicationId.
protected String	getSignature()
Integer	getTaxonomyId() This returns the taxonomy Id.
protected boolean	isLikeOperatorApplicable() Like operator is applicable to this criteria..
String	toString() Return a String representation of this Criteria.

Methods inherited from class com.tridion.broker.querying.criteria.taxonomy.AbstractTaxonomyKeywordCriteria

isIncludeKeywordBranches

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

Field Detail

CRITERIA_NAME

public static final String CRITERIA_NAME

Criteria name.

See Also:

Constant Field Values

Constructor Detail

TaxonomyKeywordKeyCriteria

public TaxonomyKeywordKeyCriteria(String taxonomyURI,
                                  String keywordKey,
                                  boolean includeKeywordBranches)

Constructs a TaxonomyKeywordKeyCriteria for the specified keyword key.

Parameters:

taxonomyURI - The uri of the Taxonomy where the content is related to.

keywordKey - The key of any keyword to retrieve content for.

includeKeywordBranches - Should content from child keywords be included.

TaxonomyKeywordKeyCriteria

public TaxonomyKeywordKeyCriteria(String taxonomyURI,
                                  String keywordKey,
                                  boolean includeKeywordBranches,
                                  FieldOperator operator)

Constructs a TaxonomyKeywordKeyCriteria for the specified keyword key.

Parameters:

taxonomyURI - The uri of the Taxonomy where the content is related to.

keywordKey - The key of any keyword to retrieve content for.

includeKeywordBranches - Should content from child keywords be included.

operator - Operator for keywordKey.

TaxonomyKeywordKeyCriteria

public TaxonomyKeywordKeyCriteria(int publicationId,
                                  int taxonomyId,
                                  String keywordKey,
                                  boolean includeKeywordBranches)

Constructs a TaxonomyKeywordKeyCriteria for the specified keyword key.

Parameters:

publicationId - The id of the publication where the taxonomy is.

taxonomyId - The id of the Taxonomy where the content is related to.

keywordKey - The key of any keyword to retrieve content for.

includeKeywordBranches - Should content from child keywords be included.

TaxonomyKeywordKeyCriteria

public TaxonomyKeywordKeyCriteria(int publicationId,
                                  int taxonomyId,
                                  String keywordKey,
                                  boolean includeKeywordBranches,
                                  FieldOperator operator)

Constructs a TaxonomyKeywordKeyCriteria for the specified keyword key and with a certain field operator to be used.

Parameters:

publicationId - The id of the publication where the taxonomy is.

taxonomyId - The id of the Taxonomy where the content is related to.

keywordKey - The key of any keyword to retrieve content for.

includeKeywordBranches - Should content from child keywords be included.

operator - Operator for keywordKey.

Method Detail

getSignature

protected String getSignature()

Overrides:

getSignature in class Criteria

getTaxonomyId

public Integer getTaxonomyId()

This returns the taxonomy Id.

Returns:

The taxonomyId

getPublicationId

public Integer getPublicationId()

This returns the publicationId.

Returns:

The publicationId.

getKeywordKey

public String getKeywordKey()

This returns the keyword key used for querying.

Returns:

The keyword key to use for retrieving content.

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()

Return a String representation of this Criteria.

Overrides:

toString in class Criteria