RowRemovalOperation (OpenRefine 4.0-SNAPSHOT API)

java.lang.Object
- org.openrefine.operations.EngineDependentOperation
- - org.openrefine.operations.row.RowRemovalOperation

All Implemented Interfaces:: Operation

public class RowRemovalOperation
extends EngineDependentOperation

Field Summary
- Fields inherited from class org.openrefine.operations.EngineDependentOperation
  _engineConfig

Constructor Summary

Constructors
Constructor Description

RowRemovalOperation(EngineConfig engineConfig)

Method Summary

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

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

- Constructor Detail
  - RowRemovalOperation
```
public RowRemovalOperation(EngineConfig engineConfig)
```
- Method Detail
  - getDescription
```
public String getDescription()
```
    Description copied from interface: Operation
    
    A short human-readable description of what this operation does.
  - 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