com.spss.psapi.data

Interface ModelOutputMetadata



  • public interface ModelOutputMetadata
    This defines the metadata associated with a Column generated by a model.
    Since:
    PSAPI 2.0
    Version:
    1.0
    Author:
    Julian Clinton, Rob Duncan
    See Also:
    Column, DataModel, DataModelFactory
    Specification Status:
    Under Development
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String ADJUSTED
      Used by binary classifiers as the tag value indicating that the column indicates adjusted propensity.
      static java.lang.String RAW
      Used by binary classifiers as the tag value indicating that the column indicates raw propensity.
      static java.lang.String X
      Used by Kohonen models as the tag value indicating the X component of the cluster id.
      static java.lang.String Y
      Used by Kohonen models as the tag value indicating the Y component of the cluster id.
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      ModelFieldRole getRole()
      Returns the model output column role for the column if it is a model output column or null.
      java.lang.String getTag()
      Returns the tag associated with this model output column or null if the column is not a model output column or the tag has not been defined.
      java.lang.String getTargetColumn()
      Returns the target column name associated with this model output column or null if the column is not a model output column or the target column has not been defined.
      java.lang.Object getValue()
      Returns the value associated with this model output column or null if the column is not a model output column or no value has been defined.
    • Field Detail

      • X

        static final java.lang.String X
        Used by Kohonen models as the tag value indicating the X component of the cluster id.
        Since:
        PSAPI 12.0
        See Also:
        getTag(), Constant Field Values
      • Y

        static final java.lang.String Y
        Used by Kohonen models as the tag value indicating the Y component of the cluster id.
        Since:
        PSAPI 12.0
        See Also:
        getTag(), Constant Field Values
      • RAW

        static final java.lang.String RAW
        Used by binary classifiers as the tag value indicating that the column indicates raw propensity.
        Since:
        PSAPI 12.0
        See Also:
        getTag(), Constant Field Values
      • ADJUSTED

        static final java.lang.String ADJUSTED
        Used by binary classifiers as the tag value indicating that the column indicates adjusted propensity.
        Since:
        PSAPI 12.0
        See Also:
        getTag(), Constant Field Values
    • Method Detail

      • getRole

        ModelFieldRole getRole()
        Returns the model output column role for the column if it is a model output column or null.
        Returns:
        the modeling role or null
      • getTargetColumn

        java.lang.String getTargetColumn()
        Returns the target column name associated with this model output column or null if the column is not a model output column or the target column has not been defined.
        Returns:
        the target column name or null
      • getValue

        java.lang.Object getValue()
        Returns the value associated with this model output column or null if the column is not a model output column or no value has been defined. The value is typically used in combination with the target column e.g. when a model can generate probabilities for each value specified by the target field.
        Returns:
        the value or null
        Since:
        PSAPI 12.0
        See Also:
        getTargetColumn()
      • getTag

        java.lang.String getTag()
        Returns the tag associated with this model output column or null if the column is not a model output column or the tag has not been defined.
        Returns:
        the tag or null

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