com.tridion.broker.querying.criteria

Class DateCriteria

java.lang.Object

com.tridion.broker.querying.criteria.Criteria

com.tridion.broker.querying.criteria.DateCriteria

Direct Known Subclasses:

ItemCreationDateCriteria, ItemInitialPublishDateCriteria, ItemLastPublishedDateCriteria, ItemModificationDateCriteria

public abstract class DateCriteria
extends Criteria

Criteria class to be extended by all criteria that need to use a date as selector. This class gives you the possibility to define the format in which you are sending the date or to send the date as a Date.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DATE_FORMAT This is the internal date format used.
static String	ORACLE_DATE_CONVERSION_STRING This is the string used in Oracle to convert our string into an Oracle date.

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

Modifier	Constructor and Description
protected	DateCriteria(String criteriaName, Date date) Creates a new date criteria with a specific date.
protected	DateCriteria(String criteriaName, Date date, FieldOperator operator) Creates a new date criteria with a specific date, a certain name and that uses the specified field operator.
protected	DateCriteria(String criteriaName, String stringDate) Creates a new date criteria with a specific date.
protected	DateCriteria(String criteriaName, String stringDate, FieldOperator operator) Creates a new date criteria with a specific date string, with a certain name and that uses the specified field operator.
protected	DateCriteria(String criteriaName, String stringDate, String dateFormat) Creates a new date criteria with a specific date string, expected in the specified dateFormat and with a certain name.
protected	DateCriteria(String criteriaName, String stringDate, String dateFormat, FieldOperator operator) Creates a new date criteria with a specific date string, expected in the specified dateFormat, with a certain name and that uses the specified field operator.

Method Summary

Modifier and Type	Method and Description
Date	getConvertedDate() Gets the internal string representation of the date used by 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, getSignature, hasAnyCriteria, isLikeOperatorApplicable, isOperator, setParentOperator

Methods inherited from class java.lang.Object

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

Field Detail

DATE_FORMAT

public static final String DATE_FORMAT

This is the internal date format used.

See Also:

Constant Field Values

ORACLE_DATE_CONVERSION_STRING

public static final String ORACLE_DATE_CONVERSION_STRING

This is the string used in Oracle to convert our string into an Oracle date.

See Also:

Constant Field Values

Constructor Detail

DateCriteria

protected DateCriteria(String criteriaName,
                       Date date)

Creates a new date criteria with a specific date. Note that if you use this constructor the used field operator will be EQUAL.

Parameters:

criteriaName - The internal name of the criteria.

date - The date to be used by this criteria.

DateCriteria

protected DateCriteria(String criteriaName,
                       String stringDate)
                throws CriteriaException

Creates a new date criteria with a specific date. Note that if you use this constructor the used field operator will be EQUAL. Note that this constructor expects the stringDate in format "yyyy-MM-dd HH:mm:ss.SSS".

Parameters:

criteriaName - The internal name of the criteria.

stringDate - The stringDate to be used by this criteria expected in format "yyyy-MM-dd HH:mm:ss.SSS".

Throws:

CriteriaException - - if the sent stringDate cannot be parsed in format "yyyy-MM-dd HH:mm:ss.SSS".

DateCriteria

protected DateCriteria(String criteriaName,
                       String stringDate,
                       String dateFormat)
                throws CriteriaException

Creates a new date criteria with a specific date string, expected in the specified dateFormat and with a certain name. Note that if you use this constructor the used field operator will be EQUAL.

Parameters:

criteriaName - The internal name of the criteria.

dateFormat - The the date format in which the string date is specified.

Throws:

CriteriaException - - if the sent stringDate cannot be parsed with the given dateFormat.

DateCriteria

protected DateCriteria(String criteriaName,
                       String stringDate,
                       FieldOperator operator)
                throws CriteriaException

Creates a new date criteria with a specific date string, with a certain name and that uses the specified field operator. Note that this constructor expects the stringDate in format "yyyy-MM-dd HH:mm:ss.SSS".

Parameters:

criteriaName - The internal name of the criteria.

stringDate - The string representation of the date to be used by this criteria.

operator - Operator for the queried date (Criteria.EQUAL, Criteria.GREATER_THAN, ...).

Throws:

CriteriaException - - if the sent stringDate cannot be parsed in format "yyyy-MM-dd HH:mm:ss.SSS".

DateCriteria

protected DateCriteria(String criteriaName,
                       String stringDate,
                       String dateFormat,
                       FieldOperator operator)
                throws CriteriaException

Creates a new date criteria with a specific date string, expected in the specified dateFormat, with a certain name and that uses the specified field operator.

Parameters:

criteriaName - The internal name of the criteria.

stringDate - The string representation of the date to be used by this criteria.

dateFormat - The the date format in which the string date is specified.

operator - Operator for the queried date (Criteria.EQUAL, Criteria.GREATER_THAN, ...).

Throws:

CriteriaException - - if the sent stringDate cannot be parsed with the given dateFormat.

DateCriteria

protected DateCriteria(String criteriaName,
                       Date date,
                       FieldOperator operator)

Creates a new date criteria with a specific date, a certain name and that uses the specified field operator.

Parameters:

criteriaName - The internal name of the criteria.

date - The date to be used by this criteria.

operator - Operator for the queried date (Criteria.EQUAL, Criteria.GREATER_THAN, ...).

Method Detail

getConvertedDate

public Date getConvertedDate()

Gets the internal string representation of the date used by this criteria. Note that this string has the format: yyyy-MM-dd HH:mm:ss.SSS.

Returns:

the internal string representation of the date used by this criteria.

toString

public String toString()

Returns string presentation of the criteria.

Overrides:

toString in class Criteria

Returns:

String presentation of criteria.