com.datastax.dse.driver.api.core.data.time

Class DateRange

java.lang.Object

com.datastax.dse.driver.api.core.data.time.DateRange

All Implemented Interfaces:

Serializable

public class DateRange
extends Object
implements Serializable

A date range, as defined by the server 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 *]".

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

This class is immutable and thread-safe.

Since:

DSE 5.1

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
DateRangeBound	getLowerBound() Returns the lower bound of this range (inclusive).
Optional<DateRangeBound>	getUpperBound() Returns the upper bound of this range (inclusive), or empty if the range is single-bounded.
int	hashCode()
boolean	isSingleBounded() Returns whether this range is single-bounded, i.e.
static DateRange	parse(String source) Parses the given string as a date range.
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(@NonNull
                 DateRangeBound singleBound)

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

Throws:

NullPointerException - if singleBound is null.

DateRange

public DateRange(@NonNull
                 DateRangeBound lowerBound,
                 @NonNull
                 DateRangeBound upperBound)

Creates an instance composed of two distinct bounds.

Throws:

NullPointerException - if lowerBound or upperBound is null.

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

Method Detail

parse

@NonNull
public static DateRange parse(@NonNull
                                       String source)
                                throws ParseException

Parses the given string as a date range.

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.

Throws:

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

See Also:

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

getLowerBound

@NonNull
public DateRangeBound getLowerBound()

Returns the lower bound of this range (inclusive).

getUpperBound

@NonNull
public Optional<DateRangeBound> getUpperBound()

Returns the upper bound of this range (inclusive), or empty if the range is single-bounded.

isSingleBounded

public boolean isSingleBounded()

Returns whether this range is single-bounded, i.e. if the upper and lower bounds are identical.

toString

@NonNull
public String toString()

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

Overrides:

toString in class Object

See Also:

DateRangeBound.toString()

equals

public boolean equals(@Nullable
                      Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object