com.spss.psapi.transform

Interface Processor

    • Method Detail

      • getID

        java.lang.String getID()
        Returns the ID of this object. A new ID is created each time a new node is created. The ID is persisted with the node when it is saved as part of a stream so that when the stream is opened, the node IDs are preserved. However, if a saved node is inserted into a stream, the insert node is considered to be a new object and will be allocated a new ID.
        Returns:
        the ID of this object
        Since:
        PSAPI 2.0
      • getProcessorType

        ProcessorType getProcessorType()
        Returns the type of the node.
        Returns:
        the type of the node
      • getTypeName

        java.lang.String getTypeName()
        Returns the name of this type of node.
        Returns:
        the name of this type of node
        Since:
        PSAPI 16.0.0
      • isInitial

        boolean isInitial()
        Returns true if this is an initial node i.e. one that occurs at the start of a stream.
        Returns:
        true if this is an initial node, false otherwise
        Since:
        PSAPI 16.0.0
        See Also:
        isInline(), isTerminal()
      • isInline

        boolean isInline()
        Returns true if this is an in-line node i.e. one that occurs mid-stream.
        Returns:
        true if this is an in-line node, false otherwise
        Since:
        PSAPI 16.0.0
        See Also:
        isInitial(), isTerminal()
      • isTerminal

        boolean isTerminal()
        Returns true if this is a terminal node i.e. one that occurs at the end of a stream.
        Returns:
        true if this is a terminal node, false otherwise
        Since:
        PSAPI 16.0.0
        See Also:
        isInitial(), isInline()
      • setCacheEnabled

        void setCacheEnabled(boolean val)
        Enables or disables the cache for this object. If the cache is full and the cacheing becomes disabled, the cache is flushed.
        Parameters:
        val -
        See Also:
        isCacheEnabled(), flushCache()
      • isCacheEnabled

        boolean isCacheEnabled()
        Returns true if the cache is enabled, false otherwise.
        Returns:
        true if the cache is enabled, false otherwise
        See Also:
        setCacheEnabled(boolean), flushCache()
      • isCacheFull

        boolean isCacheFull()
        Returns true if the cache is full, false otherwise.
        Returns:
        true if the cache is full, false otherwise
        See Also:
        flushCache()
      • getInputDataModel

        DataModel getInputDataModel()
        Returns the DataModel coming into this node. The result is the output data model of the first predecessor or an empty data model if there are no predecessors.

        This is a convenience function for the common case where a processor has at most one predecessor.

        Returns:
        the DataModel coming into this node
        See Also:
        DataModel
      • getOutputDataModel

        DataModel getOutputDataModel()
        Returns the DataModel output by this node.
        Returns:
        the DataModel output by this node
        See Also:
        DataModel
      • getProcessorStream

        ProcessorStream getProcessorStream()
        Returns the ProcessorStream that owns this node.
        Returns:
        the ProcessorStream that owns this node
      • getProcessorDiagram

        ProcessorDiagram getProcessorDiagram()
        Returns the ProcessorDiagram that owns this node.
        Returns:
        the ProcessorDiagram that owns this node
        Since:
        PSAPI 1.2
      • getXPosition

        int getXPosition()
        Returns the x position offset of the node in the ProcessorDiagram.
        Returns:
        the x position
        Since:
        PSAPI 16.0.0
      • getYPosition

        int getYPosition()
        Returns the y position offset of the node in the ProcessorDiagram.
        Returns:
        the y position
        Since:
        PSAPI 16.0.0
      • setXYPosition

        void setXYPosition(int x,
                         int y)
        Sets the position of the node in the ProcessorDiagram.
        Parameters:
        x - the x offset
        y - the y offset
        Since:
        PSAPI 16.0.0
      • setPositionBetween

        void setPositionBetween(Processor source,
                              Processor target)
        Sets the position of the node in the ProcessorDiagram so it is positioned between the supplied nodes.
        Parameters:
        source - the predecessor
        target - the successor
        Since:
        PSAPI 16.0.0
      • setName

        void setName(java.lang.String name)
        Sets the name for this node. The name is also used as the label if a separate label has not been set.
        Parameters:
        name - the new node name
        Since:
        PSAPI 18.1
      • runAction

        ExecutionHandle runAction(java.lang.String action,
                                java.util.Map<java.lang.String,?> settings,
                                java.util.Collection results)
                                  throws OwnerException,
                                         ObjectLockedException,
                                         ServerConnectionException,
                                         SessionException
        Executes the specified action against this node and waits for execution to complete. A typical action is the string "preview" that executes the stream up to (and including) this node and returns a preview of the output in the form of a table. The settings can be used to configure the action (although preview has no settings). Returns an ExecutionHandle which can be used to access the exit status and any result from the task.
        Parameters:
        action - the action to perform on this node
        settings - any parameters of the action
        results - receives the results of a successful execution (if any)
        Returns:
        the execution handle
        Throws:
        OwnerException - if there is inconsistent ownership
        ObjectLockedException - if the owner stream is locked for some reason (for example, it is already executing)
        ServerConnectionException - if the connection to the server cannot be established
        SessionException - if some other exception occurs
        Since:
        PSAPI 18.1

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