com.spss.psapi.model

Interface ModelDetail

  • All Known Subinterfaces:
    CompositeModelDetail, ModelContainer


    public interface ModelDetail
    This interface encapsulates the representation detail of a data mining model.
    Since:
    PSAPI 1.0
    Version:
    1.0
    Author:
    Julian Clinton
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      java.lang.String getAlgorithmName()
      Returns the name of the model builder algorithm.
      java.lang.String getApplicationName()
      Returns the name of the model builder application.
      java.lang.String getApplicationVersion()
      Returns the version of the model builder application.
      java.util.Date getBuildDate()
      Returns the date this model was built.
      java.lang.String getCopyright()
      Returns the model copyright.
      DataModel getInputDataModel()
      Returns the input data model required by the model.
      java.lang.String getModelID()
      Returns the model ID.
      ModelType getModelType()
      Returns the type of the model.
      DataModel getOutputDataModel()
      Returns the output data model produced by the model.
      PMMLModelType getPMMLModelType()
      For a model which is represented internally using PMML (one for which isPMMLModel() returns true), this returns the PMML model type from the underlying PMML that was generated by the modeling algorithm.
      java.lang.String getPMMLText()
      For a model which is represented internally using PMML (one for which isPMMLModel() returns true), this returns a string representing the PMML generated from the model building algorithm.
      java.util.List<java.lang.String> getSplitColumnNames()
      Returns the list of split column names if this is a split model or null for non-split models.
      int getSplitModelCount()
      Returns the number of split models if this is a split model or 0 otherwise.
      java.util.List<java.lang.Object> getSplitModelKey(int index)
      Returns the values of the split fields at the specified index for split models or null for non-split models.
      java.lang.String getSplitModelPMMLText(int index)
      Returns the PMML representation of the split model at the specified index for split models or null for non-split models or if the split model is not represented as PMML.
      java.lang.String getUserName()
      Returns the name of the account used to build the model.
      boolean isOutputColumnAuxiliary(java.lang.String name)
      Returns true if the supplied column name is an auxiliary column in the output data model or false.
      boolean isPMMLModel()
      Returns true if this model is represented internally using PMML, false otherwise.
      boolean isSplitModel()
      Returns true if this model is a split model, false otherwise.
    • Method Detail

      • getApplicationName

        java.lang.String getApplicationName()
        Returns the name of the model builder application.
        Returns:
        the name of the model builder application
      • getApplicationVersion

        java.lang.String getApplicationVersion()
        Returns the version of the model builder application.
        Returns:
        the version of the model builder application
      • getAlgorithmName

        java.lang.String getAlgorithmName()
        Returns the name of the model builder algorithm.
        Returns:
        the name of the model builder algorithm
      • getCopyright

        java.lang.String getCopyright()
        Returns the model copyright.
        Returns:
        the name of the model copyright
      • getUserName

        java.lang.String getUserName()
        Returns the name of the account used to build the model.
        Returns:
        the name of the account used to build the model
      • getBuildDate

        java.util.Date getBuildDate()
        Returns the date this model was built.
        Returns:
        the date this model was built
      • getInputDataModel

        DataModel getInputDataModel()
        Returns the input data model required by the model. Note that the ModelingRole for each field in the input data model is ModelingRole.IN, even for fields that had been specified as ModelingRole.BOTH for association or sequence models.
        Returns:
        the input data model required by the model
        See Also:
        DataModel
      • getOutputDataModel

        DataModel getOutputDataModel()
        Returns the output data model produced by the model. Note that the ModelingRole for each field in the output data model is ModelingRole.OUT, even for fields that had been specified as ModelingRole.BOTH for association or sequence models.

        It is also important to note that this is not same as the output column set produced by the ModelApplier that applies the model to data. The transformer output column set will usually include additional fields from the input and may include property settings that modify the number or type of outputs produced (for example, a transformer that applies a clustering model may produce the cluster ID as an integer or a string depending on the property settings).

        Returns:
        the output data model produced by the model
        See Also:
        DataModel, ModelApplier
      • isOutputColumnAuxiliary

        boolean isOutputColumnAuxiliary(java.lang.String name)
        Returns true if the supplied column name is an auxiliary column in the output data model or false. An auxiliary output column is a column that provides additional information about the output of the model e.g., the confidence of the prediction or distance from the cluster center.
        Parameters:
        name - the column name
        Returns:
        true if the supplied column name is an auxiliary column
      • getModelType

        ModelType getModelType()
        Returns the type of the model.
        Returns:
        the model type
      • getPMMLModelType

        PMMLModelType getPMMLModelType()
        For a model which is represented internally using PMML (one for which isPMMLModel() returns true), this returns the PMML model type from the underlying PMML that was generated by the modeling algorithm. For a model which is not represented using PMML this returns null.
        Returns:
        the PMML model type
        Since:
        PSAPI 15.0.0.1
      • isPMMLModel

        boolean isPMMLModel()
        Returns true if this model is represented internally using PMML, false otherwise.
        Returns:
        true if this model is represented using PMML
        Since:
        PSAPI 16.0
        See Also:
        getPMMLText()
      • getModelID

        java.lang.String getModelID()
        Returns the model ID. For models within a composite model, it is assumed that each model has a unique ID.
        Returns:
        the model ID
      • isSplitModel

        boolean isSplitModel()
        Returns true if this model is a split model, false otherwise.
        Returns:
        true if this model is a split model
        Since:
        PSAPI 16.0 FP2
      • getSplitModelCount

        int getSplitModelCount()
        Returns the number of split models if this is a split model or 0 otherwise.
        Returns:
        the number of split models
        Since:
        PSAPI 17.0
        See Also:
        isSplitModel()
      • getSplitColumnNames

        java.util.List<java.lang.String> getSplitColumnNames()
        Returns the list of split column names if this is a split model or null for non-split models.
        Returns:
        the split column names or null
        Since:
        PSAPI 17.0
        See Also:
        isSplitModel(), getSplitModelKey(int)
      • getSplitModelPMMLText

        java.lang.String getSplitModelPMMLText(int index)
        Returns the PMML representation of the split model at the specified index for split models or null for non-split models or if the split model is not represented as PMML.
        Parameters:
        index - the model index
        Returns:
        a representation of the split model or null
        Since:
        PSAPI 17.0
        See Also:
        isSplitModel(), getSplitModelKey(int)
      • getSplitModelKey

        java.util.List<java.lang.Object> getSplitModelKey(int index)
        Returns the values of the split fields at the specified index for split models or null for non-split models. When present, the values are in the order specified by the split output columns.
        Parameters:
        index - the model index
        Returns:
        a representation of the split model or null
        Since:
        PSAPI 17.0
        See Also:
        isSplitModel(), getSplitColumnNames(), getSplitModelPMMLText(int)

Copyright © 2014 Integral Solutions Ltd. All Rights Reserved.