com.datastax.driver.dse.search

Class DateRange

java.lang.Object

com.datastax.driver.dse.search.DateRange

public class DateRange
extends Object

A date range, as defined by the C* type org.apache.cassandra.db.marshal.DateRangeType, corresponding to the Apache Solr type DateRangeField.

A date range can be either single-bounded, in which case it represents a unique instant (e.g. "2001-01-01"), or double-bounded, in which case it represents an interval of time (e.g. "[2001-01-01 TO 2002]").

Date range bounds are always inclusive; they must be either valid dates, or the special value UNBOUNDED, represented by a "*", e.g. "[2001 TO *]".

DateRange instances can be more easily created with the parse(String) method.

DateRange instances are immutable and thread-safe.

Since:

DSE 5.1

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DateRange.DateRangeBound A date range bound.

Constructor Summary

Constructors

Constructor and Description
DateRange(DateRange.DateRangeBound singleBound) Creates a "single bounded" DateRange instance, i.e., a date range whose upper and lower bounds are identical.
DateRange(DateRange.DateRangeBound lowerBound, DateRange.DateRangeBound upperBound) Create a DateRange composed of two distinct bounds.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
DateRange.DateRangeBound	getLowerBound() Returns the lower bound of this range (inclusive).
DateRange.DateRangeBound	getUpperBound() Returns the upper bound of this range (inclusive).
int	hashCode()
boolean	isSingleBounded() Returns true if this DateRange is a single-bounded range, and false if it is a double-bounded range.
static DateRange	parse(String source) Parses the given string as a DateRange.
String	toString() Returns the string representation of this range, in a format compatible with Apache Solr DateRageField syntax

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DateRange

public DateRange(DateRange.DateRangeBound singleBound)

Creates a "single bounded" DateRange instance, i.e., a date range whose upper and lower bounds are identical.

Parameters:

singleBound - the single bound of this range; must not be null.

DateRange

public DateRange(DateRange.DateRangeBound lowerBound,
                 DateRange.DateRangeBound upperBound)

Create a DateRange composed of two distinct bounds.

Parameters:

lowerBound - the lower bound of this range (inclusive); must not be null.

upperBound - the upper bound of this range (inclusive); must not be null.

Throws:

IllegalArgumentException - if lowerBound is null, if upperBound is null, or if both lowerBound and upperBound are not unbounded and lowerBound is greater than upperBound.

Method Detail

parse

public static DateRange parse(String source)
                       throws ParseException

Parses the given string as a DateRange.

The given input must be compliant with Apache Solr type DateRangeField syntax; it can either be a single-bounded range, or a double-bounded range.

Parameters:

source - The string to parse.

Returns:

a DateRange object.

Throws:

ParseException - if the given string could not be parsed into a valid DateRange.

See Also:

DateRange.DateRangeBound.parseLowerBound(String), DateRange.DateRangeBound.parseUpperBound(String)

getLowerBound

public DateRange.DateRangeBound getLowerBound()

Returns the lower bound of this range (inclusive).

Returns:

the lower bound of this range (inclusive).

getUpperBound

public DateRange.DateRangeBound getUpperBound()

Returns the upper bound of this range (inclusive).

This method returns null for single-bounded ranges created via DateRange(DateRangeBound).

Returns:

the lower bound of this range (inclusive).

isSingleBounded

public boolean isSingleBounded()

Returns true if this DateRange is a single-bounded range, and false if it is a double-bounded range.

Returns:

true if this DateRange is a single-bounded range, false otherwise.

toString

public String toString()

Returns the string representation of this range, in a format compatible with Apache Solr DateRageField syntax

Overrides:

toString in class Object

Returns:

the string representation of this range.

See Also:

DateRange.DateRangeBound.toString()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object