com.spss.psapi.extensions.common.spi

Interface DataModelProvider



  • public interface DataModelProvider
    A data model provider computes an output data model for a given input data model, set of properties, the object whose data model is being computed and the session.

    Note: this SPI was changed in a non-backward compatible way between Modeler API 12.0 and 12.0.1. Prior to Modeler API 12.0.1, this interface was not used by the extensions mechanism so there was no reason for an extension to implement it. New extensions should implement NodeDelegate instead of this interface.

    Since:
    PSAPI 12.0.1
    Version:
    2.0
    Author:
    Julian Clinton
    See Also:
    NodeDelegate
    • Method Detail

      • getOutputDataModel

        DataModel getOutputDataModel(DataModel inputDataModel,
                                   Properties properties,
                                   ExtensionObject extensionObject,
                                   SystemSession session)
                                     throws DataProviderException
        Returns the output data model for a given input data model, set of properties and the object (typically a node) who output data model is being computed. Implementations should use the input data model and properties provided as parameters rather than querying the object directly 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. A DataProviderException may be thrown; to indicate one or more diagnostic faults occurred during data model computation, whilst still providing an output data model. Throwing a DataProviderException will cause the node to be marked as invalid thus preventing execution.
        Parameters:
        inputDataModel - the input data model
        properties - the current property settings
        extensionObject - the extension object whose output data model is being computed
        session - the session through which the locale and data model factory can be accessed
        Returns:
        the output data model
        Throws:
        DataProviderException - if the data model cannot be constructed for some reason

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