com.spss.psapi.data

Interface ColumnGroup



  • public interface ColumnGroup
    This defines the properties of a column group. A column group is typically used to identify related columns e.g. that represent a multi response set.
    Since:
    PSAPI 12.0
    Version:
    1.0
    Author:
    Julian Clinton
    See Also:
    Column, DataModel
    Specification Status:
    Under Development
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      java.lang.String getColumnGroupLabel()
      Returns the label of the column group or an empty string if there is no label associated with the column group.
      java.lang.String getColumnGroupName()
      Returns the name of the column group.
      ColumnGroupType getColumnGroupType()
      Returns the type of column group.
      java.util.List getColumnNames()
      Returns the list of column names in this group.
      java.lang.String getCountedValue()
      Returns the counted value for this column group.
    • Method Detail

      • getColumnGroupName

        java.lang.String getColumnGroupName()
        Returns the name of the column group.
        Returns:
        the column group name
      • getColumnGroupLabel

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

        ColumnGroupType getColumnGroupType()
        Returns the type of column group.
        Returns:
        the type of column group
      • getCountedValue

        java.lang.String getCountedValue()
        Returns the counted value for this column group. The counted value only has meaning for multi dichotomy sets and represents the "true" or "selected" value of the column. Note that the value is represented as a string even if the columns named by the column group have storage other than string and it is the responsibility of the calling application to convert the string representation into a valid value.
        Returns:
        the counted value for this column group
      • getColumnNames

        java.util.List getColumnNames()
        Returns the list of column names in this group. The list is a copy of the list in the group and can be modified without affecting the group definition.
        Returns:
        the list of column names in this group

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