com.tridion.broker.querying.criteria.metadata

Class CustomMetaKeyCriteria

java.lang.Object

com.tridion.broker.querying.criteria.Criteria

com.tridion.broker.querying.criteria.metadata.CustomMetaKeyCriteria

public class CustomMetaKeyCriteria
extends Criteria

This is the criteria to use for querying a specific custom metadata field with a specific key name.

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
CustomMetaKeyCriteria(String keyName) This is to be used for specifying a Key to query on for custom metadata.
CustomMetaKeyCriteria(String keyName, FieldOperator operator) This is to be used for specifying a Key to query on for custom metadata by using a specified query operator.

Method Summary

Modifier and Type	Method and Description
String	getKeyName() Gets the key name for which we query custom metadata.
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

CustomMetaKeyCriteria

public CustomMetaKeyCriteria(String keyName)

This is to be used for specifying a Key to query on for custom metadata.

Parameters:

keyName - The key name to query custom metadata for

CustomMetaKeyCriteria

public CustomMetaKeyCriteria(String keyName,
                             FieldOperator operator)

This is to be used for specifying a Key to query on for custom metadata by using a specified query operator.

Parameters:

keyName - The key name to query custom metadata for

operator - The operator to use in the query

Method Detail

getSignature

protected String getSignature()

Overrides:

getSignature in class Criteria

getKeyName

public String getKeyName()

Gets the key name for which we query custom metadata.

Returns:

The key name to query custom metadata for.

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 this criteria.