com.attivio.sdk.search.facet

Class ScopeFacetRequest

java.lang.Object

com.attivio.sdk.search.facet.FacetRequest

com.attivio.sdk.search.facet.ScopeFacetRequest

All Implemented Interfaces:

Serializable, Cloneable

public class ScopeFacetRequest
extends FacetRequest

FacetRequest that generates bucket values on matching scopes from document.

Performance Note: it is recommended you only use a ScopeFacetRequest on fields that have highlight.method schema field property set to "index".

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScopeFacetRequest.CaseMode Case Normalization Method To Apply To Extracted Scopes.

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
ScopeFacetRequest()
ScopeFacetRequest(FieldExpression field, String scope)
ScopeFacetRequest(String field, String scope)

Method Summary

Modifier and Type	Method and Description
protected int	addName(StringBuilder buffer)
protected int	addParameters(StringBuilder buffer, int index)
boolean	equals(Object other)
ScopeFacetRequest.CaseMode	getCaseMode()
String	getScope()
int	hashCode()
boolean	isFacetFinder() true if the facet finder can replace this FacetRequest with a suggested FacetRequest.
void	setCaseMode(ScopeFacetRequest.CaseMode value)
void	setFacetFinder(boolean value) Set if FacetFinder is allowed to provide a suggestion for this FacetRequest.
void	setScope(String value)

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

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

Constructor Detail

ScopeFacetRequest

public ScopeFacetRequest()

ScopeFacetRequest

public ScopeFacetRequest(FieldExpression field,
                         String scope)

ScopeFacetRequest

public ScopeFacetRequest(String field,
                         String scope)

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

getScope

public String getScope()

setScope

public void setScope(String value)

getCaseMode

public ScopeFacetRequest.CaseMode getCaseMode()

setCaseMode

public void setCaseMode(ScopeFacetRequest.CaseMode value)

addName

protected int addName(StringBuilder buffer)

Overrides:

addName in class FacetRequest

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