com.datastax.driver.dse.search

Class DateRange.DateRangeBound

java.lang.Object

com.datastax.driver.dse.search.DateRange.DateRangeBound

Enclosing class:

DateRange

public static class DateRange.DateRangeBound
extends Object

A date range bound.

Date range bounds are composed of a Date field and a corresponding DateRange.DateRangeBound.Precision.

Date range bounds are inclusive. The special value UNBOUNDED denotes an un unbounded (infinite) bound, represented by a * sign.

DateRangeBound instances are immutable and thread-safe.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DateRange.DateRangeBound.Precision The precision of a DateRange.DateRangeBound.

Field Summary

Fields

Modifier and Type	Field and Description
static DateRange.DateRangeBound	UNBOUNDED The unbounded DateRange.DateRangeBound instance.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
DateRange.DateRangeBound.Precision	getPrecision() Returns the precision of this bound.
Date	getTimestamp() Returns the timestamp of this bound.
int	hashCode()
boolean	isUnbounded() Whether this bound is an unbounded bound.
static DateRange.DateRangeBound	lowerBound(Date timestamp, DateRange.DateRangeBound.Precision precision) Creates a date range lower bound from the given Date and DateRange.DateRangeBound.Precision.
static DateRange.DateRangeBound	parseLowerBound(String lowerBound) Parses the given input as a lower date range bound.
static DateRange.DateRangeBound	parseUpperBound(String upperBound) Parses the given input as an upper date range bound.
String	toString() Returns this bound as a Lucene-compliant string.
static DateRange.DateRangeBound	upperBound(Date timestamp, DateRange.DateRangeBound.Precision precision) Creates a date range upper bound from the given Date and DateRange.DateRangeBound.Precision.

Methods inherited from class java.lang.Object

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

Field Detail

UNBOUNDED

public static final DateRange.DateRangeBound UNBOUNDED

The unbounded DateRange.DateRangeBound instance. Unbounded bounds are syntactically represented by a * (star) sign.

Method Detail

parseLowerBound

public static DateRange.DateRangeBound parseLowerBound(String lowerBound)
                                                throws ParseException

Parses the given input as a lower date range bound.

The input should be a Lucene-compliant string, but in practice, most ISO-8601 datetime formats are recognizable; in particular, this method accepts a variety of timezone formats, even if Lucene itself requires timezones expressed solely as "Z" (i.e. UTC).

The returned bound will have its precision inferred from the input, and its timestamp will be rounded down to that precision.

Parameters:

lowerBound - The lower date range bound to parse; must not be null.

Returns:

A DateRange.DateRangeBound.

Throws:

IllegalArgumentException - if lowerBound is null.

ParseException - if the given input cannot be parsed.

parseUpperBound

public static DateRange.DateRangeBound parseUpperBound(String upperBound)
                                                throws ParseException

Parses the given input as an upper date range bound.

The input should be a Lucene-compliant string, but in practice, most ISO-8601 datetime formats are recognizable; in particular, this method accepts a variety of timezone formats, even if Lucene itself requires timezones expressed solely as "Z" (i.e. UTC).

The returned bound will have its precision inferred from the input, and its timestamp will be DateRange.DateRangeBound.Precision.roundUp(Date) rounded up} to that precision.

Parameters:

upperBound - The upper date range bound to parse; must not be null.

Returns:

A DateRange.DateRangeBound.

Throws:

IllegalArgumentException - if upperBound is null.

ParseException - if the given input cannot be parsed.

lowerBound

public static DateRange.DateRangeBound lowerBound(Date timestamp,
                                                  DateRange.DateRangeBound.Precision precision)

Creates a date range lower bound from the given Date and DateRange.DateRangeBound.Precision. Temporal fields smaller than the precision will be rounded down.

Parameters:

timestamp - The timestamp to use.

precision - The precision to use.

Returns:

A lower range bound.

upperBound

public static DateRange.DateRangeBound upperBound(Date timestamp,
                                                  DateRange.DateRangeBound.Precision precision)

Creates a date range upper bound from the given Date and DateRange.DateRangeBound.Precision. Temporal fields smaller than the precision will be rounded up.

Parameters:

timestamp - The timestamp to use.

precision - The precision to use.

Returns:

An upper range bound.

isUnbounded

public boolean isUnbounded()

Whether this bound is an unbounded bound.

Returns:

Whether this bound is an unbounded bound.

getTimestamp

public Date getTimestamp()

Returns the timestamp of this bound.

Returns:

the timestamp of this bound.

getPrecision

public DateRange.DateRangeBound.Precision getPrecision()

Returns the precision of this bound.

Returns:

the precision of this bound.

toString

public String toString()

Returns this bound as a Lucene-compliant string.

Unbounded bounds always return "*"; all other bounds are formatted in one of the common ISO-8601 datetime formats, depending on their precision.

Note that Lucene expects timestamps in UTC only. Timezone presence is always optional, and if present, it must be expressed with the symbol "Z" exclusively. Therefore this method does not include any timezone information in the returned string, except for bounds with millisecond precision, where the symbol "Z" is always appended to the resulting string.

Overrides:

toString in class Object

Returns:

this DateRange.DateRangeBound as a Lucene-compliant string.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object