|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.crystaldecisions.sdk.occa.report.data.Sort
com.crystaldecisions.sdk.occa.report.data.TopNSort
public class TopNSort
This object implements a group summary sort. The name of this object is a misnomer, because it applies to both "Top N" summary sorts in which only the top or bottom N groups are displayed, as well as "All ascending/descending" summary sorts, in which all groups are displayed in ascending or descending order.
If a group contains a summary, it is possible for the group to be Top N sorted. This sorts the groups according to the group summary that was inserted. Data is grouped according to the group name for the first N groups. The groups that are not included in the Top N are either discarded or grouped under a specified name, such as "Others".
When possible, use the ITopNSort interface to manipulate this object.
| Constructor Summary | |
|---|---|
TopNSort()
|
|
TopNSort(ITopNSort src)
|
|
| Method Summary | |
|---|---|
java.lang.Object |
clone(boolean deepClone)
|
void |
copyTo(java.lang.Object destObject,
boolean deepCopy)
|
void |
copyTo(java.lang.Object destObject,
boolean deepCopy,
AncestorLink sortAncestor)
|
java.lang.Object |
createMember(java.lang.String eleName,
org.xml.sax.Attributes attrs,
XMLSerializationContext ctxt,
java.util.Map objState,
boolean[] bLoaded)
For internal use only. |
void |
endElement(java.lang.String eleName,
java.util.Map objState)
For internal use only. |
TopNConditionFormulas |
getConditionFormulas()
Returns the conditional formulas that override the sort values for the default Top N sort order. |
boolean |
getDiscardOthers()
Returns what should be done with records that do not fall into the Top N group. |
int |
getNIndividualGroups()
Returns the number of groups that should be in the Top N. |
java.lang.String |
getNotInTopBottomName()
Returns the name used to group records that are not a part of the Top N group. |
double |
getPercentageValue()
For internal use only |
boolean |
getWithTies()
Returns whether ties are included when sorting top or bottom groups. |
boolean |
hasContent(java.lang.Object srcTopNSort)
|
boolean |
hasContent(java.lang.Object srcTopNSort,
boolean bCheckIControlObjName)
For internal use only |
void |
readElement(java.lang.String eleName,
java.lang.String sVal,
org.xml.sax.Attributes attrs,
java.util.Map objState)
For internal use only. |
void |
save(XMLWriter writer,
java.lang.String sTag,
XMLSerializationContext ctxt)
For internal use only. |
void |
save(XMLWriter writer,
XMLSerializationContext ctxt)
For internal use only. |
void |
saveContents(XMLWriter writer,
XMLSerializationContext ctxt)
For internal use only. |
void |
setConditionFormulas(TopNConditionFormulas formulas)
Sets the condition formulas that override the sort values for the default Top N sort order. |
void |
setDirection(SortDirection direction)
Sets the direction in which the data is sorted. |
void |
setDiscardOthers(boolean discardOthers)
Sets what should be done with records that do not fall into the Top N group. |
void |
setNIndividualGroups(int nIndividualGroups)
Sets the number of groups that should be in the Top N. |
void |
setNotInTopBottomName(java.lang.String notInTopBottomName)
Sets the name used to group records that are not a part of the Top N group. |
void |
setPercentageValue(double percentageValue)
For internal use only |
void |
setWithTies(boolean withTies)
Sets whether ties are included when sorting top or bottom groups. |
void |
startElement(java.lang.String eleName,
java.util.Map objState,
org.xml.sax.Attributes attrs)
For internal use only. |
| Methods inherited from class com.crystaldecisions.sdk.occa.report.data.Sort |
|---|
addInteractiveControlObjectName, getDirection, getInteractiveControlObjectIndex, getInteractiveControlObjectNames, getSortField, isInteractive, setInteractiveControlObjectNames, setSortField |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface com.crystaldecisions.sdk.occa.report.data.ISort |
|---|
addInteractiveControlObjectName, getDirection, getInteractiveControlObjectIndex, getInteractiveControlObjectNames, getSortField, isInteractive, setInteractiveControlObjectNames, setSortField |
| Constructor Detail |
|---|
public TopNSort(ITopNSort src)
public TopNSort()
| Method Detail |
|---|
public java.lang.Object clone(boolean deepClone)
clone in class Sort
public void copyTo(java.lang.Object destObject,
boolean deepCopy)
copyTo in class Sort
public void copyTo(java.lang.Object destObject,
boolean deepCopy,
AncestorLink sortAncestor)
copyTo in class Sort
public java.lang.Object createMember(java.lang.String eleName,
org.xml.sax.Attributes attrs,
XMLSerializationContext ctxt,
java.util.Map objState,
boolean[] bLoaded)
SortFor internal use only.
createMember in class Sort
public void endElement(java.lang.String eleName,
java.util.Map objState)
SortFor internal use only.
endElement in class Sortpublic boolean getDiscardOthers()
ITopNSort
Returns what should be done with records that do not fall into the Top N group.
If this value is true, records that are not a part of the Top N are discarded. If this
is false, the records that are not in the Top N are grouped under the name specified in
setNotInTopBottomName method.
getDiscardOthers in interface ITopNSorttrue if records that are not part of the Top N are discarded, and false
otherwise.public int getNIndividualGroups()
ITopNSortReturns the number of groups that should be in the Top N.
getNIndividualGroups in interface ITopNSortint that specifies the number of groups that should be in the Top N.public double getPercentageValue()
ITopNSort
getPercentageValue in interface ITopNSortpublic java.lang.String getNotInTopBottomName()
ITopNSort
Returns the name used to group records that are not a part of the Top N group.
This property is used only when the ITopNSort.getDiscardOthers() method returns false.
getNotInTopBottomName in interface ITopNSortString containing the name used to group records that are not a part of the
Top N group.public boolean hasContent(java.lang.Object srcTopNSort)
hasContent in class Sort
public boolean hasContent(java.lang.Object srcTopNSort,
boolean bCheckIControlObjName)
hasContent in class Sort
public void readElement(java.lang.String eleName,
java.lang.String sVal,
org.xml.sax.Attributes attrs,
java.util.Map objState)
SortFor internal use only.
readElement in class Sort
public void save(XMLWriter writer,
XMLSerializationContext ctxt)
throws java.io.IOException
SortFor internal use only.
save in class Sortjava.io.IOException
public void save(XMLWriter writer,
java.lang.String sTag,
XMLSerializationContext ctxt)
throws java.io.IOException
SortFor internal use only.
save in class Sortjava.io.IOException
public void saveContents(XMLWriter writer,
XMLSerializationContext ctxt)
throws java.io.IOException
SortFor internal use only.
saveContents in class Sortjava.io.IOExceptionpublic void setDiscardOthers(boolean discardOthers)
ITopNSort
Sets what should be done with records that do not fall into the Top N group.
If this value is true, records that are not a part of the Top N are discarded. If this
is false, the records that are not in the Top N are grouped under the name specified in
setNotInTopBottomName method.
setDiscardOthers in interface ITopNSortdiscardOthers - true if records that are not part of the Top N are discarded, and
false otherwise.public void setNIndividualGroups(int nIndividualGroups)
ITopNSortSets the number of groups that should be in the Top N.
setNIndividualGroups in interface ITopNSortnIndividualGroups - An int that specifies the number of groups that should be in the Top N.public void setPercentageValue(double percentageValue)
ITopNSort
setPercentageValue in interface ITopNSortpublic void setNotInTopBottomName(java.lang.String notInTopBottomName)
ITopNSort
Sets the name used to group records that are not a part of the Top N group.
This property is used only when the ITopNSort.getDiscardOthers() method returns false.
setNotInTopBottomName in interface ITopNSortnotInTopBottomName - A String containing the name used to group records that are
not a part of the Top N group.
public void startElement(java.lang.String eleName,
java.util.Map objState,
org.xml.sax.Attributes attrs)
SortFor internal use only.
startElement in class Sortpublic TopNConditionFormulas getConditionFormulas()
ITopNSortReturns the conditional formulas that override the sort values for the default Top N sort order.
getConditionFormulas in interface ITopNSortTopNConditionFormulas object containing the condition formulas
that override the sort values for the default Top N sort order.public void setConditionFormulas(TopNConditionFormulas formulas)
ITopNSortSets the condition formulas that override the sort values for the default Top N sort order.
setConditionFormulas in interface ITopNSortformulas - A TopNConditionFormulas object containing the condition formulas
that override the sort values for the default Top N sort order.public boolean getWithTies()
ITopNSort
Returns whether ties are included when sorting top or bottom groups.
If this value is true, groups whose summarized values are equal will be accommodated.
getWithTies in interface ITopNSorttrue if ties are included when sorting top or bottom groups, and false
otherwise.public void setWithTies(boolean withTies)
ITopNSort
Sets whether ties are included when sorting top or bottom groups.
If this value is true, groups whose summarized values are equal will be accommodated.
setWithTies in interface ITopNSortwithTies - true if ties are included when sorting top or bottom groups, and
false otherwise.public void setDirection(SortDirection direction)
ISortSets the direction in which the data is sorted.
setDirection in interface ISortsetDirection in class Sortdirection - A SortDirection object that specifies the direction in which that data is
sorted.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||