Package io.keikai.model

Interface SPivotCache

All Known Implementing Classes:
PivotCacheImpl
public interface SPivotCache
Represents the data cache for a pivot table.
Since:
7.0.0

  • Method Details

    • getId

      String getId()
      Returns the unique identifier of this cache.
      Returns:
      the cache ID

    • getSourceRange

      CellRegion getSourceRange()
      Returns the source data range.
      Returns:
      the cell region of the source data

    • getSourceSheetName

      String getSourceSheetName()
      Returns the sheet name where the source data resides.
      Returns:
      the source sheet name

    • getFields

      List<SPivotCacheField> getFields()
      Returns all cache fields.
      Returns:
      list of cache fields

    • getField

      SPivotCacheField getField(int index)
      Returns the cache field at the specified index.
      Parameters:
      index - zero-based field index
      Returns:
      the cache field

    • getFieldCount

      int getFieldCount()
      Returns the number of fields.
      Returns:
      field count

    • getRecordCount

      int getRecordCount()
      Returns the number of data records in the cache.
      Returns:
      record count

    • refresh

      void refresh()
      Refreshes the cache by re-reading data from the source range.

      Until the pivot calculation engine is implemented this throws UnsupportedOperationException (fail-loud) rather than silently no-op'ing, so callers cannot mistake a stale cache for a refreshed one.

      Throws:
      UnsupportedOperationException - until the pivot engine lands