com.spss.psapi.core

Interface ContentContainerFactory

  • All Known Subinterfaces:
    SessionObjectFactory


    public interface ContentContainerFactory
    Creates instances of ContentContainer.
    Since:
    PSAPI 12.0.1
    Version:
    1.0
    Author:
    Robert Duncan
    See Also:
    ContentContainer
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      ContentContainer createContainer(java.lang.String containerTypeId, java.lang.String name, java.lang.Object content)
      Returns a new container with the supplied name and content.
      DocumentContainer createDocumentContainer(java.lang.String containerTypeId, java.lang.String name, java.lang.Object content)
      Returns a new document container with the supplied name and content.
      ContentContainer createEmptyContainer(java.lang.String containerTypeId, java.lang.String name)
      Returns a new empty container with the supplied name.
      ModelContainer createModelContainer(java.lang.String containerTypeId, java.lang.String name, java.lang.Object content, Column[] inputFields, Column[] modelOutputFields, ModelType modelType)
      Returns a new model container with the supplied name and content.
      ModelContainer createModelContainer(java.lang.String containerTypeId, java.lang.String name, java.lang.Object content, Column[] inputFields, Column[] modelOutputFields, ModelType modelType, java.util.List<java.lang.String> splitFieldNames)
      Returns a new model container with the supplied name and content.
      RowSetContainer createRowSetContainer(java.lang.String containerTypeId, java.lang.String name, java.lang.Object content)
      Returns a new row set container with the supplied name and content.
    • Method Detail

      • createDocumentContainer

        DocumentContainer createDocumentContainer(java.lang.String containerTypeId,
                                                java.lang.String name,
                                                java.lang.Object content)
        Returns a new document container with the supplied name and content.
        Parameters:
        containerTypeId - the id of the container type
        name - the document name
        content - the document content as either a byte array or a string
        Returns:
        a new document container
        Throws:
        java.lang.IllegalArgumentException - if the content is not a byte array or a string
      • createModelContainer

        ModelContainer createModelContainer(java.lang.String containerTypeId,
                                          java.lang.String name,
                                          java.lang.Object content,
                                          Column[] inputFields,
                                          Column[] modelOutputFields,
                                          ModelType modelType)
        Returns a new model container with the supplied name and content.
        Parameters:
        containerTypeId - the id of the container type
        name - the model name
        content - the model content as either a byte array or a string
        inputFields - the input fields
        modelOutputFields - the mode output fields i.e. columns that include model output metadata
        modelType - the type of the constructed model
        Returns:
        a new model container
        Throws:
        java.lang.IllegalArgumentException - if the content is not a byte array or a string
      • createModelContainer

        ModelContainer createModelContainer(java.lang.String containerTypeId,
                                          java.lang.String name,
                                          java.lang.Object content,
                                          Column[] inputFields,
                                          Column[] modelOutputFields,
                                          ModelType modelType,
                                          java.util.List<java.lang.String> splitFieldNames)
        Returns a new model container with the supplied name and content.
        Parameters:
        containerTypeId - the id of the container type
        name - the model name
        content - the model content as either a byte array or a string
        inputFields - the input fields
        modelOutputFields - the mode output fields i.e. columns that include model output metadata
        modelType - the type of the constructed model
        splitFieldNames - the names of the fields used for splitting, or null if no splitting used
        Returns:
        a new model container
        Throws:
        java.lang.IllegalArgumentException - if the content is not a byte array or a string
      • createRowSetContainer

        RowSetContainer createRowSetContainer(java.lang.String containerTypeId,
                                            java.lang.String name,
                                            java.lang.Object content)
        Returns a new row set container with the supplied name and content.
        Parameters:
        containerTypeId - the id of the container type
        name - the row set name
        content - the row set content as either a byte array or a string
        Returns:
        a new row set container
        Throws:
        java.lang.IllegalArgumentException - if the content is not a byte array or a string
      • createEmptyContainer

        ContentContainer createEmptyContainer(java.lang.String containerTypeId,
                                            java.lang.String name)
        Returns a new empty container with the supplied name.
        Parameters:
        containerTypeId - the id of the container type
        name - the container name
        Returns:
        a new empty container
        Since:
        PSAPI 17.0
      • createContainer

        ContentContainer createContainer(java.lang.String containerTypeId,
                                       java.lang.String name,
                                       java.lang.Object content)
        Returns a new container with the supplied name and content.
        Parameters:
        containerTypeId - the id of the container type
        name - the container name
        content - either a byte array or a string
        Returns:
        a new container with the specified content
        Throws:
        java.lang.IllegalArgumentException - if the content is not a byte array or a string
        Since:
        PSAPI 17.0

Copyright © 2014 Integral Solutions Ltd. All Rights Reserved.