public class

WebMetricHierarchicalSortConfigImpl

extends Object
implements WebMetricHierarchicalSortConfig WebMetricSortConfig WebSortConfig
java.lang.Object
   ↳ com.microstrategy.web.objects.WebMetricHierarchicalSortConfigImpl

Summary

Public Methods
void generateDelta(RWDelta delta)
int getAxis()
Returns the axis name configured
int getKey()
Returns the key of current sort object, which is used to look up the sort in the sorts collection.
WebMetric getMetric()
Returns the metric which is the target of the sort.
int getPosition()
Returns the position of current sort object in the sorts collection.
boolean getRespectParent()
Returns the Respect Parent flag
int getSortType()
Returns the sort type of this sort object.
String getSubtotalID()
Returns the subtotal ID set
int getSubtotalType()
Returns the subtotal type set.
int getSubtotalsPosition()
Returns the position of subtotals in sorted result.
WebObjectInfo getTarget()
Returns the target of this sort
boolean isAscending()
Returns the sort order, which is ascending or not.
void setAscending(boolean ascending)
Sets the sort order to ascending or not.
void setAxis(int axisName)
Sets the axis name
void setElements(String[] elementIDs)
void setMetric(WebMetric metric)
This method is used to set the metric which is the target of the sort.
void setRespectParent(boolean value)
Sets the Respect Parent flag
void setSubtotalByType(int subtotalType)
Sets the subtotal definition for the sort by specifying its subtotal type.
void setSubtotalID(String id)
Sets the subtotal ID
void setSubtotalsPosition(int subtotalsPosition)
Sets the position of subtotals in sorted result.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.microstrategy.web.objects.WebMetricHierarchicalSortConfig
From interface com.microstrategy.web.objects.WebMetricSortConfig
From interface com.microstrategy.web.objects.WebSort
From interface com.microstrategy.web.objects.WebSortConfig

Public Methods

public void generateDelta (RWDelta delta)

public int getAxis ()

Returns the axis name configured

public int getKey ()

Returns the key of current sort object, which is used to look up the sort in the sorts collection. This has nothing to do with the sort-key.

Returns
  • A key can be used to look up a sort in the sorts collection.

public WebMetric getMetric ()

Returns the metric which is the target of the sort.

Returns
  • The metric which is the target of the sort, or null if it has not been set.

public int getPosition ()

Returns the position of current sort object in the sorts collection.

Returns
  • The position (1-based) of current sort object in the sorts collection.

public boolean getRespectParent ()

Returns the Respect Parent flag

public int getSortType ()

Returns the sort type of this sort object. The sort type only can be specified on creation time.

Returns

public String getSubtotalID ()

Returns the subtotal ID set

public int getSubtotalType ()

Returns the subtotal type set.

public int getSubtotalsPosition ()

Returns the position of subtotals in sorted result. The possible value are in EnumDSSXMLSubtotalsPosition. Default is EnumDSSXMLSubtotalsPosition.DssSubtotalsPositionInherit

Returns

public WebObjectInfo getTarget ()

Returns the target of this sort

public boolean isAscending ()

Returns the sort order, which is ascending or not.

Returns
  • True if the result will be sorted in ascending order; else false. Default value is true.

public void setAscending (boolean ascending)

Sets the sort order to ascending or not.

Parameters
ascending True to sort in ascending order, false to descending order.

public void setAxis (int axisName)

Sets the axis name

public void setElements (String[] elementIDs)

public void setMetric (WebMetric metric)

This method is used to set the metric which is the target of the sort.

Parameters
metric The metric object which will be the target of the sort.
Throws
IllegalArgumentException

public void setRespectParent (boolean value)

Sets the Respect Parent flag

Parameters
value value

public void setSubtotalByType (int subtotalType)

Sets the subtotal definition for the sort by specifying its subtotal type.

Throws
IllegalArgumentException

public void setSubtotalID (String id)

Sets the subtotal ID

public void setSubtotalsPosition (int subtotalsPosition)

Sets the position of subtotals in sorted result. The possible value are in EnumDSSXMLSubtotalsPosition. Default is EnumDSSXMLSubtotalsPosition.DssSubtotalsPositionInherit.

Parameters
subtotalsPosition The position of subtotals in sorted result, values from EnumDSSXMLSubtotalsPosition.