com.ibm.streams.flow.declare

Interface OperatorGraph

public interface OperatorGraph

OperatorGraph represents a declaration of a flow graph that contains Java primitive operators.

Since:

InfoSphere® Streams Version 3.1

Method Summary

Modifier and Type	Method and Description
<T extends Operator> OperatorInvocation<T>	addOperator(java.lang.Class<T> opClass) Declare an invocation of an Operator in this graph.
<T extends Operator> OperatorInvocation<T>	addOperator(java.lang.String name, java.lang.Class<T> opClass) Declare an invocation of an Operator in this graph.
boolean	compileChecks() Run compile checks for all the declared operators in the graph.

Method Detail

addOperator

<T extends Operator> OperatorInvocation<T> addOperator(java.lang.Class<T> opClass)

Declare an invocation of an Operator in this graph. This method is equivalent to calling addOperator(String, Class) with a generated name that is unique to this graph.

Type Parameters:

T - Type of the operator class

Parameters:

opClass - Class of the operator

Returns:

OperatorInvocation for this invocation

addOperator

<T extends Operator> OperatorInvocation<T> addOperator(java.lang.String name,
                                                       java.lang.Class<T> opClass)

Declare an invocation of an Operator in this graph.

Type Parameters:

T - Type of the operator class

Parameters:

name - Invocation name of the operator.

opClass - Class of the operator

Returns:

OperatorInvocation for this invocation

Throws:

java.lang.IllegalArgumentException - This graph already contains an operator named name

compileChecks

boolean compileChecks()
               throws java.lang.Exception

Run compile checks for all the declared operators in the graph. The compile time environment for the checks simulates an SPL standalone application.
During the compile, the OperatorContext has the following settings:

• toolkit directory - File that represents the Java system property named user.dir, which is the current working directory. This is is the same value as the application directory.

During the compile, the ProcessingElement has the following settings:

• instance identifier - The value of the Java system property named user.name, which is the current user identifier for the operating system.
• application directory - File that represents the Java system property named user.dir, which is the current working directory.
• data directory - File that represents the subdirectory named data in the application directory. This directory might not exist and is not created by the creation of this OperatorGraph, the execution of this method, or the execution of the OperatorInvocation.compileChecks(boolean) method.
• output directory - File that represents the subdirectory named output in the application directory. This directory might not exist and is not created by the creation of this OperatorGraph, the execution of this method, or the execution of the OperatorInvocation.compileChecks(boolean) method.
• application scope - The value Default.

Returns:

True if the context is valid, which means that the all checks passed. Otherwise, false.

Throws:

java.lang.Exception - The exception thrown by a compile time check.