com.spss.psapi.data

Interface Column



  • public interface Column
    This defines the properties of a set of columns. Applications that wish to construct Column instances must do so using the DataModelFactory rather than implementing the interface directly.
    Since:
    PSAPI 2.0
    Version:
    1.0
    Author:
    Julian Clinton, Rob Duncan
    See Also:
    DataModel, DataModelFactory
    Specification Status:
    Under Development
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      java.lang.String getColumnLabel()
      Returns the label of the column or an empty string if there is no label associated with the column.
      java.lang.String getColumnName()
      Returns the name of the column.
      ExtendedMeasure getExtendedMeasure()
      Returns additional metadata that is specific for this field's measurement.
      ExtendedStorage getExtendedStorage()
      Returns additional metadata for this field's storage or null if no additional storage metadata is defined.
      java.lang.Object getFalseFlag()
      Returns the "false" indicator value for the column, or null if either the value is not known or the column is not a flag.
      java.lang.Object getLowerBound()
      Returns the lower bound value for the values in the column, or null if either the value is not known or the column is not continuous.
      MeasureType getMeasureType()
      Returns the measure type for the column.
      MissingValueDefinition getMissingValueDefinition()
      Returns the missing value definition for the column or null.
      ModelingRole getModelingRole()
      Returns the modeling role for the column.
      ModelOutputMetadata getModelOutputMetadata()
      Returns the model output column role for the column if it is a model output column or null
      java.lang.Object[] getSetValues()
      Returns an array of valid values for the column, or null if either the values are not known or the column is not a set.
      StorageType getStorageType()
      Returns the storage type for the column.
      java.lang.Object getTrueFlag()
      Returns the "true" indicator value for the column, or null if either the value is not known or the column is not a flag.
      java.lang.Object getUpperBound()
      Returns the upper bound value for the values in the column, or null if either the value is not known or the column is not continuous.
      java.lang.String getValueLabel(java.lang.Object value)
      Returns the label for the value in the column or an empty string if there is no label associated with the value.
      boolean hasMissingValueDefinition()
      Returns true if the column has a missing value definition.
      boolean isList()
      Returns true if this field is a list field.
      boolean isMeasureContinuous()
      Returns true if the column is continuous.
      boolean isMeasureDiscrete()
      Returns true if the column is discrete.
      boolean isModelOutputColumn()
      Returns true if this is a model output column.
      boolean isStorageDatetime()
      Returns true if the column's storage is a time, date or timestamp value.
      boolean isStorageNumeric()
      Returns true if the column's storage is an integer or a real number.
      boolean isValidValue(java.lang.Object value)
      Returns true if the specified value is valid for this storage and valid when the valid column values are known.
    • Method Detail

      • getColumnName

        java.lang.String getColumnName()
        Returns the name of the column.
        Returns:
        the column name
      • getStorageType

        StorageType getStorageType()
        Returns the storage type for the column.
        Returns:
        the storage type
      • getMeasureType

        MeasureType getMeasureType()
        Returns the measure type for the column.
        Returns:
        the measure type
      • isList

        boolean isList()
        Returns true if this field is a list field.
        Returns:
        true if this field is a list field, false otherwise.
        Since:
        PSAPI 17.0
        See Also:
        getExtendedStorage(), getExtendedMeasure()
      • getExtendedStorage

        ExtendedStorage getExtendedStorage()
        Returns additional metadata for this field's storage or null if no additional storage metadata is defined.
        Returns:
        the extended measure metadata for named column or null
        Since:
        PSAPI 17.0
        See Also:
        isList(), getExtendedMeasure()
      • getExtendedMeasure

        ExtendedMeasure getExtendedMeasure()
        Returns additional metadata that is specific for this field's measurement. For example, geospatial fields may return a geospatial-specific descriptor that defines the metadata necessary for the correct interpretation of the values. Returns null if no additional metadata is defined.
        Returns:
        the extended measure metadata for named column or null
        Since:
        PSAPI 17.0
        See Also:
        isList(), getExtendedStorage()
      • getModelingRole

        ModelingRole getModelingRole()
        Returns the modeling role for the column.
        Returns:
        the modeling role
      • isMeasureDiscrete

        boolean isMeasureDiscrete()
        Returns true if the column is discrete. Columns that are either a set or a flag are considered discrete.
        Returns:
        true if the column is either a set or a flag type, false otherwise.
      • isMeasureContinuous

        boolean isMeasureContinuous()
        Returns true if the column is continuous.
        Returns:
        true if the column is continuous, false otherwise.
      • isStorageNumeric

        boolean isStorageNumeric()
        Returns true if the column's storage is an integer or a real number.
        Returns:
        true if the column's storage is an integer or a real number, false otherwise.
      • isStorageDatetime

        boolean isStorageDatetime()
        Returns true if the column's storage is a time, date or timestamp value.
        Returns:
        true if the column's storage is a time, date or timestamp value, false otherwise.
      • getLowerBound

        java.lang.Object getLowerBound()
        Returns the lower bound value for the values in the column, or null if either the value is not known or the column is not continuous.
        Returns:
        the lower bound value for the column or null
      • getUpperBound

        java.lang.Object getUpperBound()
        Returns the upper bound value for the values in the column, or null if either the value is not known or the column is not continuous.
        Returns:
        the upper bound value for the column or null
      • getSetValues

        java.lang.Object[] getSetValues()
        Returns an array of valid values for the column, or null if either the values are not known or the column is not a set.
        Returns:
        an array of valid values for column or null
      • getTrueFlag

        java.lang.Object getTrueFlag()
        Returns the "true" indicator value for the column, or null if either the value is not known or the column is not a flag.
        Returns:
        the true value for column or null
      • getFalseFlag

        java.lang.Object getFalseFlag()
        Returns the "false" indicator value for the column, or null if either the value is not known or the column is not a flag.
        Returns:
        the true value for column or null
      • isValidValue

        boolean isValidValue(java.lang.Object value)
        Returns true if the specified value is valid for this storage and valid when the valid column values are known.
        Parameters:
        value - the value
        Returns:
        true if the specified value is valid for this storage and valid when the valid column values are known
      • hasMissingValueDefinition

        boolean hasMissingValueDefinition()
        Returns true if the column has a missing value definition.
        Returns:
        true if the column has missing value definition
      • getMissingValueDefinition

        MissingValueDefinition getMissingValueDefinition()
        Returns the missing value definition for the column or null.
        Returns:
        the missing value definition for the column or null
      • getColumnLabel

        java.lang.String getColumnLabel()
        Returns the label of the column or an empty string if there is no label associated with the column.
        Returns:
        the label for the value in the column or an empty string
      • getValueLabel

        java.lang.String getValueLabel(java.lang.Object value)
        Returns the label for the value in the column or an empty string if there is no label associated with the value.
        Parameters:
        value - the value
        Returns:
        the label for the value in the column or an empty string
      • isModelOutputColumn

        boolean isModelOutputColumn()
        Returns true if this is a model output column.
        Returns:
        true if this is a model output column
      • getModelOutputMetadata

        ModelOutputMetadata getModelOutputMetadata()
        Returns the model output column role for the column if it is a model output column or null
        Returns:
        the modeling role or null

Copyright © 2014 Integral Solutions Ltd. All Rights Reserved.