com.pervasive.datarush.matching

Enum Phase.CleanupMode

java.lang.Object

java.lang.Enum<Phase.CleanupMode>

com.pervasive.datarush.matching.Phase.CleanupMode

All Implemented Interfaces:

Serializable, Comparable<Phase.CleanupMode>

Enclosing class:

Phase

public static enum Phase.CleanupMode
extends Enum<Phase.CleanupMode>

Specifies which fields to remove from records after completion of a phase.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL All input fields and any fields generated for field processing are removed.
INTERMEDIATE Only those fields generated for field processing should be removed.
NONE No fields should be removed, including those generated for field processing

Method Summary

Methods

Modifier and Type	Method and Description
boolean	removeInputs() Indicates whether input fields for the phase should be removed.
boolean	removeIntermediates() Indicates whether intermediate fields produced to get phase results should be removed.
static Phase.CleanupMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static Phase.CleanupMode[]	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

Enum Constant Detail

NONE

public static final Phase.CleanupMode NONE

No fields should be removed, including those generated for field processing

INTERMEDIATE

public static final Phase.CleanupMode INTERMEDIATE

Only those fields generated for field processing should be removed. Input fields are preserved.

ALL

public static final Phase.CleanupMode ALL

All input fields and any fields generated for field processing are removed. Only result fields are preserved.

Method Detail

values

public static Phase.CleanupMode[] 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 (Phase.CleanupMode c : Phase.CleanupMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static Phase.CleanupMode 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

removeIntermediates

public boolean removeIntermediates()

Indicates whether intermediate fields produced to get phase results should be removed.

Returns:

true to remove intermediate fields, false otherwise.

removeInputs

public boolean removeInputs()

Indicates whether input fields for the phase should be removed.

Returns:

true to remove input fields, false otherwise.