Package org.openrefine.operations.column

Class ColumnRemovalOperation

java.lang.Object

org.openrefine.operations.EngineDependentOperation

org.openrefine.operations.RowMapOperation

org.openrefine.operations.column.ColumnRemovalOperation

All Implemented Interfaces:

Operation

public class ColumnRemovalOperation
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 List<String>	_columnNames

Fields inherited from class org.openrefine.operations.EngineDependentOperation

_engineConfig

Constructor Summary

Constructors

Constructor	Description
ColumnRemovalOperation(String columnName, List<String> columnNames)	Constructor for JSON deserialization, which accepts "columnName" as a single column to remove, for compatibility with previous syntaxes.
ColumnRemovalOperation(List<String> columnNames)	Constructor.

Method Summary

Modifier and Type	Method	Description
List<String>	getColumnName()
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.
RowInRecordMapper	getPositiveRowMapper(Grid state, ChangeContext context)	Returns the row mapper applied to the rows matched by the filter.
protected static RowInRecordMapper	mapper(List<Integer> columnIndices, int keyColumnIndex)

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

_columnNames

protected final List<String> _columnNames

Constructor Detail

ColumnRemovalOperation

public ColumnRemovalOperation(List<String> columnNames)

Constructor.

Parameters:

columnNames - list of column names to remove

ColumnRemovalOperation

public ColumnRemovalOperation(String columnName,
                              List<String> columnNames)

Constructor for JSON deserialization, which accepts "columnName" as a single column to remove, for compatibility with previous syntaxes.

Method Detail

getColumnName

public List<String> getColumnName()

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

public 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

mapper

protected static RowInRecordMapper mapper(List<Integer> columnIndices,
                                          int keyColumnIndex)

getEngineConfig

public EngineConfig getEngineConfig()

Overrides:

getEngineConfig in class EngineDependentOperation