Package org.openrefine.operations.column

Class ColumnRenameOperation

java.lang.Object

org.openrefine.operations.EngineDependentOperation

org.openrefine.operations.RowMapOperation

org.openrefine.operations.column.ColumnRenameOperation

All Implemented Interfaces:

Operation

public class ColumnRenameOperation
extends RowMapOperation

Nested Class Summary

Nested classes/interfaces inherited from class org.openrefine.operations.RowMapOperation

RowMapOperation.GridMap

Field Summary

Fields

Modifier and Type	Field	Description
protected String	_newColumnName
protected String	_oldColumnName

Fields inherited from class org.openrefine.operations.EngineDependentOperation

_engineConfig

Constructor Summary

Constructors

Constructor	Description
ColumnRenameOperation(String oldColumnName, String newColumnName)

Method Summary

Modifier and Type	Method	Description
String	getDescription()	A short human-readable description of what this operation does.
EngineConfig	getEngineConfig()
ColumnModel	getNewColumnModel(Grid state, ChangeContext context)	Returns the column model after the change is applied to the given grid.
String	getNewColumnName()
String	getOldColumnName()
protected RowInRecordMapper	getPositiveRowMapper(Grid state, ChangeContext context)	Returns the row mapper applied to the rows matched by the filter.

Methods inherited from class org.openrefine.operations.RowMapOperation

apply, getGridMap, getNegativeRowMapper, getNewOverlayModels, postTransform

Methods inherited from class org.openrefine.operations.EngineDependentOperation

getEngine

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

_oldColumnName

protected final String _oldColumnName

_newColumnName

protected final String _newColumnName

Constructor Detail

ColumnRenameOperation

public ColumnRenameOperation(String oldColumnName,
                             String newColumnName)

Method Detail

getOldColumnName

public String getOldColumnName()

getNewColumnName

public String getNewColumnName()

getDescription

public String getDescription()

Description copied from interface: Operation

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

getNewColumnModel

public ColumnModel getNewColumnModel(Grid state,
                                     ChangeContext context)
                              throws OperationException

Description copied from class: RowMapOperation

Returns the column model after the change is applied to the given grid. By default, returns the same column model.

Overrides:

getNewColumnModel in class RowMapOperation

Parameters:

state - the grid to which the change should be applied

Returns:

the column model of the new grid

Throws:

OperationException

getPositiveRowMapper

protected RowInRecordMapper getPositiveRowMapper(Grid state,
                                                 ChangeContext context)
                                          throws OperationException

Description copied from class: RowMapOperation

Returns the row mapper applied to the rows matched by the filter.

Overrides:

getPositiveRowMapper in class RowMapOperation

Parameters:

state - the initial state of the grid

Throws:

OperationException

getEngineConfig

public EngineConfig getEngineConfig()

Overrides:

getEngineConfig in class EngineDependentOperation