Package com.reportmill.base

Class RMGrouping

java.lang.Object
com.reportmill.base.RMObject
com.reportmill.base.RMGrouping
All Implemented Interfaces:
RMArchiver.Archiving, Cloneable
public class RMGrouping extends RMObject
This object represents an individual grouping with attributes like key, sorts, topN sort, etc.

  • Constructor Details

    • RMGrouping

      public RMGrouping()
      Creates an empty grouping.

    • RMGrouping

      public RMGrouping(String aKey)
      Creates a grouping with the given key.

  • Method Details

    • getKey

      public String getKey()
      Returns the grouping key.

    • setKey

      public void setKey(String aValue)
      Sets the grouping key.

    • getSorts

      public List getSorts()
      Returns the groupings list of sorts.

    • getSortCount

      public int getSortCount()
      Returns the number of sorts in the grouping.

    • getSort

      public RMSort getSort(int anIndex)
      Returns the individual sort at the given index.

    • addSort

      public void addSort(String aSortKey)
      Adds a sort to the grouping for the given sort key.

    • addSort

      public void addSort(RMSort anSO)
      Adds the given sort to the grouping.

    • addSorts

      public void addSorts(List sos)
      Adds the list of sorts to the grouping.

    • removeSort

      public void removeSort(RMSort anSO)
      Removes the given sort from the grouping.

    • moveSort

      public void moveSort(int sourceIndex, int destIndex)
      Moves a sort from the source index to the destination index.

    • getTopNSort

      public RMSort getTopNSort()
      Returns the top N sort for the grouping.

    • setTopNSort

      public void setTopNSort(RMSort aSort)
      Sets the top N sort for the grouping.

    • getTopNCount

      public int getTopNCount()
      Returns the top N count for the grouping.

    • setTopNCount

      public void setTopNCount(int aValue)
      Sets the top N count for the grouping.

    • getTopNIncludeOthers

      public boolean getTopNIncludeOthers()
      Returns whether the top N sort for the grouping includes others.

    • setTopNIncludeOthers

      public void setTopNIncludeOthers(boolean aValue)
      Sets whether the top N sort for the grouping includes others.

    • getHasHeader

      public boolean getHasHeader()
      Returns whether the grouping has a header.

    • setHasHeader

      public void setHasHeader(boolean aValue)
      Sets whether the grouping has a header.

    • getHasDetails

      public boolean getHasDetails()
      Returns whether the grouping has a details.

    • setHasDetails

      public void setHasDetails(boolean aValue)
      Sets whether the grouping has a details.

    • getHasSummary

      public boolean getHasSummary()
      Returns whether the grouping has a summary.

    • setHasSummary

      public void setHasSummary(boolean aValue)
      Sets whether the grouping has a summary.

    • getIncludeAllValues

      public boolean getIncludeAllValues()
      Returns whether the grouping includes all values.

    • setIncludeAllValues

      public void setIncludeAllValues(boolean aValue)
      Sets whether the grouping includes all values.

    • getIncludeNulls

      public boolean getIncludeNulls()
      Returns whether the grouping includes nulls.

    • setIncludeNulls

      public void setIncludeNulls(boolean aValue)
      Sets whether the grouping includes nulls.

    • equals

      public boolean equals(Object anObj)
      Standard equals implementation.
      Overrides:
      equals in class Object

    • clone

      public Object clone()
      Standard clone implementation.
      Overrides:
      clone in class RMObject

    • toXML

      public RXElement toXML(RXArchiver anArchiver)
      XML Archival.

    • fromXML

      public Object fromXML(RXArchiver anArchiver, RXElement anElement)
      XML unarchival.

    • initWithArchiver

      public Object initWithArchiver(RMArchiver anArchiver)
      Legacy unarchival.
      Specified by:
      initWithArchiver in interface RMArchiver.Archiving
      Overrides:
      initWithArchiver in class RMObject