Package com.appliedolap.essbase

Record Class EssCubeView.GridPreferences

java.lang.Object
java.lang.Record
com.appliedolap.essbase.EssCubeView.GridPreferences
Record Components:
indentation - member row/column indentation style
suppressMissingRows - whether to suppress rows whose data cells are all #Missing
suppressZeroRows - whether to suppress rows whose data cells are all zero
suppressUnderscoreRows - whether to suppress rows whose member name starts with "_"
repeatMemberLabels - whether a member label repeats down every row of its group, or only appears once at the top of the group
zoomInPreference - the server's default zoom-in depth for a plain EssCubeView.zoomIn(int, int)
includeSelection - whether zooming in keeps the zoomed-on member alongside its new children, rather than replacing it with just the children
withinSelectedGroup - whether a zoom stays scoped to the selected group rather than applying to every member at that level
removeUnselectedGroup - whether zooming in removes sibling groups that weren't selected
Enclosing interface:
EssCubeView
public static record EssCubeView.GridPreferences(EssCubeView.Indentation indentation, boolean suppressMissingRows, boolean suppressZeroRows, boolean suppressUnderscoreRows, boolean repeatMemberLabels, EssCubeView.ZoomInPreference zoomInPreference, boolean includeSelection, boolean withinSelectedGroup, boolean removeUnselectedGroup) extends Record
Ad hoc display/navigation preferences, mirroring the classic "Essbase Options" dialog to the extent the REST wire format supports. These are stored server-side per login session (the wire resource is /preferences/grid, with no application/database/cube in its path) - they apply to every subsequent grid operation for this connection, not just this one view, and they persist until changed again or the session ends.

Verified live against a real server: indentation, zoomInPreference, and repeatMemberLabels each visibly change the next retrieve/zoom's output. suppressMissingRows, suppressZeroRows, suppressUnderscoreRows, includeSelection, withinSelectedGroup, and removeUnselectedGroup are wired through (the wire fields exist and accept the value) but not yet confirmed to have a visible effect - suppression in particular needs a grid with genuine missing/zero data cells to test against, not just member structure, and wasn't confirmed either way.

  • Constructor Details

    • GridPreferences

      public GridPreferences(EssCubeView.Indentation indentation, boolean suppressMissingRows, boolean suppressZeroRows, boolean suppressUnderscoreRows, boolean repeatMemberLabels, EssCubeView.ZoomInPreference zoomInPreference, boolean includeSelection, boolean withinSelectedGroup, boolean removeUnselectedGroup)
      Creates an instance of a GridPreferences record class.
      Parameters:
      indentation - the value for the indentation record component
      suppressMissingRows - the value for the suppressMissingRows record component
      suppressZeroRows - the value for the suppressZeroRows record component
      suppressUnderscoreRows - the value for the suppressUnderscoreRows record component
      repeatMemberLabels - the value for the repeatMemberLabels record component
      zoomInPreference - the value for the zoomInPreference record component
      includeSelection - the value for the includeSelection record component
      withinSelectedGroup - the value for the withinSelectedGroup record component
      removeUnselectedGroup - the value for the removeUnselectedGroup record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • indentation

      public EssCubeView.Indentation indentation()
      Returns the value of the indentation record component.
      Returns:
      the value of the indentation record component

    • suppressMissingRows

      public boolean suppressMissingRows()
      Returns the value of the suppressMissingRows record component.
      Returns:
      the value of the suppressMissingRows record component

    • suppressZeroRows

      public boolean suppressZeroRows()
      Returns the value of the suppressZeroRows record component.
      Returns:
      the value of the suppressZeroRows record component

    • suppressUnderscoreRows

      public boolean suppressUnderscoreRows()
      Returns the value of the suppressUnderscoreRows record component.
      Returns:
      the value of the suppressUnderscoreRows record component

    • repeatMemberLabels

      public boolean repeatMemberLabels()
      Returns the value of the repeatMemberLabels record component.
      Returns:
      the value of the repeatMemberLabels record component

    • zoomInPreference

      public EssCubeView.ZoomInPreference zoomInPreference()
      Returns the value of the zoomInPreference record component.
      Returns:
      the value of the zoomInPreference record component

    • includeSelection

      public boolean includeSelection()
      Returns the value of the includeSelection record component.
      Returns:
      the value of the includeSelection record component

    • withinSelectedGroup

      public boolean withinSelectedGroup()
      Returns the value of the withinSelectedGroup record component.
      Returns:
      the value of the withinSelectedGroup record component

    • removeUnselectedGroup

      public boolean removeUnselectedGroup()
      Returns the value of the removeUnselectedGroup record component.
      Returns:
      the value of the removeUnselectedGroup record component