com.tridion.broker.querying.criteria.metadata

Class CustomMetaValueCriteria

java.lang.Object

com.tridion.broker.querying.criteria.Criteria

com.tridion.broker.querying.criteria.metadata.CustomMetaValueCriteria

public class CustomMetaValueCriteria
extends Criteria

This is the criteria to be used for querying on custom metadata values. You can specify the value in different formats with different operators to be used. The operators defined are statically defined on the Criteria class see the following Criteria.EQUAL, Criteria.GREATER_THAN, etc.

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
CustomMetaValueCriteria(CustomMetaKeyCriteria customMetaKeyCriteria, Date keyValue) This is used for specifying the Date value to query on.
CustomMetaValueCriteria(CustomMetaKeyCriteria customMetaKeyCriteria, Date keyValue, FieldOperator operator) This is used to specify the date value with a specific operator.
CustomMetaValueCriteria(CustomMetaKeyCriteria customMetaKeyCriteria, Float keyValue) This is to be used for specifying a Float value.
CustomMetaValueCriteria(CustomMetaKeyCriteria customMetaKeyCriteria, Float keyValue, FieldOperator operator) This is to be used for specifying a Float value with a specific operator.
CustomMetaValueCriteria(CustomMetaKeyCriteria customMetaKeyCriteria, String keyValue) This is to be used for specifying a String value.
CustomMetaValueCriteria(CustomMetaKeyCriteria customMetaKeyCriteria, String keyValue, FieldOperator operator) This is to be used for specifying a String value with a specific operator.
CustomMetaValueCriteria(CustomMetaKeyCriteria customMetaKeyCriteria, String keyValue, String dateFormat) This is used to specify the date value.
CustomMetaValueCriteria(CustomMetaKeyCriteria customMetaKeyCriteria, String keyValue, String dateFormat, FieldOperator operator) This is used to specify the date value with a specific operator.
CustomMetaValueCriteria(Date keyValue) This is used for specifying the Date value to query on.
CustomMetaValueCriteria(Date keyValue, FieldOperator operator) This is used to specify the date value with a specific operator.
CustomMetaValueCriteria(Float keyValue) This is to be used for specifying a Float value.
CustomMetaValueCriteria(Float keyValue, FieldOperator operator) This is to be used for specifying a Float value with a specific operator.
CustomMetaValueCriteria(String keyValue) This is to be used for specifying a String value.
CustomMetaValueCriteria(String keyValue, FieldOperator operator) This is to be used for specifying a String value with a specific operator.
CustomMetaValueCriteria(String keyValue, String dateFormat) This is used to specify the date value.
CustomMetaValueCriteria(String keyValue, String dateFormat, FieldOperator operator) This is used to specify the date value with a specific operator.

Method Summary

Modifier and Type	Method and Description
String	getMetadataKey() This returns the metadata key to query on.
MetadataType	getMetaDataType() This returns the metadata type this criteria is based on MetadataType.
protected String	getSignature()
Object	getValue() This returns the value querying on as an Object.
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

CustomMetaValueCriteria

public CustomMetaValueCriteria(String keyValue)

This is to be used for specifying a String value.

Parameters:

keyValue - The string value to query on

CustomMetaValueCriteria

public CustomMetaValueCriteria(CustomMetaKeyCriteria customMetaKeyCriteria,
                               String keyValue)

This is to be used for specifying a String value.

Parameters:

customMetaKeyCriteria - Specifies a custom metadata field with a specific key name.

keyValue - The string value to query on

CustomMetaValueCriteria

public CustomMetaValueCriteria(String keyValue,
                               FieldOperator operator)

This is to be used for specifying a String value with a specific operator.

Parameters:

keyValue - The string value to query on

operator - The operator to use in the broker query

CustomMetaValueCriteria

public CustomMetaValueCriteria(CustomMetaKeyCriteria customMetaKeyCriteria,
                               String keyValue,
                               FieldOperator operator)

This is to be used for specifying a String value with a specific operator.

Parameters:

customMetaKeyCriteria - Specifies a custom metadata field with a specific key name.

keyValue - The string value to query on

operator - The operator to use in the broker query

CustomMetaValueCriteria

public CustomMetaValueCriteria(Float keyValue)

This is to be used for specifying a Float value.

