Package org.openrefine.operations.recon

Class ReconOperation

java.lang.Object

org.openrefine.operations.EngineDependentOperation

org.openrefine.operations.recon.ReconOperation

All Implemented Interfaces:

Operation

public class ReconOperation
extends EngineDependentOperation

Runs reconciliation on a column.

TODO restore records mode

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	ReconOperation.Joiner
protected static class	ReconOperation.NonBlankRowFilter	Filter used to select only rows which have a non-blank value to reconcile.
protected static class	ReconOperation.ReconChangeDataProducer

Field Summary

Fields

Modifier and Type	Field	Description
protected String	_changeDataId
protected String	_columnName
protected ReconConfig	_reconConfig

Fields inherited from class org.openrefine.operations.EngineDependentOperation

_engineConfig

Constructor Summary

Constructors

Constructor	Description
ReconOperation(EngineConfig engineConfig, String columnName, ReconConfig reconConfig)

Method Summary

Modifier and Type	Method	Description
ChangeResult	apply(Grid projectState, ChangeContext context)	Derives the new grid state from the current grid state.
String	getColumnName()
String	getDescription()	A short human-readable description of what this operation does.
ReconConfig	getReconConfig()

Methods inherited from class org.openrefine.operations.EngineDependentOperation

getEngine, getEngineConfig

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openrefine.operations.Operation

getOperationId, isReproducible

Field Detail

_columnName

protected final String _columnName

_reconConfig

protected final ReconConfig _reconConfig

_changeDataId

protected final String _changeDataId

See Also:

Constant Field Values

Constructor Detail

ReconOperation

public ReconOperation(EngineConfig engineConfig,
                      String columnName,
                      ReconConfig reconConfig)

Method Detail

apply

public ChangeResult apply(Grid projectState,
                          ChangeContext context)
                   throws OperationException

Description copied from interface: Operation

Derives the new grid state from the current grid state. Executing this method should be quick (even on large datasets) since it is expected to just derive the new grid from the existing one without actually executing any expensive computation. Long-running computations should rather go in the derivation of a ChangeData which will be fetched asynchronously.

Parameters:

projectState - the state of the grid before the change

Returns:

an object which bundles up various pieces of information produced by the operation: primarily, the new grid after applying the operation. This object can be subclassed to expose more information, which should be serializable with Jackson so that it reaches the frontend.

Throws:

OperationException - when the change cannot be applied to the given grid

getDescription

public String getDescription()

Description copied from interface: Operation

A short human-readable description of what this operation does.

getReconConfig

public ReconConfig getReconConfig()

getColumnName

public String getColumnName()