Package org.openrefine.browsing.facets

Class TimeRangeFacet.TimeRangeFacetConfig

java.lang.Object

org.openrefine.browsing.facets.TimeRangeFacet.TimeRangeFacetConfig

All Implemented Interfaces:

Serializable, FacetConfig

Enclosing class:

TimeRangeFacet

public static class TimeRangeFacet.TimeRangeFacetConfig
extends Object
implements FacetConfig, Serializable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	_columnName
protected String	_errorMessage
protected Evaluable	_evaluable
protected String	_expression
protected String	_name

Constructor Summary

Constructors

Constructor	Description
TimeRangeFacetConfig(String name, String expression, String columnName, double from, double to, boolean selectTime, boolean selectNonTime, boolean selectBlank, boolean selectError)

Method Summary

Modifier and Type	Method	Description
TimeRangeFacet	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.
double	getFrom()
String	getJsonType()	The facet type as stored in json.
boolean	getSelectBlank()
boolean	getSelectError()
boolean	getSelectNonTime()
boolean	getSelectTime()
double	getTo()
boolean	isNeutral()	A neutral facet is a facet that does not filter out any row, i.e. it is in its initial, reset state.
protected boolean	isSelected()
TimeRangeFacet.TimeRangeFacetConfig	renameColumnDependencies(Map<String,String> substitutions)	Updates the facet config after a renaming of columns.
void	setFrom(double from)
void	setTo(double to)

Methods inherited from class java.lang.Object

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

Field Detail

_name

protected String _name

_expression

protected String _expression

_columnName

protected String _columnName

_evaluable

protected Evaluable _evaluable

_errorMessage

protected String _errorMessage

Constructor Detail

TimeRangeFacetConfig

public TimeRangeFacetConfig(String name,
                            String expression,
                            String columnName,
                            double from,
                            double to,
                            boolean selectTime,
                            boolean selectNonTime,
                            boolean selectBlank,
                            boolean selectError)

Method Detail

isSelected

protected boolean isSelected()

apply

public TimeRangeFacet 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.

getJsonType

public String getJsonType()

Description copied from interface: FacetConfig

The facet type as stored in json.

Specified by:

getJsonType in interface FacetConfig

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 TimeRangeFacet.TimeRangeFacetConfig 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

getSelectTime

public boolean getSelectTime()

getSelectNonTime

public boolean getSelectNonTime()

getSelectBlank

public boolean getSelectBlank()

getSelectError

public boolean getSelectError()

getFrom

public double getFrom()

setFrom

public void setFrom(double from)

getTo

public double getTo()

setTo

public void setTo(double to)