com.spss.psapi.extensions.common.spi2

Interface NodeDelegate

  • All Superinterfaces:
    ExtensionObjectDelegate


    public interface NodeDelegate
    extends ExtensionObjectDelegate
    Defines the methods supported by a node delegate. A node delegate instance is created for each ExtensionProcessor instance. The implementing class must declare a no-argument constructor. The path of the implementing class is specified in the "delegate" attribute of the relevant Node element in the extension.xml file.
    Since:
    PSAPI 17.0
    Author:
    Julian Clinton
    See Also:
    ExtensionProcessor
    • Method Detail

      • initNodeDelegate

        void initNodeDelegate(NodeContext nodeContext)
        Called when an ExtensionProcessor is being initialised.
        Parameters:
        nodeContext - the node context
      • disposeNodeDelegate

        void disposeNodeDelegate(NodeContext nodeContext)
        Called when an ExtensionProcessor is being disposed of. This allows a delegate to dispose of any system resources it has allocated during its lifetime.
        Parameters:
        nodeContext - the node context
      • getOutputDataModel

        DataModel getOutputDataModel(DataModel inputDataModel,
                                   Properties properties,
                                   NodeContext nodeContext)
                                     throws ExtensionException
        Returns the output data model for a given input data model and set of properties. Implementations should generally use the input data model and properties because this method may be used to compute data models using properties set in the user interface which may not have been committed back to the extension object.
        Parameters:
        inputDataModel - the input data model
        properties - the current property settings
        nodeContext - the node context
        Returns:
        the output data model
        Throws:
        ExtensionException - if the data model cannot be computed for some reason
      • getExecutionHandler

        ExecutionHandler getExecutionHandler(NodeContext nodeContext,
                                           ExecutionContext executionContext)
        Returns the execution handler that is responsible for generating the execution plan or null if the execution method is defined directly in the extension XML. The supplied execution context should be used as a hint for which execution handler to return and may not necessarily be the same execution context that gets passed to that handler.
        Parameters:
        nodeContext - the node context
        executionContext - an execution context to be used as a hint for which execution handler to return
        Returns:
        the execution handler or null

Copyright © 2014 Integral Solutions Ltd. All Rights Reserved.