FacetRequest (platform/sdk 5.5.1.0-SNAPSHOT API)

java.lang.Object
- com.attivio.sdk.search.facet.FacetRequest

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

DateFacetRequest, FilterBasedFacetRequest, RangeFacetRequest, SchemaFacetRequest, ScopeFacetRequest
```
public class FacetRequest
extends Object
implements Cloneable, Serializable
```
Represents a generic Facet Request based on the value of a field.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class FacetRequest.SortBy
Enumeration listing types of sorts for a facet request

Nested Classes
Modifier and Type	Class and Description
`static class`	`FacetRequest.SortBy` Enumeration listing types of sorts for a facet request

Field Summary

Fields
Modifier and Type	Field and Description
`static long`	`DEFAULT_MAX_MEMORY_USAGE` Default max memory usage (512K).
`static Sort.SortOrder`	`DEFAULT_PRIMARY_SORT` Default primary Sort
`static ShallowMode`	`DEFAULT_SAMPLE_MODE` Default sample mode for date facets (POPULATION)
`static Sort.SortOrder`	`DEFAULT_SECONDARY_SORT` Default secondary Sort
`static FacetRequest.SortBy`	`DEFAULT_SORT_BY` Default sort by

Constructor Summary

Constructors
Modifier	Constructor and Description
	`FacetRequest()`
`protected`	`FacetRequest(boolean facetFinder)`
	`FacetRequest(FieldExpression field)`
`protected`	`FacetRequest(FieldExpression field, boolean facetFinder)`
	`FacetRequest(String fieldName)`
`protected`	`FacetRequest(String fieldName, boolean facetFinder)`
	`FacetRequest(String name, FieldExpression field)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected int`	`addName(StringBuilder buffer)`
`protected int`	`addParameter(StringBuilder buffer, int index, String key, Object value)` Add A REST Parameter To `buffer`.
`protected int`	`addParameters(StringBuilder buffer, int index)`
`FacetRequest`	`clone()`
`boolean`	`equals(Object other)`
`Comparator<FacetBucket>`	`getBucketComparator()` Get a comparator for sorting buckets according to this FacetRequests sort ordering.
`int`	`getDistributedMaxBuckets()` Get the number of buckets to return from distributed indexes.
`int`	`getDistributedMinBucketCount()` Gets the minimum count that returned buckets must have for distributed indexes.
`String`	`getField()` Get the field to request a facet for.
`FieldExpression`	`getFieldExpression()` Get the `FieldExpression` to request a facet for.
`int`	`getMaxBuckets()` Get the maximum number of buckets to return.
`long`	`getMaxMemoryUsage()` Get the max memory usage allowed during computation (in bytes).
`int`	`getMinBucketCount()` Gets the minimum count that returned buckets must have.
`String`	`getName()` Get the name for this facet request.
`Sort.SortOrder`	`getPrimarySortOrder()` Gets the primary sort order for sorting buckets.
`Integer`	`getRawDistributedMaxBuckets()` Same as `getDistributedMaxBuckets()` except a `null` value is returned if no value is set.
`Integer`	`getRawDistributedMinBucketCount()` Same as `getDistributedMinBucketCount()` except a `null` value is returned if no value is set.
`Integer`	`getRawMaxBuckets()` Same as `getMaxBuckets()` except a `null` value is returned if no value is set.
`Integer`	`getRawMinBucketCount()` Same as `getMinBucketCount()` except a `null` value is returned if no value is set.
`Sort.SortOrder`	`getSecondarySortOrder()` Gets the secondary sort order for sorting buckets.
`ShallowMode`	`getShallowMode()` Get the sample mode for facet computation.
`FacetRequest.SortBy`	`getSortBy()` Get the field to sort buckets by
`int`	`hashCode()`
`boolean`	`isCalculateStatistics()` Should statistics be calculated.
`boolean`	`isFacetFinder()` `true` if the facet finder can replace this FacetRequest with a suggested FacetRequest.
`boolean`	`isFacetTokens()` Experimental: If true, will facet on raw tokens for field.
`void`	`setCalculateStatistics(boolean value)` Set if statistics should be calculated.
`void`	`setDefaults(SchemaField schemaField)` Set default values for unset fields based on a SchemaField.
`void`	`setDistributedMaxBuckets(int value)` Set the number of buckets to return from distributed indexes.
`void`	`setDistributedMaxBuckets(Integer value)` Same as `setDistributedMaxBuckets(int)` except that null value indicates default should be used.
`void`	`setDistributedMinBucketCount(int value)` Sets the minimum count that returned buckets must have for distributed indexes.
`void`	`setDistributedMinBucketCount(Integer value)` Same as `setDistributedMinBucketCount(int)` except that null value indicates default should be used.
`void`	`setFacetFinder(boolean value)` Set if FacetFinder is allowed to provide a suggestion for this FacetRequest.
`void`	`setFacetTokens(boolean value)` Experimental: Set if facet should be generated on raw tokens for field.
`void`	`setField(String value)` Set the field to request a facet for.
`void`	`setFieldExpression(FieldExpression value)` Set the `FieldExpression` to request a facet for.
`void`	`setMaxBuckets(int numBuckets)` Set the maximum number of buckets to return.
`void`	`setMaxBuckets(Integer value)` Same as `setMaxBuckets(int)` except that null value indicates default should be used.
`void`	`setMaxMemoryUsage(long value)` Set the max memory usage allowed during computation (in bytes).
`void`	`setMinBucketCount(int value)` Sets the minimum count that returned buckets must have.
`void`	`setMinBucketCount(Integer value)` Same as `setMinBucketCount(int)` except that null value indicates default should be used.
`void`	`setName(String value)` Set the name for this facet request.
`void`	`setPrimarySortOrder(Sort.SortOrder order)` Sets the primary sort order for sorting buckets.
`void`	`setSecondarySortOrder(Sort.SortOrder order)` Sets the secondary sort order for sorting buckets.
`void`	`setShallowMode(ShallowMode value)` Set the sample mode for facet computation.
`void`	`setSortOrder(FacetRequest.SortBy sort)` Sets wether to sort by bucket count or bucket label.
`void`	`setSortOrder(FacetRequest.SortBy sort, Sort.SortOrder order)` Sets wether to sort by bucket count or bucket label.
`void`	`setSortOrder(FacetRequest.SortBy sort, Sort.SortOrder primary, Sort.SortOrder secondary)` Sets the sort order and sort-by's.
`String`	`toString()`
`static FacetRequest`	`valueOf(String value)` Parse a FacetRequest from a string.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_MAX_MEMORY_USAGE
```
public static final long DEFAULT_MAX_MEMORY_USAGE
```
    Default max memory usage (512K).
    
    See Also:
    
    Constant Field Values
  - DEFAULT_SAMPLE_MODE
