Stream Objects

Subclass of Diagram, PropertiedObject, ParameterProvider.

This is the top-level container used to assemble Node objects into a connected "flow". It also provides the environment for setting which may be used to modify node behaviour.

s.close()

Closes the current stream. If the stream is already closed, this method does nothing. No further operations can be applied to a closed stream.

s.getContentProvider() : ContentProvider

Returns the ContentProvider for this stream. The content provider manages additional content on behalf of applications.

s.getGlobalValues() : GlobalValues

Returns the global values computed for this stream. Global values are constructed and updated by executing a Set Globals node.

s.getID() : string

Returns the temporary session ID of this object. A new ID is allocated each time a new stream is created or opened and the ID is not persisted when the stream is saved. This means that if the same persisted object is re-opened multiple times, each object will have a different ID.

s.getServerConnectionDescriptor() : ServerConnectionDescriptor

Returns the ServerConnectionDescriptor used to connect this stream to a server or None if the stream has not yet been connected or if the owner session was not created using SessionFactory.

s.isClosed() : boolean

Returns True if the stream has been closed, False otherwise.

s.isConnected() : boolean

Returns True if this has a server connection.

s.isExportable(format) : boolean
format (FileFormat) : 

Returns True if this stream can be exported using the supplied FileFormat or False otherwise.

s.runAll(results) : ExecutionHandle

results (Collection) : an empty collection that will contain any built objects once execution has completed

Executes the stream synchronously and waits for it to complete. Returns an ExecutionHandle which can be used to access the exit status and any result from the task.

Exceptions:

OwnerException : if the stream was not created by this session

ObjectLockedException : if the stream is locked

ServerConnectionException : if the stream is not connected to a server

SessionException : if the session is already running another task, cannot execute the task or if execution completes in a state other than SUCCESS

s.runScript(results) : ExecutionHandle

results (Collection) : an empty collection that will contain any built objects once execution has completed

Executes the stream script synchronously and waits for it to complete. The stream script is always run regardless of whether script execution is set as the default behaviour. Returns an ExecutionHandle which can be used to access the exit status and any result from the task.

Exceptions:

OwnerException : if the stream was not created by this session

ObjectLockedException : if the stream is locked

ServerConnectionException : if the stream is not connected to a server

SessionException : if the session is already running another task, cannot execute the task or if execution completes in a state other than SUCCESS

s.runSelected(nodes, results) : ExecutionHandle

nodes (Node[]) : the array of Node objects to be executed

results (Collection) : an empty collection that will contain any built objects once execution has completed

Executes the supplied array of nodes synchronously and waits for them to complete. There must be at least one node in the array. Returns an ExecutionHandle which can be used to access the exit status and any result from the task.

Exceptions:

OwnerException : if the nodes are not all owned by this stream

ObjectLockedException : if the stream is locked

ServerConnectionException : if the stream is not connected to a server

SessionException : if the session is already running a stream, another task, cannot execute the task or if execution completes in a state other than SUCCESS

IllegalArgumentException : if the array is empty