Package co.elasticsearch.enterprisesearch.client.model.response.search.facet.value

Class DateRange

java.lang.Object

co.elasticsearch.enterprisesearch.client.model.response.search.facet.value.DateRange

All Implemented Interfaces:

FacetRangeValue<OffsetDateTime>, FacetValue

public class DateRange
extends Object
implements FacetRangeValue<OffsetDateTime>

Represents a facet value for a Date range

Constructor Summary

Constructors

Constructor	Description
DateRange()

Method Summary

Modifier and Type	Method	Description
Long	getCount()	The number of documents matching this range
OffsetDateTime	getFrom()	The start of the range, optional
String	getName()	The name of this date range, optional
OffsetDateTime	getTo()	The end of the range, optional
DateRange	setCount(Long count)	The number of documents matching this range
DateRange	setFrom(OffsetDateTime from)	The start of the range, optional
DateRange	setName(String name)	The name of this date range, optional
DateRange	setTo(OffsetDateTime to)	The end of the range, optional

Methods inherited from class java.lang.Object

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

Constructor Detail

DateRange

public DateRange()

Method Detail

getFrom

public OffsetDateTime getFrom()

The start of the range, optional

Specified by:

getFrom in interface FacetRangeValue<OffsetDateTime>

Returns:

the start of the date range, or null if no start range is defined

getTo

public OffsetDateTime getTo()

The end of the range, optional

Specified by:

getTo in interface FacetRangeValue<OffsetDateTime>

Returns:

the end of the date range, or null if no start range is defined

getCount

public Long getCount()

The number of documents matching this range

Specified by:

getCount in interface FacetValue

Returns:

the count of documents matching this range

getName

public String getName()

The name of this date range, optional

Returns:

the name for this range, or null if no value is defined

setFrom

public DateRange setFrom(OffsetDateTime from)

The start of the range, optional

Parameters:

from - The start of the date range

Returns:

this.

setTo

public DateRange setTo(OffsetDateTime to)

The end of the range, optional

Parameters:

to - The end of the date range

Returns:

this.

setCount

public DateRange setCount(Long count)

The number of documents matching this range

Parameters:

count - the count of documents

Returns:

this.

setName

public DateRange setName(String name)

The name of this date range, optional

Parameters:

name - the name for this range

Returns:

this.