Parameters:

keyValue - The Float value to query on

CustomMetaValueCriteria

public CustomMetaValueCriteria(CustomMetaKeyCriteria customMetaKeyCriteria,
                               Float keyValue)

This is to be used for specifying a Float value.

Parameters:

customMetaKeyCriteria - Specifies a custom metadata field with a specific key name.

keyValue - The Float value to query on

CustomMetaValueCriteria

public CustomMetaValueCriteria(Float keyValue,
                               FieldOperator operator)

This is to be used for specifying a Float value with a specific operator.

Parameters:

keyValue - The Float value to query on

operator - The operator to use in the broker query

CustomMetaValueCriteria

public CustomMetaValueCriteria(CustomMetaKeyCriteria customMetaKeyCriteria,
                               Float keyValue,
                               FieldOperator operator)

This is to be used for specifying a Float value with a specific operator.

Parameters:

customMetaKeyCriteria - Specifies a custom metadata field with a specific key name.

keyValue - The Float value to query on

operator - The operator to use in the broker query

CustomMetaValueCriteria

public CustomMetaValueCriteria(Date keyValue)

This is used for specifying the Date value to query on.

Parameters:

keyValue - The date value to query on

CustomMetaValueCriteria

public CustomMetaValueCriteria(CustomMetaKeyCriteria customMetaKeyCriteria,
                               Date keyValue)

This is used for specifying the Date value to query on.

Parameters:

customMetaKeyCriteria - Specifies a custom metadata field with a specific key name.

keyValue - The date value to query on

CustomMetaValueCriteria

public CustomMetaValueCriteria(Date keyValue,
                               FieldOperator operator)

This is used to specify the date value with a specific operator.

Parameters:

keyValue - The date value to query on

operator - The operator used for the query comparison

CustomMetaValueCriteria

public CustomMetaValueCriteria(CustomMetaKeyCriteria customMetaKeyCriteria,
                               Date keyValue,
                               FieldOperator operator)

This is used to specify the date value with a specific operator.

Parameters:

customMetaKeyCriteria - Specifies a custom metadata field with a specific key name.

keyValue - The date value to query on

operator - The operator used for the query comparison

CustomMetaValueCriteria

public CustomMetaValueCriteria(String keyValue,
                               String dateFormat)
                        throws ParseException

This is used to specify the date value.

Parameters:

keyValue - The date value to query on specified in string format

dateFormat - The date format string to use when formatting the date string

Throws:

ParseException

CustomMetaValueCriteria

public CustomMetaValueCriteria(CustomMetaKeyCriteria customMetaKeyCriteria,
                               String keyValue,
                               String dateFormat)
                        throws ParseException

This is used to specify the date value.

Parameters:

customMetaKeyCriteria - Specifies a custom metadata field with a specific key name.

keyValue - The date value to query on specified in string format

dateFormat - The date format string to use when formatting the date string

Throws:

ParseException

CustomMetaValueCriteria

public CustomMetaValueCriteria(String keyValue,
                               String dateFormat,
                               FieldOperator operator)
                        throws ParseException

This is used to specify the date value with a specific operator.

Parameters:

keyValue - The date value to query on specified in string format

dateFormat - The date format string to use when formatting the date string

operator - The operator used for the query comparison

Throws:

ParseException

CustomMetaValueCriteria

public CustomMetaValueCriteria(CustomMetaKeyCriteria customMetaKeyCriteria,
                               String keyValue,
                               String dateFormat,
                               FieldOperator operator)
                        throws ParseException

This is used to specify the date value with a specific operator.

Parameters:

customMetaKeyCriteria - Specifies a custom metadata field with a specific key name.

keyValue - The date value to query on specified in string format

dateFormat - The date format string to use when formatting the date string

operator - The operator used for the query comparison

Throws:

ParseException

Method Detail

getSignature

protected String getSignature()

Overrides:

getSignature in class Criteria

getMetaDataType

public MetadataType getMetaDataType()

This returns the metadata type this criteria is based on MetadataType.

Returns:

The metadata type used in this criteria

getValue

public Object getValue()

This returns the value querying on as an Object.

Returns:

The value to query on

getMetadataKey

public String getMetadataKey()

This returns the metadata key to query on.

Returns:

The metadata key to query on

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.