com.tridion.broker.querying.criteria.metadata

Class CustomMetaDateRangeCriteria

java.lang.Object

com.tridion.broker.querying.criteria.Criteria

com.tridion.broker.querying.criteria.metadata.MetadataRangeCriteria

com.tridion.broker.querying.criteria.metadata.CustomMetaDateRangeCriteria

public class CustomMetaDateRangeCriteria
extends MetadataRangeCriteria

This allows queries on ranges of custom metadata, this is to retrieve content which has date fields and wants to retrieve content with a specific date range.

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
CustomMetaDateRangeCriteria(Date beginRange, Date endRange) This constructs the date range criteria for any date metadata field within a begin date range and end date range.
CustomMetaDateRangeCriteria(Date beginRange, Date endRange, boolean rangeIncluded) This constructs the date range criteria for any field containing a date with a begin and end date.
CustomMetaDateRangeCriteria(String metaFieldName, Date beginRange, Date endRange) This constructs the date range criteria for a specific field with a begin and end date.
CustomMetaDateRangeCriteria(String metaFieldName, Date beginRange, Date endRange, boolean rangeIncluded) This constructs the date range criteria for a specific field with a begin and end date.
CustomMetaDateRangeCriteria(String beginRange, String endRange) This constructs the date range criteria for any date metadata field within a begin date range and end date range.
CustomMetaDateRangeCriteria(String beginRange, String endRange, boolean rangeIncluded) This constructs the date range criteria for any field containing a date with a begin and end date.
CustomMetaDateRangeCriteria(String dateFormat, String beginRange, String endRange) This constructs the date range criteria for any date metadata field within a begin date range and end date range.
CustomMetaDateRangeCriteria(String metaFieldName, String beginRange, String endRange, boolean rangeIncluded) This constructs the date range criteria for a specific field with a begin and end date.
CustomMetaDateRangeCriteria(String metaFieldName, String dateFormat, String beginRange, String endRange, boolean rangeIncluded) This constructs the date range criteria for a specific field with a begin and end date.

Method Summary

Modifier and Type	Method and Description
Date	getBeginRange() returns the Beginning of the Range.
Date	getEndRange() Returns the End of the Range.

Methods inherited from class com.tridion.broker.querying.criteria.metadata.MetadataRangeCriteria

getMetadataKey, getMetadataType, getSignature, isRangeIncluded, toString

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomMetaDateRangeCriteria

public CustomMetaDateRangeCriteria(String metaFieldName,
                                   Date beginRange,
                                   Date endRange,
                                   boolean rangeIncluded)

This constructs the date range criteria for a specific field with a begin and end date. It can be specified if the actual begin and end dates are included in the specified range.

Parameters:

metaFieldName - The metadata field to query on

beginRange - The begin of the date range

endRange - The end of the date range

rangeIncluded - Set to true if the beginRange and endRange have to be included, false if not

CustomMetaDateRangeCriteria

public CustomMetaDateRangeCriteria(String metaFieldName,
                                   String beginRange,
                                   String endRange,
                                   boolean rangeIncluded)
                            throws CriteriaException

This constructs the date range criteria for a specific field with a begin and end date. It can be specified if the actual begin and end dates are included in the specified range.

Parameters:

metaFieldName - The metadata field to query on

beginRange - The begin of the date range

endRange - The end of the date range

rangeIncluded - Set to true if the beginRange and endRange have to be included, false if not

Throws:

CriteriaException - if the sent beginRange or endRange cannot be parsed with the default dateFormat.

CustomMetaDateRangeCriteria

public CustomMetaDateRangeCriteria(String metaFieldName,
                                   String dateFormat,
                                   String beginRange,
                                   String endRange,
                                   boolean rangeIncluded)
                            throws CriteriaException

This constructs the date range criteria for a specific field with a begin and end date. It can be specified if the actual begin and end dates are included in the specified range.

Parameters:

metaFieldName - The metadata field to query on

dateFormat - The format in which the dates are specified.

beginRange - The begin of the date range

endRange - The end of the date range

rangeIncluded - Set to true if the beginRange and endRange have to be included, false if not

Throws:

CriteriaException - if the sent beginRange or endRange cannot be parsed with the given dateFormat.

CustomMetaDateRangeCriteria

public CustomMetaDateRangeCriteria(String metaFieldName,
                                   Date beginRange,
                                   Date endRange)

This constructs the date range criteria for a specific field with a begin and end date.

Parameters:

metaFieldName - The metadata field to query on

beginRange - The begin of the date range

endRange - The end of the date range

CustomMetaDateRangeCriteria

public CustomMetaDateRangeCriteria(Date beginRange,
                                   Date endRange,
                                   boolean rangeIncluded)

This constructs the date range criteria for any field containing a date with a begin and end date. It can be specified if the actual begin and end dates are included in the specified range.

Parameters:

beginRange - The begin of the date range

endRange - The end of the date range

rangeIncluded - Set to true if the beginRange and endRange have to be included, false if not

CustomMetaDateRangeCriteria

public CustomMetaDateRangeCriteria(String beginRange,
                                   String endRange,
                                   boolean rangeIncluded)
                            throws CriteriaException

This constructs the date range criteria for any field containing a date with a begin and end date. It can be specified if the actual begin and end dates are included in the specified range.

Parameters:

beginRange - The begin of the date range

endRange - The end of the date range

rangeIncluded - Set to true if the beginRange and endRange have to be included, false if not

Throws:

CriteriaException - if the sent beginRange or endRange cannot be parsed with the default dateFormat.

CustomMetaDateRangeCriteria

public CustomMetaDateRangeCriteria(Date beginRange,
                                   Date endRange)

This constructs the date range criteria for any date metadata field within a begin date range and end date range.

Parameters:

beginRange - The begin of the date range

endRange - The end of the date range

CustomMetaDateRangeCriteria

public CustomMetaDateRangeCriteria(String beginRange,
                                   String endRange)
                            throws CriteriaException

This constructs the date range criteria for any date metadata field within a begin date range and end date range.

Parameters:

beginRange - The begin of the date range

endRange - The end of the date range

Throws:

CriteriaException - if the sent beginRange or endRange cannot be parsed with the default dateFormat.

CustomMetaDateRangeCriteria

public CustomMetaDateRangeCriteria(String dateFormat,
                                   String beginRange,
                                   String endRange)
                            throws CriteriaException

This constructs the date range criteria for any date metadata field within a begin date range and end date range.

Parameters:

beginRange - The begin of the date range

endRange - The end of the date range

Throws:

CriteriaException - if the sent beginRange or endRange cannot be parsed with the given dateFormat.

Method Detail

getBeginRange

public Date getBeginRange()

returns the Beginning of the Range.

Specified by:

getBeginRange in class MetadataRangeCriteria

Returns:

The beginning of the RangeCriteria

getEndRange

public Date getEndRange()

Returns the End of the Range.

Specified by:

getEndRange in class MetadataRangeCriteria

Returns:

The end of the RangeCriteria