Package org.openrefine.history

Enum GridPreservation

java.lang.Object

java.lang.Enum<GridPreservation>

org.openrefine.history.GridPreservation

All Implemented Interfaces:

Serializable, Comparable<GridPreservation>

public enum GridPreservation
extends Enum<GridPreservation>
implements Comparable<GridPreservation>

Metadata encoding the properties of an Operation, to characterize how it transforms the grid. This is useful to the UI, to determine if and how it can preserve the scrolling position in the grid.

Enum Constant Summary

Enum Constants

Enum Constant	Description
NO_ROW_PRESERVATION	No guarantees are asserted about the transformation.
PRESERVES_RECORDS	Stronger than PRESERVES_ROWS: not only it preserves rows, but the record boundaries stay the same.
PRESERVES_ROWS	The project is guaranteed to have as many rows before and after the change.

Method Summary

Modifier and Type	Method	Description
static GridPreservation	valueOf(String name)	Returns the enum constant of this type with the specified name.
static GridPreservation[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Comparable

compareTo

Enum Constant Detail

NO_ROW_PRESERVATION

public static final GridPreservation NO_ROW_PRESERVATION

No guarantees are asserted about the transformation.

PRESERVES_ROWS

public static final GridPreservation PRESERVES_ROWS

The project is guaranteed to have as many rows before and after the change.

PRESERVES_RECORDS

public static final GridPreservation PRESERVES_RECORDS

Stronger than PRESERVES_ROWS: not only it preserves rows, but the record boundaries stay the same.

Method Detail

values

public static GridPreservation[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (GridPreservation c : GridPreservation.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static GridPreservation valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null