public interface ProcessorStream extends ProcessorDiagram, PropertiedObject, ParameterProvider
Processor
objects into a
connected "flow". It also provides the environment for setting which may be
used to modify node behaviour.Modifier and Type | Method and Description |
---|---|
void |
close()
Closes the current stream.
|
ServerDatabaseConnection |
createServerDatabaseConnection(java.util.List<java.lang.Object> driverConnection)
Creates a database connection associated with the supplied server using the supplied information.
|
ServerDatabaseConnection |
createServerDatabaseConnection(java.lang.String datasourceName,
java.lang.String userName,
java.lang.String password,
java.lang.String catalogName)
Creates a
ServerDatabaseConnection . |
ConnectedServerInfo |
getConnectedServerInfo()
Returns information about the remote server to which this stream
is connected, or
null if the stream is not connected
to a remote server. |
ContentProvider |
getContentProvider()
Returns the
ContentProvider for this stream. |
GlobalValues |
getGlobalValues()
Returns the global values computed for this stream.
|
java.lang.String |
getID()
Returns the temporary session ID of this object.
|
java.lang.String |
getRuntimeName()
Returns the name of the runtime environment against which this stream will execute.
|
ServerConnectionDescriptor |
getServerConnectionDescriptor()
Returns the ServerConnectionDescriptor used to connect this stream to a
server or
null if the stream has not yet been connected or
if the owner session was not created using SessionFactory. |
boolean |
isClosed()
Returns
true if the stream has been closed, false otherwise. |
boolean |
isConnected()
Returns
true if this has a server connection. |
boolean |
isExecuting()
Returns
true if this stream is currently executing. |
boolean |
isExportable(FileFormat format)
Returns
true if this stream can be exported using the
supplied FileFormat or false otherwise. |
ExecutionHandle |
run(java.lang.String action,
java.util.Map<java.lang.String,?> settings,
Processor[] nodes,
java.util.Collection results)
Executes the supplied array of nodes synchronously and waits for them to complete.
|
ExecutionHandle |
runAll(java.util.Collection results)
Executes the stream synchronously and waits for it to complete.
|
ExecutionHandle |
runScript(java.util.Collection results)
Executes the stream script synchronously and waits for it to complete.
|
ExecutionHandle |
runSelected(Processor[] nodes,
java.util.Collection results)
Executes the supplied array of nodes synchronously and waits for them to complete.
|
void |
setID(java.lang.String id)
Sets the ID for this stream.
|
void |
setName(java.lang.String name)
Sets the name for this stream.
|
ExecutionHandle |
spawn(java.lang.String action,
java.util.Map<java.lang.String,?> settings,
Processor[] nodes,
java.util.Collection results)
Creates and executes the supplied array of nodes asynchronously and waits for them to complete.
|
clear, commentCount, comments, create, createAt, createCommentAt, createCompositeAt, createModelApplier, createModelApplierAt, delete, deleteAll, deleteComment, deleteComments, disconnect, expandComposite, findAll, findAll, findAll, findByID, findByType, findCommentByID, findDownstream, findProcessorForID, findProcessorForID, findProcessorLabel, findProcessorType, findUpstream, flushCaches, getHeight, getProcessorCount, getProcessorFactory, getWidth, insert, insert, isEnabled, isOwner, isValidLink, iterator, link, link, linkBetween, linkPath, linkUpdater, predecessorAt, predecessorCount, predecessors, processorIterator, replace, setEnabled, setSize, size, successorAt, successorCount, successors, unlink, unlink, unlinkPath, unlinkUpdater
clearKeyedProperty, creationDate, getKeyedPropertyKeys, getKeyedPropertyValue, getLabel, getName, getPropertyType, getPropertyValue, getSavedByVersion, getStructuredPropertyDefinition, isKeyedProperty, isLocked, isProperty, isServerConnectionRequiredProperty, propertyIterator, setKeyedPropertyValue, setLabel, setPropertyValue, setPropertyValues, setPropertyValuesFrom, unlock
getParameterDefinition, getParameterLabel, getParameterStorage, getParameterType, getParameterValue, parameterIterator, setParameterLabel, setParameterStorage, setParameterType, setParameterValue
java.lang.String getID()
void setID(java.lang.String id)
id
- the stream IDgetID()
void setName(java.lang.String name)
name
- the new stream namevoid close()
boolean isClosed()
true
if the stream has been closed, false
otherwise.true
if the stream has been closedboolean isConnected()
true
if this has a server connection.true
if this has a server connectionboolean isExportable(FileFormat format)
true
if this stream can be exported using the
supplied FileFormat
or false
otherwise.fileFormat
- the FileFormat
true
if this stream can be exported using the
supplied FileFormat
, false
otherwiseboolean isExecuting()
true
if this stream is currently executing.true
if this stream is currently executingServerConnectionDescriptor getServerConnectionDescriptor()
null
if the stream has not yet been connected or
if the owner session was not created using SessionFactory.null
ConnectedServerInfo getConnectedServerInfo()
null
if the stream is not connected
to a remote server.
A remote server is connected using a server connection descriptor so if there is no connection descriptor there will be no connected server information.
getServerConnectionDescriptor()
ContentProvider getContentProvider()
ContentProvider
for this stream.
The content provider manages additional content on behalf of applications.ExecutionHandle runAll(java.util.Collection results) throws OwnerException, ObjectLockedException, ServerConnectionException, SessionException
ExecutionHandle
which can be used to access the exit status and any result from the task.results
- an empty collection that will contain any built objects once execution has completedOwnerException
- if the stream was not created by this sessionObjectLockedException
- if the stream is lockedServerConnectionException
- if the stream is not connected to a serverSessionException
- if the session is already running
another task, cannot execute the task or if execution completes in
a state other than SUCCESS
runSelected(Processor[], Collection)
,
runScript(Collection)
,
Processor.run(Collection)
ExecutionHandle runSelected(Processor[] nodes, java.util.Collection results) throws OwnerException, ObjectLockedException, ServerConnectionException, SessionException
ExecutionHandle
which can be used to access the exit status and any result from the task.nodes
- the array of Processor
objects to be executedresults
- an empty collection that will contain any built objects once execution has completedOwnerException
- if the nodes are not all owned by this streamObjectLockedException
- if the stream is lockedServerConnectionException
- if the stream is not connected to a serverSessionException
- if the session is already running a stream,
another task, cannot execute the task or if execution completes in
a state other than SUCCESS
java.lang.IllegalArgumentException
- if the array is emptyrunAll(Collection)
,
Processor.run(Collection)
ExecutionHandle runScript(java.util.Collection results) throws OwnerException, ObjectLockedException, ServerConnectionException, SessionException
ExecutionHandle
which can be used to access the exit status and any result from the task.results
- an empty collection that will contain any built objects once execution has completedOwnerException
- if the stream was not created by this sessionObjectLockedException
- if the stream is lockedServerConnectionException
- if the stream is not connected to a serverSessionException
- if the session is already running
another task, cannot execute the task or if execution completes in
a state other than SUCCESS
runAll(Collection)
,
runSelected(Processor[], Collection)
,
Processor.run(Collection)
ExecutionHandle run(java.lang.String action, java.util.Map<java.lang.String,?> settings, Processor[] nodes, java.util.Collection results) throws OwnerException, ObjectLockedException, ServerConnectionException, SessionException
ExecutionHandle
which can be used to access the exit status and any result from the task.action
- the action to perform on the nodessettings
- any parameters of the actionnodes
- the array of Processor
objects to be executedresults
- receives the results of a successful execution (if any)OwnerException
- if the nodes are not all owned by this streamObjectLockedException
- if the stream is lockedServerConnectionException
- if the stream is not connected to a serverSessionException
- if the session is already running a stream,
another task, cannot execute the task or if execution completes in
a state other than SUCCESS
ExecutionHandle spawn(java.lang.String action, java.util.Map<java.lang.String,?> settings, Processor[] nodes, java.util.Collection results) throws OwnerException, ObjectLockedException, ServerConnectionException, SessionException
ExecutionHandle
which can be used to monitor and control the progress of the task.
There must be at least one node in the array.action
- the action to perform on the nodessettings
- any parameters of the actionnodes
- the array of Processor
objects to be executedresults
- receives the results of a successful execution (if any)OwnerException
- if the nodes are not all owned by this streamObjectLockedException
- if the stream is lockedServerConnectionException
- if the stream is not connected to a serverSessionException
- if the session is already running a stream,
another task or cannot execute the taskGlobalValues getGlobalValues()
ServerDatabaseConnection createServerDatabaseConnection(java.lang.String datasourceName, java.lang.String userName, java.lang.String password, java.lang.String catalogName) throws ServerConnectionException, ServerResourceException
ServerDatabaseConnection
. The datasource name must visible
to the data mining server.datasourceName
- the datasource nameuserName
- the user namepassword
- the passwordcatalogName
- the catalog nameServerDatabaseConnection
ServerConnectionException
- if the session is not connected to a serverServerResourceException
- if the connection task fails.ServerDatabaseConnection createServerDatabaseConnection(java.util.List<java.lang.Object> driverConnection) throws ServerConnectionException, ServerResourceException
driverConnection
- the driver connection informationServerConnectionException
ServerResourceException
java.lang.String getRuntimeName()
spss-modeler
.(C) Copyright IBM Corp. 1994, 2015. All Rights Reserved.