Package co.elasticsearch.enterprisesearch.client.model.request.search.filter

Class DateRangeFilter

java.lang.Object

co.elasticsearch.enterprisesearch.client.model.request.search.filter.DateRangeFilter

All Implemented Interfaces:

FieldFilter, Filter

public class DateRangeFilter
extends Object
implements Filter, FieldFilter

Represents a Search Date Range filter

Constructor Summary

Constructors

Constructor	Description
DateRangeFilter(String name)	Create a DateRangeFilter with the given name

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
OffsetDateTime	getFrom()	Inclusive lower bound of the range.
String	getName()	The field from your schema upon which to apply your filter
DateRange	getRange()	Get the filter range
OffsetDateTime	getTo()	Exclusive upper bound of the range.
int	hashCode()
DateRangeFilter	setFrom(OffsetDateTime from)	Inclusive lower bound of the range.
DateRangeFilter	setName(String name)	The field from your schema upon which to apply your filter
DateRangeFilter	setRange(DateRange range)	Set the range, upper bound exclusive, lower bound inclusive
DateRangeFilter	setTo(OffsetDateTime to)	Exclusive upper bound of the range.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DateRangeFilter

public DateRangeFilter(String name)

Create a DateRangeFilter with the given name

Parameters:

name - the filter name

Method Detail

setRange

public DateRangeFilter setRange(DateRange range)

Set the range, upper bound exclusive, lower bound inclusive

Parameters:

range - The range

Returns:

This filter

getRange

public DateRange getRange()

Get the filter range

Returns:

The filter range

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getName

public String getName()

The field from your schema upon which to apply your filter

Specified by:

getName in interface FieldFilter

Returns:

The field name

getFrom

public OffsetDateTime getFrom()

Inclusive lower bound of the range. Is required if to is not given.

Returns:

the lower bound

getTo

public OffsetDateTime getTo()

Exclusive upper bound of the range. Is required if from is not given.

Returns:

the upper bound

setName

public DateRangeFilter setName(String name)

The field from your schema upon which to apply your filter

Parameters:

name - The name of the field to filter

Returns:

this.

setFrom

public DateRangeFilter setFrom(OffsetDateTime from)

Inclusive lower bound of the range. Is required if to is not given.

Parameters:

from - the lower bound

Returns:

this.

setTo

public DateRangeFilter setTo(OffsetDateTime to)

Exclusive upper bound of the range. Is required if from is not given.

Parameters:

to - the upper bound

Returns:

this.

toString

public String toString()

Overrides:

toString in class Object