StringFacet (OpenRefine 4.0-SNAPSHOT API)

java.lang.Object
- org.openrefine.browsing.facets.StringFacet

All Implemented Interfaces:: Facet

public class StringFacet
extends Object
implements Facet

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class StringFacet.Config

Constructor Summary

Constructors
Constructor Description

StringFacet(int columnIndex, StringFacet.Config config)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`FacetAggregator<?>`	`getAggregator()`	An aggregator used to populate the facet state for this facet.
`FacetConfig`	`getConfig()`	Returns the configuration of the facet.
`FacetResult`	`getFacetResult(FacetState state)`	Returns all the information necessary to render the facet in the UI (aggregation statistics and configuration combined).
`FacetState`	`getInitialFacetState()`	An initial facet state for this facet, which can then be used to scan the table and ingest statistics about rows or records.

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

- Constructor Detail
  - StringFacet
```
public StringFacet(int columnIndex,
                   StringFacet.Config config)
```
- Method Detail
  - getConfig
```
public FacetConfig getConfig()
```
    Description copied from interface: Facet
    
    Returns the configuration of the facet.
    
    Specified by:
    
    getConfig in interface Facet
  - getInitialFacetState
```
public FacetState getInitialFacetState()
```
    Description copied from interface: Facet
    
    An initial facet state for this facet, which can then be used to scan the table and ingest statistics about rows or records.
    
    Specified by:
    
    getInitialFacetState in interface Facet
  - getAggregator
```
public FacetAggregator<?> getAggregator()
```
    Description copied from interface: Facet
    
    An aggregator used to populate the facet state for this facet. It should accept the initial state returned by Facet.getInitialFacetState().
    
    Specified by:
    
    getAggregator in interface Facet
  - getFacetResult
```
public FacetResult getFacetResult(FacetState state)
```
    Description copied from interface: Facet
    
    Returns all the information necessary to render the facet in the UI (aggregation statistics and configuration combined).
    
    Specified by:
    
    getFacetResult in interface Facet