Package org.openrefine.browsing.facets

Class TextSearchFacet

java.lang.Object

org.openrefine.browsing.facets.TextSearchFacet

All Implemented Interfaces:

Facet

public class TextSearchFacet
extends Object
implements Facet

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TextSearchFacet.TextSearchAggregator
static class	TextSearchFacet.TextSearchFacetConfig
static class	TextSearchFacet.TextSearchFacetState

Field Summary

Fields

Modifier and Type	Field	Description
protected int	_cellIndex
protected TextSearchFacet.TextSearchFacetConfig	_config
protected Pattern	_pattern
protected String	_query

Constructor Summary

Constructors

Constructor	Description
TextSearchFacet(TextSearchFacet.TextSearchFacetConfig config, int cellIndex)

Method Summary

Modifier and Type	Method	Description
FacetAggregator<?>	getAggregator()	An aggregator used to populate the facet state for this facet.
String	getColumnName()
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.
String	getMode()
String	getName()
String	getQuery()
boolean	isCaseSensitive()
boolean	isInverted()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_config

protected TextSearchFacet.TextSearchFacetConfig _config

_cellIndex

protected int _cellIndex

_pattern

protected Pattern _pattern

_query

protected String _query

Constructor Detail

TextSearchFacet

public TextSearchFacet(TextSearchFacet.TextSearchFacetConfig config,
                       int cellIndex)

Method Detail

getName

public String getName()

getColumnName

public String getColumnName()

getQuery

public String getQuery()

getMode

public String getMode()

isCaseSensitive

public boolean isCaseSensitive()

isInverted

public boolean isInverted()

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