StatisticalFacetParser

org.elasticsearch.search.facet.statistical

Class StatisticalFacetParser

java.lang.Object
- org.elasticsearch.common.component.AbstractComponent
- - org.elasticsearch.search.facet.statistical.StatisticalFacetParser

All Implemented Interfaces:: FacetParser

public class StatisticalFacetParser
extends AbstractComponent
implements FacetParser

Field Summary
- Fields inherited from class org.elasticsearch.common.component.AbstractComponent
  componentSettings, logger, settings

Constructor Summary

Constructors

Constructor and Description
`StatisticalFacetParser(Settings settings)`

Method Summary

All Methods

Instance Methods

Concrete Methods
Modifier and Type	Method and Description
`FacetExecutor.Mode`	`defaultGlobalMode()` The default mode to use when executed as a "global" (all docs) facet.
`FacetExecutor.Mode`	`defaultMainMode()` The default mode to use when executed as a "main" (query level) facet.
`FacetExecutor`	`parse(String facetName, XContentParser parser, SearchContext context)` Parses the facet into a `FacetExecutor`.
`String[]`	`types()` The type of the facet, for example, terms.

Methods inherited from class org.elasticsearch.common.component.AbstractComponent
nodeName

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

- Constructor Detail
  - StatisticalFacetParser
```
@Inject
public StatisticalFacetParser(Settings settings)
```
- Method Detail
  - types
```
public String[] types()
```
    Description copied from interface: FacetParser
    
    The type of the facet, for example, terms.
  - defaultMainMode
```
public FacetExecutor.Mode defaultMainMode()
```
    Description copied from interface: FacetParser
    
    The default mode to use when executed as a "main" (query level) facet.
  - defaultGlobalMode
```
public FacetExecutor.Mode defaultGlobalMode()
```
    Description copied from interface: FacetParser
    
    The default mode to use when executed as a "global" (all docs) facet.
  - parse
```
public FacetExecutor parse(String facetName,
                           XContentParser parser,
                           SearchContext context)
                    throws IOException
```
    Description copied from interface: FacetParser
    
    Parses the facet into a FacetExecutor.
    
    Specified by:
    
    parse in interface FacetParser
    
    Throws:
    
    IOException