com.spss.psapi.core

Class ModelFieldRole



  • public class ModelFieldRole
    extends Enum
    This class enumerates the valid model output roles.
    Since:
    PSAPI 2.0
    Version:
    1.0
    Author:
    Julian Clinton
    • Field Detail

      • UNKNOWN

        public static final ModelFieldRole UNKNOWN
        Indicates that the role cannot be determined.
      • PREDICTED_VALUE

        public static final ModelFieldRole PREDICTED_VALUE
        Indicates a field containing the predicted value.
      • PREDICTED_DISPLAY_VALUE

        public static final ModelFieldRole PREDICTED_DISPLAY_VALUE
        Indicates a field containing a displayed-friendly representation of the predicted value.
      • PROBABILITY

        public static final ModelFieldRole PROBABILITY
        Indicates a field containing the probability of the target value.
      • RESIDUAL

        public static final ModelFieldRole RESIDUAL
        Indicates a field containing the residual of the predicted numeric value.
      • STANDARD_ERROR

        public static final ModelFieldRole STANDARD_ERROR
        Indicates a field containing the standard error of the predicted numeric value.
      • ENTITY_ID

        public static final ModelFieldRole ENTITY_ID
        Indicates a field containing the entity ID associated with the cluster, tree node, neuron or rule.
      • ENTITY_AFFINITY

        public static final ModelFieldRole ENTITY_AFFINITY
        Indicates a field containing the affinity or distance of the value from the entity.
      • UPPER_CONFIDENCE_LIMIT

        public static final ModelFieldRole UPPER_CONFIDENCE_LIMIT
        Indicates a field containing the upper confidence limit of a numeric prediction.
      • LOWER_CONFIDENCE_LIMIT

        public static final ModelFieldRole LOWER_CONFIDENCE_LIMIT
        Indicates a field containing the lower confidence limit of a numeric prediction.
      • PROPENSITY

        public static final ModelFieldRole PROPENSITY
        Indicates a field containing the propensity of the prediction.
      • VALUE

        public static final ModelFieldRole VALUE
        Indicates a field containing the model output value for non-predictive models.
      • SUPPLEMENTARY

        public static final ModelFieldRole SUPPLEMENTARY
        Indicates a field containing some additional information about the value that cannot be categorized into one of the other model field roles.
      • VARIANCE

        public static final ModelFieldRole VARIANCE
        Indicates a field containing the variance of the target value.
      • STANDARD_DEVIATION

        public static final ModelFieldRole STANDARD_DEVIATION
        Indicates a field containing the standard deviation of the target value.
      • SUPPORT

        public static final ModelFieldRole SUPPORT
        Indicates a field containing the support associated with an association model rule.
      • ADJUSTED_PROBABILITY

        public static final ModelFieldRole ADJUSTED_PROBABILITY
        Indicates a field containing the adjusted probability of the target value.
      • PRODICTED_SEQUENCE

        public static final ModelFieldRole PRODICTED_SEQUENCE
        Indicates a field containing the predicted sequence.
      • PRODICTED_SEQUENCE_PROBABILITY

        public static final ModelFieldRole PRODICTED_SEQUENCE_PROBABILITY
        Indicates a field containing the probability associated with the predicted sequence.
    • Method Detail

      • getEnum

        public static ModelFieldRole getEnum(java.lang.String name)
        Returns the enumeration with the supplied name or null if no enumeration exists for the supplied name.
        Parameters:
        name - the enumeration name
        Returns:
        the enumeration with the supplied name or null
      • getValues

        public static ModelFieldRole[] getValues()
        Returns an array containing all the valid values for this enumeration class.
        Returns:
        an array containing all the valid values for this enumeration class
      • isUnknown

        public boolean isUnknown()
        Returns true if this value is UNKNOWN.
        Overrides:
        isUnknown in class Enum
        Returns:
        true if this represents an unknown ModelOutputRole

Copyright © 2014 Integral Solutions Ltd. All Rights Reserved.