com.attivio.sdk.search.facet

Class RangeFacetRequest

java.lang.Object

com.attivio.sdk.search.facet.FacetRequest

com.attivio.sdk.search.facet.RangeFacetRequest

All Implemented Interfaces:

Serializable, Cloneable, Iterable<FacetRange>

public class RangeFacetRequest
extends FacetRequest
implements Iterable<FacetRange>

A FacetRequest requesting counts for documents with values in specified ranges.

NOTE: for all ranges, the min value is inclusive and the max value is exclusive.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.attivio.sdk.search.facet.FacetRequest

FacetRequest.SortBy

Field Summary

Fields inherited from class com.attivio.sdk.search.facet.FacetRequest

DEFAULT_MAX_MEMORY_USAGE, DEFAULT_PRIMARY_SORT, DEFAULT_SAMPLE_MODE, DEFAULT_SECONDARY_SORT, DEFAULT_SORT_BY

Constructor Summary

Constructors

Constructor and Description
RangeFacetRequest()
RangeFacetRequest(FieldExpression field)
RangeFacetRequest(String field) Construct a new RangeFacetRequest that contains 0 ranges.
RangeFacetRequest(String field, double min, double max) Construct a new RangeFacetRequest with fixed size ranges from min to max.
RangeFacetRequest(String field, double min, double max, int buckets) Construct a new RangeFacetRequest with fixed size ranges from min to max.
RangeFacetRequest(String field, long min, long max) Construct a new RangeFacetRequest with fixed size ranges from min to max.
RangeFacetRequest(String field, long min, long max, int buckets) Construct a new RangeFacetRequest with fixed size ranges from min to max.

Method Summary

Modifier and Type	Method and Description
void	add(double min, double max) Add a double precision floating point range to this request.
void	add(FacetRange range) Add a range to this request.
void	add(float min, float max) Add a floating point range to this request.
void	add(int min, int max) Add an integer range to this request.
void	add(long min, long max) Add a long integer range to this request.
void	add(String label, BigDecimal min, BigDecimal max) Add an integer range to this request.
void	add(String label, Date min, Date max) Add a Date range to this request.
void	add(String label, double min, double max) Add a double precision floating point range to this request.
void	add(String label, float min, float max) Add a floating point range to this request.
void	add(String label, int min, int max) Add an integer range to this request.
void	add(String label, long min, long max) Add a long integer range to this request.
protected int	addParameters(StringBuilder buffer, int index)
boolean	equals(Object other)
ArrayList<FacetRange>	getRanges() Get the facet ranges.
int	hashCode()
boolean	isFacetFinder() true if the facet finder can replace this FacetRequest with a suggested FacetRequest.
Iterator<FacetRange>	iterator() Get an iterator over all ranges.
void	setFacetFinder(boolean value) Set if FacetFinder is allowed to provide a suggestion for this FacetRequest.

Methods inherited from class com.attivio.sdk.search.facet.FacetRequest

addName, addParameter, clone, getBucketComparator, getDistributedMaxBuckets, getDistributedMinBucketCount, getField, getFieldExpression, getMaxBuckets, getMaxMemoryUsage, getMinBucketCount, getName, getPrimarySortOrder, getRawDistributedMaxBuckets, getRawDistributedMinBucketCount, getRawMaxBuckets, getRawMinBucketCount, getSecondarySortOrder, getShallowMode, getSortBy, isCalculateStatistics, isFacetTokens, setCalculateStatistics, setDefaults, setDistributedMaxBuckets, setDistributedMaxBuckets, setDistributedMinBucketCount, setDistributedMinBucketCount, setFacetTokens, setField, setFieldExpression, setMaxBuckets, setMaxBuckets, setMaxMemoryUsage, setMinBucketCount, setMinBucketCount, setName, setPrimarySortOrder, setSecondarySortOrder, setShallowMode, setSortOrder, setSortOrder, setSortOrder, toString, valueOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

RangeFacetRequest

public RangeFacetRequest()

RangeFacetRequest

public RangeFacetRequest(String field)

Construct a new RangeFacetRequest that contains 0 ranges.

RangeFacetRequest

public RangeFacetRequest(FieldExpression field)

RangeFacetRequest

public RangeFacetRequest(String field,
                         long min,
                         long max)

Construct a new RangeFacetRequest with fixed size ranges from min to max.

RangeFacetRequest

public RangeFacetRequest(String field,
                         double min,
                         double max)

Construct a new RangeFacetRequest with fixed size ranges from min to max.

RangeFacetRequest

public RangeFacetRequest(String field,
                         long min,
                         long max,
                         int buckets)

Construct a new RangeFacetRequest with fixed size ranges from min to max.

RangeFacetRequest

public RangeFacetRequest(String field,
                         double min,
                         double max,
                         int buckets)

Construct a new RangeFacetRequest with fixed size ranges from min to max.

Method Detail

isFacetFinder

public final boolean isFacetFinder()

true if the facet finder can replace this FacetRequest with a suggested FacetRequest.

This will replace a FacetRequest for a numeric field with a RangeFacetRequest when facet finder runs.

Overrides:

isFacetFinder in class FacetRequest

setFacetFinder

public final void setFacetFinder(boolean value)

Set if FacetFinder is allowed to provide a suggestion for this FacetRequest.

Overrides:

setFacetFinder in class FacetRequest

getRanges

public ArrayList<FacetRange> getRanges()

Get the facet ranges.

iterator

public Iterator<FacetRange> iterator()

Get an iterator over all ranges.

Specified by:

iterator in interface Iterable<FacetRange>

add

public void add(FacetRange range)

Add a range to this request.

add

public void add(String label,
                Date min,
                Date max)

Add a Date range to this request.

add

public void add(int min,
                int max)

Add an integer range to this request.

add

public void add(String label,
                int min,
                int max)

Add an integer range to this request.

add

public void add(String label,
                BigDecimal min,
                BigDecimal max)

Add an integer range to this request.

add

public void add(long min,
                long max)

Add a long integer range to this request.

add

public void add(String label,
                long min,
                long max)

Add a long integer range to this request.

add

public void add(float min,
                float max)

Add a floating point range to this request.

add

public void add(String label,
                float min,
                float max)

Add a floating point range to this request.

add

public void add(double min,
                double max)

Add a double precision floating point range to this request.

add

public void add(String label,
                double min,
                double max)

Add a double precision floating point range to this request.

addParameters

protected int addParameters(StringBuilder buffer,
                            int index)

Overrides:

addParameters in class FacetRequest

hashCode

public int hashCode()

Overrides:

hashCode in class FacetRequest

equals

public boolean equals(Object other)

Overrides:

equals in class FacetRequest