Interface SPivotFieldGrouping

All Known Implementing Classes:
PivotFieldGroupingImpl

public interface SPivotFieldGrouping
Represents grouping settings for a pivot cache field.
Since:
7.0.0
  • Method Summary

    Modifier and Type
    Method
    Description
    double
    Returns the end value for numeric grouping.
    double
    Returns the interval for numeric grouping.
    double
    Returns the start value for numeric grouping.
    boolean
    Returns whether this is a date-based grouping.
    boolean
    Returns whether grouping by days is enabled.
    boolean
    Returns whether grouping by hours is enabled.
    boolean
    Returns whether grouping by minutes is enabled.
    boolean
    Returns whether grouping by months is enabled.
    boolean
    Returns whether grouping by quarters is enabled.
    boolean
    Returns whether grouping by seconds is enabled.
    boolean
    Returns whether grouping by years is enabled.
    boolean
    Returns whether this is a numeric-range grouping.
  • Method Details

    • isDateGrouping

      boolean isDateGrouping()
      Returns whether this is a date-based grouping.
      Returns:
      true if date grouping
    • isNumericGrouping

      boolean isNumericGrouping()
      Returns whether this is a numeric-range grouping.
      Returns:
      true if numeric grouping
    • getStartNum

      double getStartNum()
      Returns the start value for numeric grouping.
      Returns:
      the start number
    • getEndNum

      double getEndNum()
      Returns the end value for numeric grouping.
      Returns:
      the end number
    • getGroupInterval

      double getGroupInterval()
      Returns the interval for numeric grouping.
      Returns:
      the group interval
    • isGroupByYears

      boolean isGroupByYears()
      Returns whether grouping by years is enabled.
      Returns:
      true if grouping by years
    • isGroupByQuarters

      boolean isGroupByQuarters()
      Returns whether grouping by quarters is enabled.
      Returns:
      true if grouping by quarters
    • isGroupByMonths

      boolean isGroupByMonths()
      Returns whether grouping by months is enabled.
      Returns:
      true if grouping by months
    • isGroupByDays

      boolean isGroupByDays()
      Returns whether grouping by days is enabled.
      Returns:
      true if grouping by days
    • isGroupByHours

      boolean isGroupByHours()
      Returns whether grouping by hours is enabled.
      Returns:
      true if grouping by hours
    • isGroupByMinutes

      boolean isGroupByMinutes()
      Returns whether grouping by minutes is enabled.
      Returns:
      true if grouping by minutes
    • isGroupBySeconds

      boolean isGroupBySeconds()
      Returns whether grouping by seconds is enabled.
      Returns:
      true if grouping by seconds