com.reportmill.base
Class RMGrouping

java.lang.Object
  com.reportmill.base.RMObject
      com.reportmill.base.RMGrouping

All Implemented Interfaces:

java.lang.Cloneable

public class RMGrouping
extends com.reportmill.base.RMObject

This object represents an individual grouping with attributes like key, sorts, topN sort, etc.

Constructor Summary

RMGrouping()
Creates an empty grouping.

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

Method Summary

void	addSort(RMSort anSO) Adds the given sort to the grouping.
void	addSort(java.lang.String aSortKey) Adds a sort to the grouping for the given sort key.
void	addSorts(java.util.List sos) Adds the list of sorts to the grouping.
java.lang.Object	clone() Standard clone implementation.
boolean	equals(java.lang.Object anObj) Standard equals implementation.
java.lang.Object	fromXML(com.reportmill.archiver.RXArchiver anArchiver, com.reportmill.archiver.RXElement anElement) XML unarchival.
boolean	getHasDetails() Returns whether the grouping has a details.
boolean	getHasHeader() Returns whether the grouping has a header.
boolean	getHasSummary() Returns whether the grouping has a summary.
boolean	getIncludeAllValues() Returns whether the grouping includes all values.
boolean	getIncludeValues() Returns whether to include values explicitly provided.
java.lang.String	getKey() Returns the grouping key.
RMSort	getSelectedSort() Returns the currently selected grouping's sort (while editing only).
int	getSelectedSortIndex() Returns the currently selected grouping's currently selected sort (for editing, mostly).
RMSort	getSort(int anIndex) Returns the individual sort at the given index.
int	getSortCount() Returns the number of sorts in the grouping.
boolean	getSortOnValues() Returns whether to sort on values explicitly provided.
java.util.List	getSorts() Returns the groupings list of sorts.
com.reportmill.base.RMTopNSort	getTopNSort() Returns the top N sort for the grouping.
java.util.List	getValues() Returns a list of explicit values for this grouping.
java.lang.String	getValuesString() Returns the values (in the form of comma separated keychain keys) explicitly defined to sort or to include.
void	moveSort(int sourceIndex, int destIndex) Moves a sort from the source index to the destination index.
void	removeSort(RMSort anSO) Removes the given sort from the grouping.
void	setHasDetails(boolean aValue) Sets whether the grouping has a details.
void	setHasHeader(boolean aValue) Sets whether the grouping has a header.
void	setHasSummary(boolean aValue) Sets whether the grouping has a summary.
void	setIncludeAllValues(boolean aValue) Sets whether the grouping includes all values.
void	setIncludeValues(boolean aFlag) Sets whether to include values explicitly provided.
void	setKey(java.lang.String aValue) Sets the grouping key.
void	setSelectedSortIndex(int anIndex) Sets the currently selected grouping's currently selected sort (for editing, mostly).
void	setSortOnValues(boolean aFlag) Sets whether to sort on values explicitly provided.
void	setTopNSort(com.reportmill.base.RMTopNSort aSort) Sets the top N sort for the grouping.
void	setValuesString(java.lang.String aString) Sets the values (in the form of comma separated keychain keys) explicitly defined to sort or to include.
java.lang.String	toString() Returns string representation of grouping.
com.reportmill.archiver.RXElement	toXML(com.reportmill.archiver.RXArchiver anArchiver) XML Archival.

Methods inherited from class com.reportmill.base.RMObject

copy, didChange, didUndo, getAnimAttribute, getClassNameShort, undoClone, undoCopy, undoEquals

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RMGrouping

public RMGrouping()

Creates an empty grouping.

RMGrouping

public RMGrouping(java.lang.String aKey)

Creates a grouping with the given key.

Method Detail

getKey

public java.lang.String getKey()

Returns the grouping key.

setKey

public void setKey(java.lang.String aValue)

Sets the grouping key.

getSorts

public java.util.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(java.lang.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(java.util.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 com.reportmill.base.RMTopNSort getTopNSort()

Returns the top N sort for the grouping.

setTopNSort

public void setTopNSort(com.reportmill.base.RMTopNSort aSort)

Sets the top N sort for the grouping.

getIncludeAllValues

public boolean getIncludeAllValues()

Returns whether the grouping includes all values.

setIncludeAllValues

public void setIncludeAllValues(boolean aValue)

Sets whether the grouping includes all values.

getValuesString

public java.lang.String getValuesString()

Returns the values (in the form of comma separated keychain keys) explicitly defined to sort or to include.

setValuesString

public void setValuesString(java.lang.String aString)

Sets the values (in the form of comma separated keychain keys) explicitly defined to sort or to include.

getValues

public java.util.List getValues()

Returns a list of explicit values for this grouping.

getSortOnValues

public boolean getSortOnValues()

Returns whether to sort on values explicitly provided.

setSortOnValues

public void setSortOnValues(boolean aFlag)

Sets whether to sort on values explicitly provided.

getIncludeValues

public boolean getIncludeValues()

Returns whether to include values explicitly provided.

setIncludeValues

public void setIncludeValues(boolean aFlag)

Sets whether to include values explicitly provided.

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.

getSelectedSortIndex

public int getSelectedSortIndex()

Returns the currently selected grouping's currently selected sort (for editing, mostly).

setSelectedSortIndex

public void setSelectedSortIndex(int anIndex)

Sets the currently selected grouping's currently selected sort (for editing, mostly).

getSelectedSort

public RMSort getSelectedSort()

Returns the currently selected grouping's sort (while editing only).

equals

public boolean equals(java.lang.Object anObj)

Standard equals implementation.

Overrides:

equals in class java.lang.Object

clone

public java.lang.Object clone()

Standard clone implementation.

Overrides:

clone in class com.reportmill.base.RMObject

toXML

public com.reportmill.archiver.RXElement toXML(com.reportmill.archiver.RXArchiver anArchiver)

XML Archival.

fromXML

public java.lang.Object fromXML(com.reportmill.archiver.RXArchiver anArchiver,
                                com.reportmill.archiver.RXElement anElement)

XML unarchival.

toString

public java.lang.String toString()

Returns string representation of grouping.

Overrides:

toString in class java.lang.Object