com.spss.psapi.transform

Interface OutputFactory

  • All Known Subinterfaces:
    SessionObjectFactory


    public interface OutputFactory
    A factory class that creates BuiltObject instances.
    Since:
    PSAPI 2.0
    Version:
    1.0
    Author:
    Rob Duncan
    Specification Status:
    Under development
    • Method Detail

      • createModelOutput

        ModelOutput createModelOutput(ModelApplier applier)
                                      throws ObjectCreationException
        Creates a model output from the specified model applier node. The output contains the same model detail as the applier.
        Parameters:
        applier - the model applier
        Returns:
        a model output
        Throws:
        ObjectCreationException - if the output cannot be created for any reason
      • createExtensionModelOutput

        ModelOutput createExtensionModelOutput(java.lang.String extensionId,
                                             java.lang.String extensionElementId,
                                             java.lang.String name,
                                             ModelContainer primaryModel,
                                             ObjectBuilder builder)
                                               throws ObjectCreationException
        Constructs a model output object whose definition is specified by an extension.
        Parameters:
        extensionId - the extension id
        extensionElementId - the id of the model output declared by the extension
        name - the object name
        primaryModel - the primary model
        builder - the builder (may be null)
        Returns:
        the model output object
        Throws:
        ObjectCreationException - if an error occurs during object construction or initialization e.g., if the extension is not loaded or the specified element id is not defined by the extension
        Since:
        PSAPI 12.0.1
      • createExtensionDocumentOutput

        DocumentOutput createExtensionDocumentOutput(java.lang.String extensionId,
                                                   java.lang.String extensionElementId,
                                                   java.lang.String name,
                                                   DocumentContainer primaryDocument,
                                                   ObjectBuilder builder)
                                                     throws ObjectCreationException
        Constructs a document output object based on a document container whose definition is specified by an extension.
        Parameters:
        extensionId - the extension id
        extensionElementId - the id of the model output declared by the extension
        name - the object name
        primaryDocument - the primary document
        builder - the builder (may be null)
        Returns:
        the document output object
        Throws:
        ObjectCreationException - if an error occurs during object construction or initialization e.g., if the extension is not loaded or the specified element id is not defined by the extension
        Since:
        PSAPI 12.0.1
      • createExtensionDocumentOutput

        DocumentOutput createExtensionDocumentOutput(java.lang.String extensionId,
                                                   java.lang.String extensionElementId,
                                                   java.lang.String name,
                                                   RowSetContainer primaryRowSet,
                                                   ObjectBuilder builder)
                                                     throws ObjectCreationException
        Constructs a document output object based on a row set container whose definition is specified by an extension.
        Parameters:
        extensionId - the extension id
        extensionElementId - the id of the model output declared by the extension
        name - the object name
        primaryRowSet - the primary row set
        builder - the builder (may be null)
        Returns:
        the document output object
        Throws:
        ObjectCreationException - if an error occurs during object construction or initialization e.g., if the extension is not loaded or the specified element id is not defined by the extension
        Since:
        PSAPI 12.0.1

Copyright © 2014 Integral Solutions Ltd. All Rights Reserved.