```
public static ShallowMode DEFAULT_SAMPLE_MODE
```
    Default sample mode for date facets (POPULATION)
  - DEFAULT_PRIMARY_SORT
```
public static final Sort.SortOrder DEFAULT_PRIMARY_SORT
```
    Default primary Sort
  - DEFAULT_SECONDARY_SORT
```
public static final Sort.SortOrder DEFAULT_SECONDARY_SORT
```
    Default secondary Sort
  - DEFAULT_SORT_BY
```
public static final FacetRequest.SortBy DEFAULT_SORT_BY
```
    Default sort by
- Constructor Detail
  - FacetRequest
```
public FacetRequest()
```
  - FacetRequest
```
public FacetRequest(String fieldName)
```
  - FacetRequest
```
public FacetRequest(FieldExpression field)
```
  - FacetRequest
```
public FacetRequest(String name,
                    FieldExpression field)
```
  - FacetRequest
```
protected FacetRequest(boolean facetFinder)
```
  - FacetRequest
```
protected FacetRequest(String fieldName,
                       boolean facetFinder)
```
  - FacetRequest
```
protected FacetRequest(FieldExpression field,
                       boolean facetFinder)
```
- Method Detail
  - getName
```
public String getName()
```
    Get the name for this facet request.
  - setName
```
public void setName(String value)
```
    Set the name for this facet request.
  - getField
```
public String getField()
```
    Get the field to request a facet for.
  - setField
```
public void setField(String value)
```
    Set the field to request a facet for.
  - getFieldExpression
```
public FieldExpression getFieldExpression()
```
    Get the FieldExpression to request a facet for.
  - setFieldExpression
```
public void setFieldExpression(FieldExpression value)
```
    Set the FieldExpression to request a facet for.
  - getShallowMode
```
public ShallowMode getShallowMode()
```
    Get the sample mode for facet computation.
  - setShallowMode
