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 5-18 lists actuate.xtabanalyzer.Sorter functions. Table 5-18 actuate.xtabanalyzer.Sorter functions Function Description getKey( ) Returns the sort key getLevelName( ) Returns the level name getMember( ) Returns the sort member isAscending( ) Returns the sort direction setAscending( ) Sets ascending or descending sort setKey( ) Sets the sort key setLevelName( ) Sets the level name setMember( ) Sets the sort member actuate.xtabanalyzer.Sorter.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; } actuate.xtabanalyzer.Sorter.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; } actuate.xtabanalyzer.Sorter.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; } actuate.xtabanalyzer.Sorter.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; } actuate.xtabanalyzer.Sorter.setAscending Syntax void Sorter.setAscending(boolean ascending) Sets the sort order to ascending or descending. Parameters ascending Boolean. Set to true for ascending, set to false for descending. Example This example swaps the sort direction: sorter.setAscending(!(sorter.isAscending)); actuate.xtabanalyzer.Sorter.setKey Syntax void Sorter.setSortKey(string sortKey) Sets the key to sort on. Parameters sortKey String. The sort key. Example This example sets the sort key: function setSortKey(sorter,key){ sorter.setKey(key); } actuate.xtabanalyzer.Sorter.setLevelName Syntax void Sorter.setLevelName(string levelName) Sets the dimension level name to sort on. Parameters levelName String. A dimension level name. Example This example sets the level name to sort: function setSortLevel(sorter,level){ sorter.setLevelName(level); } actuate.xtabanalyzer.Sorter.setMember Syntax void Sorter.setMember(actuate.xtabanalyzer.MemberValue member) Sets the member value to sort on. Parameters member actuate.xtabanalyzer.MemberValue object. A member value. Example This example sets the sort member: function setSortMember(sorter,member){ sorter.setMember(member); }