com.spss.psapi.transform

Interface ProcessorStream

    • Method Detail

      • getID

        java.lang.String getID()
        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.
        Returns:
        the temporary session ID of this object
        Since:
        PSAPI 2.0
      • close

        void 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.
      • isClosed

        boolean isClosed()
        Returns true if the stream has been closed, false otherwise.
        Returns:
        true if the stream has been closed
      • isConnected

        boolean isConnected()
        Returns true if this has a server connection.
        Returns:
        true if this has a server connection
      • isExportable

        boolean isExportable(FileFormat format)
        Returns true if this stream can be exported using the supplied FileFormat or false otherwise.
        Parameters:
        fileFormat - the FileFormat
        Returns:
        true if this stream can be exported using the supplied FileFormat, false otherwise
      • getServerConnectionDescriptor

        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.
        Returns:
        the ServerConnectionDescriptor used to connect this stream to a server or null
      • getConnectedServerInfo

        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.

        A remote server is connected using a server connection descriptor so if there is no connection descriptor there will be no connected server information.

        Returns:
        information about the server to which this stream is connected
        Since:
        PSAPI 17.0
        See Also:
        getServerConnectionDescriptor()
      • getContentProvider

        ContentProvider getContentProvider()
        Returns the ContentProvider for this stream. The content provider manages additional content on behalf of applications.
        Returns:
        the content provider for this stream
        Since:
        PSAPI 13.0
      • getGlobalValues

        GlobalValues getGlobalValues()
        Returns the global values computed for this stream. Global values are constructed and updated by executing a "setglobals" node.
        Returns:
        the global values for the stream
        Since:
        PSAPI 16.0.0
      • createServerDatabaseConnection

        ServerDatabaseConnection createServerDatabaseConnection(java.lang.String datasourceName,
                                                              java.lang.String userName,
                                                              java.lang.String password,
                                                              java.lang.String catalogName)
                                                                throws ServerConnectionException,
                                                                       ServerResourceException
        Creates a ServerDatabaseConnection. The datasource name must visible to the data mining server.
        Parameters:
        datasourceName - the datasource name
        userName - the user name
        password - the password
        catalogName - the catalog name
        Returns:
        a ServerDatabaseConnection
        Throws:
        ServerConnectionException - if the session is not connected to a server
        ServerResourceException - if the connection task fails.
        Since:
        PSAPI 16.0.2

(C) Copyright IBM Corp. 1994, 2015. All Rights Reserved.