com.attivio.sdk.search.facet

Class FilterBasedFacetRequest

java.lang.Object

com.attivio.sdk.search.facet.FacetRequest

com.attivio.sdk.search.facet.FilterBasedFacetRequest

All Implemented Interfaces:

Serializable, Cloneable, Iterable<Map.Entry<String,Query>>

public class FilterBasedFacetRequest
extends FacetRequest
implements Iterable<Map.Entry<String,Query>>

A FacetRequest whose buckets are defined by Queries.

Each query that is added to this request will generate a hit count that would occur if this query were applied to the QueryRequest. This hit count will be the bucket count in the returned facet response.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FilterBasedFacetRequest.LabeledFilter

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
FilterBasedFacetRequest()
FilterBasedFacetRequest(String name)

Method Summary

Modifier and Type	Method and Description
void	add(String label, Query filter) Request that a Bucket for filter will be returned.
protected int	addParameters(StringBuilder buffer, int index)
boolean	equals(Object other)
Collection<Query>	filters() Get the filters for this FilterBasedFacetRequest.
Query	getFilter(String label)
Map<String,Query>	getFilters()
int	hashCode()
boolean	isFacetFinder() true if the facet finder can replace this FacetRequest with a suggested FacetRequest.
Iterator<Map.Entry<String,Query>>	iterator() Get an iterator over all filters.
void	setFacetFinder(boolean value) Set if FacetFinder is allowed to provide a suggestion for this FacetRequest.
void	setFilters(Map<String,Query> value)
static FacetRequest	valueOf(String value) Parse a FacetRequest from a string.

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

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

FilterBasedFacetRequest

public FilterBasedFacetRequest()

FilterBasedFacetRequest

public FilterBasedFacetRequest(String name)

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

getFilter

public Query getFilter(String label)

getFilters

public Map<String,Query> getFilters()

setFilters

public void setFilters(Map<String,Query> value)

add

public void add(String label,
                Query filter)

Request that a Bucket for filter will be returned.

iterator

public Iterator<Map.Entry<String,Query>> iterator()

Get an iterator over all filters.

Specified by:

iterator in interface Iterable<Map.Entry<String,Query>>

filters

public Collection<Query> filters()

Get the filters for this FilterBasedFacetRequest.

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

valueOf

public static FacetRequest valueOf(String value)

Parse a FacetRequest from a string.