Package com.reportmill.base

Class RMGrouper

java.lang.Object
com.reportmill.base.RMObject
com.reportmill.base.RMGrouper
All Implemented Interfaces:
RMArchiver.Archiving, Cloneable
public class RMGrouper extends RMObject
This class simply manages a list of groupings and has some nice convenience methods.

  • Constructor Details

    • RMGrouper

      public RMGrouper()
      Creates an empty grouper.

  • Method Details

    • getGroupingCount

      public int getGroupingCount()
      Returns the number of groupings in this grouper.

    • size

      public int size()
      Returns the number of groupings in this grouper.

    • getGrouping

      public RMGrouping getGrouping(int anIndex)
      Returns the grouping at the given index.

    • getGrouping

      public RMGrouping getGrouping(String aKey)
      Returns the grouping with the given key.

    • getGroupingLast

      public RMGrouping getGroupingLast()
      Returns the last grouping.

    • getGroupingKey

      public String getGroupingKey(int anIndex)
      Return the key for the grouping at the given index.

    • indexOf

      public int indexOf(String aKey)
      Returns the index for the grouping with the given key.

    • addGrouping

      public void addGrouping(RMGrouping aGrouping, int anIndex)
      Adds a given grouping to grouper's list of groupings.

    • addGroupings

      public void addGroupings(List aList)
      Adds a given list of groupings to grouper's list of groupings.

    • addGroupingForKey

      public RMGrouping addGroupingForKey(String aKey)
      Adds a new grouping with the given key.

    • addGroupingForKey

      public RMGrouping addGroupingForKey(String aKey, int anIndex)
      Adds a new grouping with the given key at the given index.

    • removeGrouping

      public void removeGrouping(int anIndex)
      Removes the grouping at the given index.

    • removeGrouping

      public void removeGrouping(RMGrouping aGrouping)
      Removes the given grouping.

    • removeGroupingForKey

      public void removeGroupingForKey(String aKey)
      Removes the grouping with the given key.

    • moveGrouping

      public void moveGrouping(int fromIndex, int toIndex)
      Moves a grouping from given fromIndex to given toIndex.

    • getGroupingKeys

      public List getGroupingKeys()
      Returns a list of keys for the current groupings.

    • groupObjects

      public RMGroup groupObjects(List aList)
      Separates given objects into RMGroups defined by groupings.

    • clone

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

    • copy

      public void copy(Object anObj)
      Copies attributes of given object.
      Overrides:
      copy in class RMObject

    • equals

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

    • 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