Package io.keikai.model

Interface SPivotCacheField

All Known Implementing Classes:
PivotCacheFieldImpl
public interface SPivotCacheField
Represents a field within a pivot cache (one column of source data).
Since:
7.0.0

  • Method Summary

    Modifier and Type
    Method
    Description
    SPivotFieldGrouping
    getGrouping()
    Returns the grouping configuration for this field, or null if ungrouped.
    int
    getIndex()
    Returns the zero-based index of this field in the cache.
    String
    getName()
    Returns the field name (typically the column header).
    List<Object>
    getSharedItems()
    Returns the unique (shared) values found in this field.
    boolean
    isDateField()
    Returns whether this field contains date data.
    boolean
    isNumericField()
    Returns whether this field contains numeric data.
    boolean
    isTextField()
    Returns whether this field contains text data.

  • Method Details

    • getName

      String getName()
      Returns the field name (typically the column header).
      Returns:
      the field name

    • getIndex

      int getIndex()
      Returns the zero-based index of this field in the cache.
      Returns:
      the field index

    • getSharedItems

      List<Object> getSharedItems()
      Returns the unique (shared) values found in this field.
      Returns:
      list of unique values

    • isNumericField

      boolean isNumericField()
      Returns whether this field contains numeric data.
      Returns:
      true if numeric

    • isDateField

      boolean isDateField()
      Returns whether this field contains date data.
      Returns:
      true if date

    • isTextField

      boolean isTextField()
      Returns whether this field contains text data.
      Returns:
      true if text

    • getGrouping

      SPivotFieldGrouping getGrouping()
      Returns the grouping configuration for this field, or null if ungrouped.
      Returns:
      the grouping, or null