```
public void setShallowMode(ShallowMode value)
```
    Set the sample mode for facet computation.
  - getMaxMemoryUsage
```
public final long getMaxMemoryUsage()
```
    Get the max memory usage allowed during computation (in bytes).
    If the facet contains more data than can fit in this space, its computation will be buffered on disk.
    
    NOTE: this is a hint. not all facet implementations support memory limitations.
  - setMaxMemoryUsage
```
public final void setMaxMemoryUsage(long value)
```
    Set the max memory usage allowed during computation (in bytes).
  - isFacetTokens
```
public boolean isFacetTokens()
```
    Experimental: If true, will facet on raw tokens for field.
    NOTE: may not be available for all fields/facet requests.
  - setFacetTokens
```
public void setFacetTokens(boolean value)
```
    Experimental: Set if facet should be generated on raw tokens for field.
    NOTE: may not be available for all fields/facet requests.
  - isFacetFinder
```
public 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.
  - setFacetFinder
```
public void setFacetFinder(boolean value)
```
    Set if FacetFinder is allowed to provide a suggestion for this FacetRequest.
  - isCalculateStatistics
```
public boolean isCalculateStatistics()
```
    Should statistics be calculated.
  - setCalculateStatistics
```
public void setCalculateStatistics(boolean value)
```
    Set if statistics should be calculated.
  - getSortBy
```
public FacetRequest.SortBy getSortBy()
```
    Get the field to sort buckets by
  - setDefaults
```
public void setDefaults(SchemaField schemaField)
```
    Set default values for unset fields based on a SchemaField.
  - setSortOrder
```
public void setSortOrder(FacetRequest.SortBy sort)
```
    Sets wether to sort by bucket count or bucket label.
  - setSortOrder
```
public void setSortOrder(FacetRequest.SortBy sort,
                         Sort.SortOrder order)
```
    Sets wether to sort by bucket count or bucket label.
  - setSortOrder
```
public void setSortOrder(FacetRequest.SortBy sort,
                         Sort.SortOrder primary,
                         Sort.SortOrder secondary)
