Class actuate.xtabanalyzer.Sorter
Description
Defines a sort condition used to sort on a dimension level or measure.
Constructor
Syntax
actuate.xtabanalyzer.Sorter(string levelName)
Constructs a new sorter object.
Function summary
Table 45‑18 lists actuate.xtabanalyzer.Sorter functions.
Table 45‑18 actuate.xtabanalyzer.Sorter functions
Function
Description
getKey( )
Returns the sort key
Returns the level name
Returns the sort member
Returns the sort direction
Sets ascending or descending sort
setKey( )
Sets the sort key
Sets the level name
Sets the sort member
getKey
Syntax
string Sorter.getKey( )
Returns the sort key. This is the name of the measure or dimension level to sort the cross tab on.
Returns
String. The key to sort on.
Example
This example retrieves the sort key:
function getSortKey(sorter){
if (sorter){
return sorter.getKey( );
}
return null;
}
getLevelName
Syntax
string Sorter.getLevelName( )
Returns dimension level to sort on.
Returns
String. The name of a dimension level.
Example
This example retrieves the level name associated with the sorter:
function getSortLevel(sorter){
if (sorter){
return sorter.getLevelName( );
}
return null;
}
getMember
Syntax
actuate.xtabanalyzer.MemberValue Sorter.getMember( )
Returns the member value to sort on.
Returns
actuate.xtabanalyzer.MemberValue object. A member value.
Example
This example retrieves the sort member:
function getSortMember(sorter){
if (sorter){
return sorter.getMember( );
}
return null;
}
isAscending
Syntax
boolean Sorter.isAscending( )
Returns the sort order.
Returns
Boolean. True when the sorter is ascending and false in all other cases.
Example
This example retrieves the level name that is associated with the sorter:
function ascending(sorter){
if (sorter){
return sorter.isAscending( );
}
return null;
}
setAscending
Syntax
void Sorter.setAscending(boolean ascending)
Sets the sort order to ascending or descending.
Parameter
ascending
Boolean. Set to true for ascending, set to false for descending.
Example
This example swaps the sort direction:
sorter.setAscending(!(sorter.isAscending));
setKey
Syntax
void Sorter.setSortKey(string sortKey)
Sets the key to sort on.
Parameter
sortKey
String. The sort key.
Example
This example sets the sort key:
function setSortKey(sorter,key){
sorter.setKey(key);
}
setLevelName
Syntax
void Sorter.setLevelName(string levelName)
Sets the dimension level name to sort on.
Parameter
levelName
String. A dimension level name.
Example
This example sets the level name to sort:
function setSortLevel(sorter,level){
sorter.setLevelName(level);
}
setMember
Syntax
void Sorter.setMember(actuate.xtabanalyzer.MemberValue member)
Sets the member value to sort on.
Parameter
member
actuate.xtabanalyzer.MemberValue object. A member value.
Example
This example sets the sort member:
function setSortMember(sorter,member){
sorter.setMember(member);
}