Module datarush.library

Package com.pervasive.datarush.graphs

Enum OperatorState

java.lang.Object

java.lang.Enum<OperatorState>

com.pervasive.datarush.graphs.OperatorState

All Implemented Interfaces:

Serializable, Comparable<OperatorState>

public enum OperatorState
extends Enum<OperatorState>

The execution state of an operator within a graph.

Enum Constant Summary

Enum Constants

Enum Constant	Description
COMPILED	The operator is ready to be executed
COMPLETE_CANCELED	The operator was cancelled
COMPLETE_FAILED_PRIMARY_ERROR	The operator failed and was the primary cause of the failure of the graph
COMPLETE_FAILED_SECONDARY_ERROR	The operator failed because it was in a graph that failed
COMPLETE_SUCCESS	The operator has completed sucessfully
EXECUTING	The operator is currently executing
INITIAL	The operator has not been compiled yet, usually because it is waiting for upstream metadata

Method Summary

Modifier and Type	Method	Description
boolean	isComplete()	Returns true if the state corresponds to a "complete" state.
static OperatorState	valueOf(String name)	Returns the enum constant of this type with the specified name.
static OperatorState[]	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

INITIAL

public static final OperatorState INITIAL

The operator has not been compiled yet, usually because it is waiting for upstream metadata

COMPILED

public static final OperatorState COMPILED

The operator is ready to be executed

EXECUTING

public static final OperatorState EXECUTING

The operator is currently executing

COMPLETE_SUCCESS

public static final OperatorState COMPLETE_SUCCESS

The operator has completed sucessfully

COMPLETE_CANCELED

public static final OperatorState COMPLETE_CANCELED

The operator was cancelled

COMPLETE_FAILED_PRIMARY_ERROR

public static final OperatorState COMPLETE_FAILED_PRIMARY_ERROR

The operator failed and was the primary cause of the failure of the graph

COMPLETE_FAILED_SECONDARY_ERROR

public static final OperatorState COMPLETE_FAILED_SECONDARY_ERROR

The operator failed because it was in a graph that failed

Method Detail

values

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

Returns:

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

valueOf

public static OperatorState 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

isComplete

public boolean isComplete()

Returns true if the state corresponds to a "complete" state. An operator is considered "complete" if it is no longer running whether due to success, failure, or cancellation

Returns:

whether the state is a "complete" state