Package org.openrefine.browsing.facets

Class StringFacet.Config

java.lang.Object

org.openrefine.browsing.facets.StringFacet.Config

All Implemented Interfaces:

FacetConfig

Enclosing class:

StringFacet

public static class StringFacet.Config
extends Object
implements FacetConfig

Field Summary

Fields

Modifier and Type	Field	Description
String	columnName
String	selected

Constructor Summary

Constructors

Constructor	Description
Config(String columnName, String selected)

Method Summary

Modifier and Type	Method	Description
Facet	apply(ColumnModel columnModel, Map<String,OverlayModel> overlayModels, long projectId)	Instantiates the given facet on a particular column model.
Set<String>	getColumnDependencies()	Computes the set of columns the facet depends on.
String	getJsonType()	The facet type as stored in json.
boolean	isNeutral()	A neutral facet is a facet that does not filter out any row, i.e. it is in its initial, reset state.
FacetConfig	renameColumnDependencies(Map<String,String> substitutions)	Updates the facet config after a renaming of columns.

Methods inherited from class java.lang.Object

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

Field Detail

columnName

public String columnName

selected

public String selected

Constructor Detail

Config

public Config(String columnName,
              String selected)

Method Detail

apply

public Facet apply(ColumnModel columnModel,
                   Map<String,OverlayModel> overlayModels,
                   long projectId)

Description copied from interface: FacetConfig

Instantiates the given facet on a particular column model. This allows to check the validity of the configuration against a particular table schema (checking that the dependent columns exist, for instance).

Specified by:

apply in interface FacetConfig

Parameters:

columnModel - the header of the table the facet is applied to.

overlayModels - the overlay models of the table the facet is applied to (can be accessed by expressions evaluated by the facet)

projectId - the id of the project this facet is evaluated on

Returns:

a computed facet on the given project.

getColumnDependencies

public Set<String> getColumnDependencies()

Description copied from interface: FacetConfig

Computes the set of columns the facet depends on. If the facet relies on an unknown set of columns, or if it is not row-wise, this returns null.

Specified by:

getColumnDependencies in interface FacetConfig

Returns:

the set of column names the facet depends on.

renameColumnDependencies

public FacetConfig renameColumnDependencies(Map<String,String> substitutions)

Description copied from interface: FacetConfig

Updates the facet config after a renaming of columns.

Specified by:

renameColumnDependencies in interface FacetConfig

Returns:

null if the update could not be performed, or the new facet config if the update could be performed.

isNeutral

public boolean isNeutral()

Description copied from interface: FacetConfig

A neutral facet is a facet that does not filter out any row, i.e. it is in its initial, reset state. Neutral facets are still useful to visualize the distribution of values in a column.

Specified by:

isNeutral in interface FacetConfig

getJsonType

public String getJsonType()

Description copied from interface: FacetConfig

The facet type as stored in json.

Specified by:

getJsonType in interface FacetConfig