com.spss.psapi.data

Class ModelingRole



  • public final class ModelingRole
    extends Enum
    This class enumerates the valid modeling roles for columns in a DataModel.
    Since:
    PSAPI 1.0
    Version:
    1.0
    Author:
    Julian Clinton, Rob Duncan
    See Also:
    DataModel
    Specification Status:
    Under Development
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static ModelingRole BOTH
      Indicates that this column can be either an antecendent or a consequent.
      static ModelingRole FREQ_WEIGHT
      Indicates that this column is used to be as frequency weight but won't be showed for user
      static ModelingRole IN
      Indicates that this column is a predictor or an antecendent.
      static ModelingRole NONE
      Indicates that this column is not used directly during modeling.
      static ModelingRole OUT
      Indicates that this column is predicted or a consequent.
      static ModelingRole PARTITION
      Indicates that this column is used to indentify the data partition.
      static ModelingRole RECORD_ID
      Indicates that this column is used to indentify the record id.
      static ModelingRole SPLIT
      Indicates that this column is used to split the data.
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      static ModelingRole getEnum(java.lang.String name)
      Returns the enumeration with the supplied name or null if no enumeration exists for the supplied name.
      static ModelingRole[] getValues()
      Returns an array containing all the valid values for this enumeration class.
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Field Detail

      • IN

        public static final ModelingRole IN
        Indicates that this column is a predictor or an antecendent.
      • OUT

        public static final ModelingRole OUT
        Indicates that this column is predicted or a consequent.
      • BOTH

        public static final ModelingRole BOTH
        Indicates that this column can be either an antecendent or a consequent.
      • NONE

        public static final ModelingRole NONE
        Indicates that this column is not used directly during modeling.
      • PARTITION

        public static final ModelingRole PARTITION
        Indicates that this column is used to indentify the data partition.
      • SPLIT

        public static final ModelingRole SPLIT
        Indicates that this column is used to split the data.
      • FREQ_WEIGHT

        public static final ModelingRole FREQ_WEIGHT
        Indicates that this column is used to be as frequency weight but won't be showed for user
      • RECORD_ID

        public static final ModelingRole RECORD_ID
        Indicates that this column is used to indentify the record id.
    • Method Detail

      • getEnum

        public static ModelingRole 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 ModelingRole[] 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

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