com.tridion.broker.querying.criteria.taxonomy

Class TaxonomyKeywordDescriptionCriteria

java.lang.Object

com.tridion.broker.querying.criteria.Criteria

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

com.tridion.broker.querying.criteria.taxonomy.TaxonomyKeywordDescriptionCriteria

public class TaxonomyKeywordDescriptionCriteria
extends AbstractTaxonomyKeywordCriteria

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

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

Method Summary

Modifier and Type	Method and Description
String	getKeywordDescription() This returns the keyword description.
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

TaxonomyKeywordDescriptionCriteria

public TaxonomyKeywordDescriptionCriteria(String taxonomyURI,
                                          String keywordDescription,
                                          boolean includeKeywordBranches)

Constructs a TaxonomyKeywordDescriptionCriteria for the specified keyword description.

Parameters:

taxonomyURI - The uri of the Taxonomy were the content is related to

keywordDescription - The description of any keyword to retrieve content for

includeKeywordBranches - Should content from child keywords be included

TaxonomyKeywordDescriptionCriteria

public TaxonomyKeywordDescriptionCriteria(String taxonomyURI,
                                          String keywordDescription,
                                          boolean includeKeywordBranches,
                                          FieldOperator operator)

Constructs a TaxonomyKeywordDescriptionCriteria for the specified keyword description.

Parameters:

taxonomyURI - The uri of the Taxonomy were the content is related to

keywordDescription - The description of any keyword to retrieve content for

includeKeywordBranches - Should content from child keywords be included

operator - Operator for keywordDescription.

TaxonomyKeywordDescriptionCriteria

public TaxonomyKeywordDescriptionCriteria(int publicationId,
                                          int taxonomyId,
                                          String keywordDescription,
                                          boolean includeKeywordBranches)

Constructs a TaxonomyKeywordDescriptionCriteria for the specified keyword description.

Parameters:

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

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

keywordDescription - The description of any keyword to retrieve content for.

includeKeywordBranches - Should content from child keywords be included.

TaxonomyKeywordDescriptionCriteria

public TaxonomyKeywordDescriptionCriteria(int publicationId,
                                          int taxonomyId,
                                          String keywordDescription,
                                          boolean includeKeywordBranches,
                                          FieldOperator operator)

Constructs a TaxonomyKeywordDescriptionCriteria for the specified keyword description adn 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 were the content is related to.

keywordDescription - The description of any keyword to retrieve content for.

includeKeywordBranches - Should content from child keywords be included.

operator - Operator for keywordDescription.

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

getKeywordDescription

public String getKeywordDescription()

This returns the keyword description.

Returns:

The keyword description 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