Classes


Class actuate.xtabanalyzer.Sorter

The Sorter class is used to specify a sort on dimension level/measure.
Member of: actuate.xtabanalyzer.

Class Summary
Constructor Attributes Constructor Name and Description
 
actuate.xtabanalyzer.Sorter(levelName, key, ascending, (MemberValue))
The Sorter class is used to specify a sort on dimension level/measure.
Method Summary
Method Attributes Method Name and Description
 
Returns the key to sort on.
 
Returns the dimension level name to sort on.
 
Returns the member value to sort on.
 
Returns whether the sorting condition is ascending.
 
setAscending(ascending)
Sets whether the sorting must be ascending.
 
setKey(key)
Sets the key to sort on.
 
setLevelName(levelName)
Sets the dimension level name to sort on.
 
setMember(member)
Sets the member value to sort on.
Class Detail
actuate.xtabanalyzer.Sorter(levelName, key, ascending, (MemberValue))
The Sorter class is used to specify a sort on dimension level/measure.
Parameters:
{String} levelName
Dimension level full name
{String} key
key expression to sort on
{boolean} ascending
true for ascending, false for descending
(MemberValue)
member Sorter member object
Method Detail
{String} getKey()
Returns the key to sort on.
Returns:
{String} key to sort on

{String} getLevelName()
Returns the dimension level name to sort on.
Returns:
{String} level name to sort on

{MemberValue} getMember()
Returns the member value to sort on.
Returns:
{MemberValue} member value to sort on
See:
actuate.xtabanalyzer.MemberValue

{boolean} isAscending()
Returns whether the sorting condition is ascending.
Returns:
{boolean} true for ascending, false for descending

{void} setAscending(ascending)
Sets whether the sorting must be ascending.
Parameters:
{boolean} ascending
true for ascending, false for descending
Returns:
{void}

{void} setKey(key)
Sets the key to sort on.
Parameters:
{String} key
Key to sort on
Returns:
{void}

{void} setLevelName(levelName)
Sets the dimension level name to sort on.
Parameters:
{String} levelName
Level name to sort on
Returns:
{void}

{void} setMember(member)
Sets the member value to sort on.
Parameters:
{MemberValue} member
MemberValue to sort on
Returns:
{void}
See:
actuate.xtabanalyzer.MemberValue

Documentation generated by JsDoc Toolkit 2.0.1 on Tue Jan 29 2013 05:44:22 GMT-0800 (PST)