Package org.openrefine.operations.row

Class RowReorderOperation

java.lang.Object

org.openrefine.operations.row.RowReorderOperation

All Implemented Interfaces:

Operation

public class RowReorderOperation
extends Object
implements Operation

An operation which reorders the rows of the grid permanently according to a given sorting configuration.

Author:

Antonin Delpeuch

Field Summary

Fields

Modifier and Type	Field	Description
protected Engine.Mode	_mode
protected SortingConfig	_sorting

Constructor Summary

Constructors

Constructor	Description
RowReorderOperation(Engine.Mode mode, SortingConfig sorting)

Method Summary

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.
Engine.Mode	getMode()
SortingConfig	getSortingConfig()

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

_mode

protected final Engine.Mode _mode

_sorting

protected final SortingConfig _sorting

Constructor Detail

RowReorderOperation

public RowReorderOperation(Engine.Mode mode,
                           SortingConfig sorting)

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.

Specified by:

apply in interface Operation

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

getMode

public Engine.Mode getMode()

getSortingConfig

public SortingConfig getSortingConfig()

getDescription

public String getDescription()

Description copied from interface: Operation

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

Specified by:

getDescription in interface Operation