Module datarush.library

Package com.pervasive.datarush.graphs

Enum GraphState

java.lang.Object

java.lang.Enum<GraphState>

com.pervasive.datarush.graphs.GraphState

All Implemented Interfaces:

Serializable, Comparable<GraphState>

public enum GraphState
extends Enum<GraphState>

Describes the state of a LogicalGraphInstance.

Enum Constant Summary

Enum Constants

Enum Constant	Description
COMPILED	The instance is ready to be executed.
COMPLETE_CANCELED	The instance was canceled while executing.
COMPLETE_FAILED	The instance had an error while executing.
COMPLETE_SUCCESS	The instance has finished execution.
EXECUTING	The instance is currently executing.

Method Summary

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

COMPILED

public static final GraphState COMPILED

The instance is ready to be executed.

EXECUTING

public static final GraphState EXECUTING

The instance is currently executing.

COMPLETE_SUCCESS

public static final GraphState COMPLETE_SUCCESS

The instance has finished execution.

COMPLETE_CANCELED

public static final GraphState COMPLETE_CANCELED

The instance was canceled while executing.

COMPLETE_FAILED

public static final GraphState COMPLETE_FAILED

The instance had an error while executing.

Method Detail

values

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

Returns:

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

valueOf

public static GraphState 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. A graph is considered "complete" if it is no longer running whether due to success, failure, or cancellation

Returns:

whether the state is a "complete" state

jobStatus

public abstract JobStatus jobStatus()

Returns the job status that corresponds to the given graph status.

Returns: