FacetRequestFactory (platform/sdk 5.5.1.0-SNAPSHOT API)

java.lang.Object
- com.attivio.util.parser.FacetRequestFactory

```
public class FacetRequestFactory
extends Object
```
Experimental: Factory for parsing/creating facet requests.
Syntax: facetName[:scope][([param1=paramvalue[, param2=paramvalue]...)]

Parameters:
|| Parameter || Type || Facet Types ||
| minBucketCount | maxBuckets | distrib | distributed | sortBy | primarySort | secondarySort | facetFinder | statistics | field | tokens | shallowMode | maxMemory | case | range | filter | realTimeFields | storedFields | facetFields | indexFields | sortFields | countBuckets | countValues | term | dateIntervals | unsigned | All | | integer | All | utedMinBucketCount | unsigned | All | MaxBuckets | integer | All |
| FacetRequest.SortBy | All |
| Sort.SortOrder | All |
| Sort.SortOrder | All |
| boolean | All |
| boolean | Discrete facets, Range Facets, Date Facets |
| FieldExpression | Discrete Facets, Range Facets, Schema Facet (if = .fields) |
| boolean | Experimental: If true, will facet over raw tokens. |
| ShallowMode | Discrete facets, Range Facets, Date Facets |
| long | All |
| ScopeFacetRequest.CaseMode | Scope Facets |
| FacetRange | Range Facets |
| complex | Filter Based Facets |
| boolean | Schema Facet |
| boolean | Schema Facet |
| boolean | Schema Facet |
| boolean | Schema Facet |
| boolean | Schema Facet |
| boolean | Schema Facet |
| boolean | Schema Facet |
| String | Schema Facet |
| complex | Date Facet |

NOTE: This class is subject to change or removal.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class FacetRequestFactory.SchemaFacetFilter

Nested Classes
Modifier and Type	Class and Description
`static class`	`FacetRequestFactory.SchemaFacetFilter`

Constructor Summary

Constructors
Constructor and Description

FacetRequestFactory()

Constructors
Constructor and Description
`FacetRequestFactory()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addFilterBucket(String label, Query filter)`
`void`	`addRangeBucket(FacetRange range)`
`void`	`addSchemaFilter(FacetRequestFactory.SchemaFacetFilter filter, boolean value)` Add/clear a filter for a schema facet.
`void`	`addTerm(String term)` NOTE: currently only applies to schema facet.
`FacetRequest`	`createDateFacet()`
`ScopeFacetRequest.CaseMode`	`getCaseMode()` NOTE: currently only applies to scope facets.
`List<DateFacetRequest.DateFacetInterval>`	`getDateIntervals()` Intervals for calendar based date faceting.
`Integer`	`getDistributedMaxBuckets()` Multi-partition tuning parameter.
`Integer`	`getDistributedMinBucketCount()` Multi-partition tuning parameter.
`FacetRequest`	`getFacetRequest()`
`FieldExpression`	`getField()` The field expression to facet over.
`Map<String,Query>`	`getFilterBuckets()` Filters to compute document frequencies for.
`Integer`	`getMaxBuckets()` Get the maximum number of buckets to return.
`long`	`getMaxMemoryUsage()` Max memory usage that should be used for facets.
`Integer`	`getMinBucketCount()` Get the minimum bucket count required for bucket to be returned.
`String`	`getName()` The name of the facet.
`List<FacetRange>`	`getRangeBuckets()` Ranges to compute document frequencies for.
`Set<FacetRequestFactory.SchemaFacetFilter>`	`getSchemaFilter()` Get the filter for fields to return for a schema facet.
`String`	`getScope()` The scope name for scope faceting.
`Sort.SortOrder`	`getSecondarySortOrder()` Secondary sort order for facet buckets.
`ShallowMode`	`getShallowMode()` Mode for computing shallow facets.
`FacetRequest.SortBy`	`getSortBy()` Sort specification for facet buckets.
`Sort.SortOrder`	`getSortOrder()` Primary sort order for facet buckets.
`List<String>`	`getTerms()` List of discrete facet buckets to return.
`boolean`	`isCountBuckets()` If `false` buckets will not contain counts.
`boolean`	`isCountValues()` If `true` buckets will contain value counts in addition to document counts.
`boolean`	`isFacetFields()` If `true` facetable fields will be returned in schema facet.
`boolean`	`isFacetFinder()` If `false` facet finder will ignore this facet.
`boolean`	`isIndexedFields()` If `true` indexed fields will be returned in schema facet.
`boolean`	`isRealTimeFields()` If `true` schema facet will be computed over real time fields.
`boolean`	`isSortFields()` If `true` sortable fields will be returned in schema facet.
`boolean`	`isStatistics()` `true` if statistics should be computed for facet.
`boolean`	`isStoredFields()` If `true` stored fields will be returned in schema facet.
`boolean`	`isTokens()` true if faceting should occur over raw tokens.
`void`	`setCaseMode(ScopeFacetRequest.CaseMode value)`
`void`	`setCountBuckets(boolean value)`
`void`	`setCountValues(boolean value)`
`void`	`setDateIntervals(List<DateFacetRequest.DateFacetInterval> value)`
`void`	`setDistributedMaxBuckets(Integer value)`
`void`	`setDistributedMinBucketCount(Integer value)`
`void`	`setFacetFinder(boolean value)`
`void`	`setField(FieldExpression value)`
`void`	`setMaxBuckets(Integer value)`
`void`	`setMaxMemoryUsage(long value)`
`void`	`setMinBucketCount(Integer value)`
`void`	`setName(String value)`
`void`	`setRealTimeFields(boolean value)`
`void`	`setScope(String value)`
`void`	`setSecondarySortOrder(Sort.SortOrder value)`
`void`	`setShallowMode(ShallowMode value)`
`void`	`setSortBy(FacetRequest.SortBy value)`
`void`	`setSortOrder(Sort.SortOrder value)`
`void`	`setStatistics(boolean value)`
`void`	`setTokens(boolean value)`
`static FacetRequestFactory`	`valueOf(String value)`
`static FacetRequestFactory`	`valueOf(StringParser reader)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FacetRequestFactory
```
public FacetRequestFactory()
```
- Method Detail
  - getName
```
public String getName()
```
    The name of the facet.
    This is the name that will be used for retreiving the facet response from the query response.
    
    This will also be the field name that will be used for faceting (if otherwise not specified).
  - setName
```
public void setName(String value)
```
  - getField
```
public FieldExpression getField()
```
    The field expression to facet over.
  - setField
```
public void setField(FieldExpression value)
```
  - getScope
```
public String getScope()
```
    The scope name for scope faceting.
    If non-null, this is a Scope facet.
  - setScope
```
public void setScope(String value)
```
  - isTokens
```
public boolean isTokens()
```
    true if faceting should occur over raw tokens.
  - setTokens
```
public void setTokens(boolean value)
```
  - getSortBy
```
public FacetRequest.SortBy getSortBy()
```
    Sort specification for facet buckets.
  - setSortBy
```
public void setSortBy(FacetRequest.SortBy value)
```
  - getDateIntervals
```
public List<DateFacetRequest.DateFacetInterval> getDateIntervals()
```
    Intervals for calendar based date faceting.
    Syntax: dateIntervals=(resolution[(step)][,...]) or dateIntervals=auto
    - resolution = DateFacetRequest.DateFacetResolution for interval.
    - step = step for interval, default=1.
  - setDateIntervals
```
public void setDateIntervals(List<DateFacetRequest.DateFacetInterval> value)
```
  - getSortOrder
```
public Sort.SortOrder getSortOrder()
```
    Primary sort order for facet buckets.
  - setSortOrder
```
public void setSortOrder(Sort.SortOrder value)
```
  - getSecondarySortOrder
```
public Sort.SortOrder getSecondarySortOrder()
```
    Secondary sort order for facet buckets.
  - setSecondarySortOrder
```
public void setSecondarySortOrder(Sort.SortOrder value)
```
  - getMaxBuckets
```
public Integer getMaxBuckets()
```
    Get the maximum number of buckets to return.
    If null max buckets will use configured defaults.
  - setMaxBuckets
```
public void setMaxBuckets(Integer value)
```
  - getDistributedMaxBuckets
```
public Integer getDistributedMaxBuckets()
```
    Multi-partition tuning parameter.
    If null configured defaults will be used.
  - setDistributedMaxBuckets
```
public void setDistributedMaxBuckets(Integer value)
```
  - getMinBucketCount
```
public Integer getMinBucketCount()
```
    Get the minimum bucket count required for bucket to be returned.
    If null min bucket count will use configured defaults.
  - setMinBucketCount
```
public void setMinBucketCount(Integer value)
```
  - getDistributedMinBucketCount
```
public Integer getDistributedMinBucketCount()
```
    Multi-partition tuning parameter.
    If null configured defaults will be used.
  - setDistributedMinBucketCount
```
public void setDistributedMinBucketCount(Integer value)
```
  - isStatistics
```
public boolean isStatistics()
```
    true if statistics should be computed for facet.
  - setStatistics
```
public void setStatistics(boolean value)
```
  - isFacetFinder
```
public boolean isFacetFinder()
```
    If false facet finder will ignore this facet.
  - setFacetFinder
```
public void setFacetFinder(boolean value)
```
  - getShallowMode
```
public ShallowMode getShallowMode()
```
    Mode for computing shallow facets.
  - setShallowMode
```
public void setShallowMode(ShallowMode value)
```
  - getMaxMemoryUsage
```
public long getMaxMemoryUsage()
```
    Max memory usage that should be used for facets.
    NOTE: this is just a hint.
  - setMaxMemoryUsage
```
public void setMaxMemoryUsage(long value)
```
  - getSchemaFilter
```
public Set<FacetRequestFactory.SchemaFacetFilter> getSchemaFilter()
```
    Get the filter for fields to return for a schema facet.
  - isStoredFields
```
public boolean isStoredFields()
```
    If true stored fields will be returned in schema facet.
    NOTE: Only applies to schema facets.
  - isIndexedFields
```
public boolean isIndexedFields()
```
    If true indexed fields will be returned in schema facet.
    NOTE: Only applies to schema facets.
  - isFacetFields
```
public boolean isFacetFields()
```
    If true facetable fields will be returned in schema facet.
    NOTE: Only applies to schema facets.
  - isSortFields
```
public boolean isSortFields()
```
    If true sortable fields will be returned in schema facet.
    NOTE: Only applies to schema facets.
  - addSchemaFilter
```
public void addSchemaFilter(FacetRequestFactory.SchemaFacetFilter filter,
                            boolean value)
```
    Add/clear a filter for a schema facet.
  - isRealTimeFields
```
public boolean isRealTimeFields()
```
    If true schema facet will be computed over real time fields.
    NOTE: Only applies to schema facet.
  - setRealTimeFields
```
public void setRealTimeFields(boolean value)
```
  - isCountBuckets
```
public boolean isCountBuckets()
```
    If false buckets will not contain counts.
    If document frequencies are not needed, setting this to false will result in faster computation.
    
    NOTE: Currently only applies to schema facet.
  - setCountBuckets
```
public void setCountBuckets(boolean value)
```
  - isCountValues
```
public boolean isCountValues()
```
    If true buckets will contain value counts in addition to document counts.
    NOTE: Setting this to true will result in slower facet computation.
    
    NOTE: Currently only applies to schema facet.
  - setCountValues
```
public void setCountValues(boolean value)
```
  - getCaseMode
```
public ScopeFacetRequest.CaseMode getCaseMode()
```
    NOTE: currently only applies to scope facets.
  - setCaseMode
```
public void setCaseMode(ScopeFacetRequest.CaseMode value)
```
  - getTerms
```
public List<String> getTerms()
```
    List of discrete facet buckets to return.
    NOTE: currently only supported by schema facet.
  - addTerm
```
public void addTerm(String term)
```
    NOTE: currently only applies to schema facet.
  - getFilterBuckets
```
public Map<String,Query> getFilterBuckets()
```
    Filters to compute document frequencies for.
    Syntax: filter=(label, queryfilter)
    - label = String label for returned bucket.
    - queryfilter = Quoted string containing query in advanced query language.
  - addFilterBucket
```
public void addFilterBucket(String label,
                            Query filter)
```
  - getRangeBuckets
```
public List<FacetRange> getRangeBuckets()
```
    Ranges to compute document frequencies for.
  - addRangeBucket
```
public void addRangeBucket(FacetRange range)
```
  - createDateFacet
```
public FacetRequest createDateFacet()
```
  - getFacetRequest
```
public FacetRequest getFacetRequest()
```
  - valueOf
```
public static FacetRequestFactory valueOf(String value)
```
  - valueOf
```
public static FacetRequestFactory valueOf(StringParser reader)
```

Class FacetRequestFactory

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FacetRequestFactory

Method Detail

getName

setName

getField

setField

getScope

setScope

isTokens

setTokens

getSortBy

setSortBy

getDateIntervals

setDateIntervals

getSortOrder

setSortOrder

getSecondarySortOrder

setSecondarySortOrder

getMaxBuckets

setMaxBuckets

getDistributedMaxBuckets

setDistributedMaxBuckets

getMinBucketCount

setMinBucketCount

getDistributedMinBucketCount

setDistributedMinBucketCount

isStatistics

setStatistics

isFacetFinder

setFacetFinder

getShallowMode

setShallowMode

getMaxMemoryUsage

setMaxMemoryUsage

getSchemaFilter

isStoredFields

isIndexedFields

isFacetFields

isSortFields

addSchemaFilter

isRealTimeFields

setRealTimeFields

isCountBuckets

setCountBuckets

isCountValues

setCountValues

getCaseMode

setCaseMode

getTerms

addTerm

getFilterBuckets

addFilterBucket

getRangeBuckets

addRangeBucket

createDateFacet

getFacetRequest

valueOf

valueOf