org.ametys.cms.search.query

Class DateRangeQuery

java.lang.Object

org.ametys.cms.search.query.AbstractFieldQuery

org.ametys.cms.search.query.DateRangeQuery

All Implemented Interfaces:

Query

public class DateRangeQuery
extends AbstractFieldQuery

Represents a Query testing a date range.

Nested Class Summary

Nested classes/interfaces inherited from interface org.ametys.cms.search.query.Query

Query.LogicalOperator, Query.Operator

Field Summary

Fields

Modifier and Type	Field and Description
protected Date	_from The lower end of the date range.
protected boolean	_includeFrom True to include the lower end, false to exclude it.
protected boolean	_includeTo True to include the upper end, false to exclude it.
protected Date	_to The upper end of the date range.

Fields inherited from class org.ametys.cms.search.query.AbstractFieldQuery

_fieldPath

Constructor Summary

Constructors

Constructor and Description
DateRangeQuery(String fieldPath, Date from, Date to) Build a date range query.
DateRangeQuery(String fieldPath, Date from, Date to, boolean includeFrom, boolean includeTo) Build a date range query.

Method Summary

Modifier and Type	Method and Description
String	build() Build the solr query string representing the Query object.

Methods inherited from class org.ametys.cms.search.query.AbstractFieldQuery

getFieldPath

Methods inherited from class java.lang.Object

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

Field Detail

_from

protected Date _from

The lower end of the date range.

_to

protected Date _to

The upper end of the date range.

_includeFrom

protected boolean _includeFrom

True to include the lower end, false to exclude it.

_includeTo

protected boolean _includeTo

True to include the upper end, false to exclude it.

Constructor Detail

DateRangeQuery

public DateRangeQuery(String fieldPath,
                      Date from,
                      Date to)

Build a date range query.

Parameters:

fieldPath - The field path.

from - The lower end of the range.

to - The upper end of the range.

DateRangeQuery

public DateRangeQuery(String fieldPath,
                      Date from,
                      Date to,
                      boolean includeFrom,
                      boolean includeTo)

Build a date range query.

Parameters:

fieldPath - The field path.

from - The lower end of the range.

to - The upper end of the range.

includeFrom - Whether to include the lower end or not.

includeTo - Whether to include the upper end or not.

Method Detail

build

public String build()
             throws QuerySyntaxException

Description copied from interface: Query

Build the solr query string representing the Query object.

Returns:

the solr query string representing the Query object.

Throws:

QuerySyntaxException - if the query can't be built because of a syntax error.