|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface ITopNSort
This interface defines a group summary sort. The name of this interface 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".
| Method Summary | |
|---|---|
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. |
void |
setConditionFormulas(TopNConditionFormulas formulas)
Sets the condition formulas that override the sort values for the default Top N sort order. |
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. |
| Methods inherited from interface com.crystaldecisions.sdk.occa.report.data.ISort |
|---|
addInteractiveControlObjectName, getDirection, getInteractiveControlObjectIndex, getInteractiveControlObjectNames, getSortField, isInteractive, setDirection, setInteractiveControlObjectNames, setSortField |
| Method Detail |
|---|
boolean getDiscardOthers()
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.
true if records that are not part of the Top N are discarded, and false
otherwise.int getNIndividualGroups()
Returns the number of groups that should be in the Top N.
int that specifies the number of groups that should be in the Top N.double getPercentageValue()
java.lang.String getNotInTopBottomName()
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.
String containing the name used to group records that are not a part of the
Top N group.void setDiscardOthers(boolean discardOthers)
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.
discardOthers - true if records that are not part of the Top N are discarded, and
false otherwise.void setNIndividualGroups(int nIndividualGroups)
Sets the number of groups that should be in the Top N.
nIndividualGroups - An int that specifies the number of groups that should be in the Top N.void setPercentageValue(double percentageValue)
void setNotInTopBottomName(java.lang.String notInTopBottomName)
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.
notInTopBottomName - A String containing the name used to group records that are
not a part of the Top N group.TopNConditionFormulas getConditionFormulas()
Returns the conditional formulas that override the sort values for the default Top N sort order.
TopNConditionFormulas object containing the condition formulas
that override the sort values for the default Top N sort order.void setConditionFormulas(TopNConditionFormulas formulas)
Sets the condition formulas that override the sort values for the default Top N sort order.
formulas - A TopNConditionFormulas object containing the condition formulas
that override the sort values for the default Top N sort order.boolean getWithTies()
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.
true if ties are included when sorting top or bottom groups, and false
otherwise.void setWithTies(boolean withTies)
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.
withTies - true if ties are included when sorting top or bottom groups, and
false otherwise.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||