public class RMGrouping extends RMObject
Constructor and Description |
---|
RMGrouping()
Creates an empty grouping.
|
RMGrouping(java.lang.String aKey)
Creates a grouping with the given key.
|
Modifier and Type | Method and Description |
---|---|
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(RXArchiver anArchiver,
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 |
getIncludeNulls()
Returns whether the grouping includes nulls.
|
java.lang.String |
getKey()
Returns the grouping key.
|
RMSort |
getSort(int anIndex)
Returns the individual sort at the given index.
|
int |
getSortCount()
Returns the number of sorts in the grouping.
|
java.util.List |
getSorts()
Returns the groupings list of sorts.
|
int |
getTopNCount()
Returns the top N count for the grouping.
|
boolean |
getTopNIncludeOthers()
Returns whether the top N sort for the grouping includes others.
|
RMSort |
getTopNSort()
Returns the top N sort for the grouping.
|
java.lang.Object |
initWithArchiver(RMArchiver anArchiver)
Legacy unarchival.
|
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 |
setIncludeNulls(boolean aValue)
Sets whether the grouping includes nulls.
|
void |
setKey(java.lang.String aValue)
Sets the grouping key.
|
void |
setTopNCount(int aValue)
Sets the top N count for the grouping.
|
void |
setTopNIncludeOthers(boolean aValue)
Sets whether the top N sort for the grouping includes others.
|
void |
setTopNSort(RMSort aSort)
Sets the top N sort for the grouping.
|
RXElement |
toXML(RXArchiver anArchiver)
XML Archival.
|
copy, didChange, didUndo, getAnimAttribute, getClassNameShort, undoClone, undoCopy, undoEquals
public RMGrouping()
public RMGrouping(java.lang.String aKey)
public java.lang.String getKey()
public void setKey(java.lang.String aValue)
public java.util.List getSorts()
public int getSortCount()
public RMSort getSort(int anIndex)
public void addSort(java.lang.String aSortKey)
public void addSort(RMSort anSO)
public void addSorts(java.util.List sos)
public void removeSort(RMSort anSO)
public void moveSort(int sourceIndex, int destIndex)
public RMSort getTopNSort()
public void setTopNSort(RMSort aSort)
public int getTopNCount()
public void setTopNCount(int aValue)
public boolean getTopNIncludeOthers()
public void setTopNIncludeOthers(boolean aValue)
public boolean getHasHeader()
public void setHasHeader(boolean aValue)
public boolean getHasDetails()
public void setHasDetails(boolean aValue)
public boolean getHasSummary()
public void setHasSummary(boolean aValue)
public boolean getIncludeAllValues()
public void setIncludeAllValues(boolean aValue)
public boolean getIncludeNulls()
public void setIncludeNulls(boolean aValue)
public boolean equals(java.lang.Object anObj)
equals
in class java.lang.Object
public java.lang.Object clone()
public RXElement toXML(RXArchiver anArchiver)
public java.lang.Object fromXML(RXArchiver anArchiver, RXElement anElement)
public java.lang.Object initWithArchiver(RMArchiver anArchiver)
initWithArchiver
in interface RMArchiver.Archiving
initWithArchiver
in class RMObject