```
    Sets the sort order and sort-by's.
    
    Parameters:
    
    sort - the sort-by
    
    primary - the primary sort order
    
    secondary - the secondary sort order
  - setPrimarySortOrder
```
public void setPrimarySortOrder(Sort.SortOrder order)
```
    Sets the primary sort order for sorting buckets.
  - getPrimarySortOrder
```
public Sort.SortOrder getPrimarySortOrder()
```
    Gets the primary sort order for sorting buckets.
  - setSecondarySortOrder
```
public void setSecondarySortOrder(Sort.SortOrder order)
```
    Sets the secondary sort order for sorting buckets.
  - getSecondarySortOrder
```
public Sort.SortOrder getSecondarySortOrder()
```
    Gets the secondary sort order for sorting buckets.
  - getMinBucketCount
```
public int getMinBucketCount()
```
    Gets the minimum count that returned buckets must have.
    Buckets will not be returned if their counts are less than this value.
  - getRawMinBucketCount
```
public Integer getRawMinBucketCount()
```
    Same as getMinBucketCount() except a null value is returned if no value is set.
  - setMinBucketCount
```
public void setMinBucketCount(int value)
```
    Sets the minimum count that returned buckets must have.
    Buckets will not be returned if their counts are less than this value.
  - setMinBucketCount
```
public void setMinBucketCount(Integer value)
```
    Same as setMinBucketCount(int) except that null value indicates default should be used.
  - getDistributedMinBucketCount
```
public int getDistributedMinBucketCount()
```
    Gets the minimum count that returned buckets must have for distributed indexes.
    PERFORMANCE vs ACCURACY: this value is used for tuning performance of faceting in a distributed index setup. If this value is set to 0, bucket counts will accurate, however network traffic will increase. Increasing the value for this setting will reduce network traffic, however accuracy will decrease.
  - getRawDistributedMinBucketCount
```
public Integer getRawDistributedMinBucketCount()
```
    Same as getDistributedMinBucketCount() except a null value is returned if no value is set.
  - setDistributedMinBucketCount
```
public void setDistributedMinBucketCount(int value)
```
    Sets the minimum count that returned buckets must have for distributed indexes.
    PERFORMANCE vs ACCURACY: this value is used for tuning performance of faceting in a distributed index setup. If this value is set to 0, bucket counts will accurate, however network traffic will increase. Increasing the value for this setting will reduce network traffic, however accuracy will decrease.
  - setDistributedMinBucketCount
```
public void setDistributedMinBucketCount(Integer value)
```
    Same as setDistributedMinBucketCount(int) except that null value indicates default should be used.
  - getMaxBuckets
```
public int getMaxBuckets()
```
    Get the maximum number of buckets to return.
  - getRawMaxBuckets
```
public Integer getRawMaxBuckets()
```
    Same as getMaxBuckets() except a null value is returned if no value is set.
  - setMaxBuckets
```
public void setMaxBuckets(int numBuckets)
```
    Set the maximum number of buckets to return.
  - setMaxBuckets
```
public void setMaxBuckets(Integer value)
```
    Same as setMaxBuckets(int) except that null value indicates default should be used.
  - getDistributedMaxBuckets
```
public int getDistributedMaxBuckets()
```
    Get the number of buckets to return from distributed indexes.
    PERFORMANCE vs ACCURACY: this value is used for tuning performance of faceting in a distributed index setup. If this value is unset, then all buckets from sub indexes will be returned upwards (resulting in accurate counts). If this value is set, then not all buckets will be passed up from sub indexes. This will result in better network throughput, however bucket counts accuracy will suffer.
  - getRawDistributedMaxBuckets
```
public Integer getRawDistributedMaxBuckets()
```
    Same as getDistributedMaxBuckets() except a null value is returned if no value is set.
  - setDistributedMaxBuckets
```
public void setDistributedMaxBuckets(int value)
```
    Set the number of buckets to return from distributed indexes.
    PERFORMANCE vs ACCURACY: this value is used for tuning performance of faceting in a distributed index setup. If this value is unset, then all buckets from sub indexes will be returned upwards (resulting in accurate counts). If this value is set, then not all buckets will be passed up from sub indexes. This will result in better network throughput, however bucket counts accuracy will suffer.
  - setDistributedMaxBuckets
```
public void setDistributedMaxBuckets(Integer value)
```
    Same as setDistributedMaxBuckets(int) except that null value indicates default should be used.
  - getBucketComparator
```
public Comparator<FacetBucket> getBucketComparator()
```
    Get a comparator for sorting buckets according to this FacetRequests sort ordering.
  - equals
```
public boolean equals(Object other)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public FacetRequest clone()
```
    Overrides:
    
    clone in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - addName
```
protected int addName(StringBuilder buffer)
```
  - addParameters
```
protected int addParameters(StringBuilder buffer,
                            int index)
```
  - addParameter
```
protected final int addParameter(StringBuilder buffer,
                                 int index,
                                 String key,
                                 Object value)
```
    Add A REST Parameter To buffer.
  - valueOf
```
public static FacetRequest valueOf(String value)
```
    Parse a FacetRequest from a string.

Class FacetRequest

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_MAX_MEMORY_USAGE

DEFAULT_SAMPLE_MODE

DEFAULT_PRIMARY_SORT

DEFAULT_SECONDARY_SORT

DEFAULT_SORT_BY

Constructor Detail

FacetRequest

FacetRequest

FacetRequest

FacetRequest

FacetRequest

FacetRequest

FacetRequest

Method Detail

getName

setName

getField

setField

getFieldExpression

setFieldExpression

getShallowMode

setShallowMode

getMaxMemoryUsage

setMaxMemoryUsage

isFacetTokens

setFacetTokens

isFacetFinder

setFacetFinder

isCalculateStatistics

setCalculateStatistics

getSortBy

setDefaults

setSortOrder

setSortOrder

setSortOrder

setPrimarySortOrder

getPrimarySortOrder

setSecondarySortOrder

getSecondarySortOrder

getMinBucketCount

getRawMinBucketCount

setMinBucketCount

setMinBucketCount

getDistributedMinBucketCount

getRawDistributedMinBucketCount

setDistributedMinBucketCount

setDistributedMinBucketCount

getMaxBuckets

getRawMaxBuckets

setMaxBuckets

setMaxBuckets

getDistributedMaxBuckets

getRawDistributedMaxBuckets

setDistributedMaxBuckets

setDistributedMaxBuckets

getBucketComparator

equals

hashCode

clone

toString

addName

addParameters

addParameter

valueOf