public interface

WebRankMetric

com.microstrategy.web.objects.WebRankMetric

Class Overview

The WebRankMetric interface represents a rank metric object.

Summary

Public Methods
abstract WebObjectInfo getBreakByUnit()
Returns the unit over which the rank will be performed.
abstract WebMetric getMetric()
Returns the WebMetric object whose values should be ranked.
abstract boolean isAscending()
Returns whether the ranking is ascending(true) or descending(false).
abstract boolean isDynamic()
Returns whether the ranking should be dynamic (values of the metric change when report is pivoted) or static (values of the metric are moved, but not changed when is pivoted).
abstract void setAscending(boolean ascending)
Sets whether the ranking should be ascending or descending.
abstract void setBreakByUnit(WebObjectInfo object)
Sets the unit over which the rank will be performed.
abstract void setDynamic(boolean dynamic)
Sets whether the ranking should be dynamic or static.

Public Methods

public abstract WebObjectInfo getBreakByUnit ()

Returns the unit over which the rank will be performed. This translates into the "break-by" level of the ranking metric. Default value is null.

Returns
  • The WebObjectInfo object which has the break by unit information.

public abstract WebMetric getMetric ()

Returns the WebMetric object whose values should be ranked.

Returns
  • The WebMetric object whose values should be ranked.

public abstract boolean isAscending ()

Returns whether the ranking is ascending(true) or descending(false). Default value is true.

Returns
  • Whether the ranking is ascending or descending.

public abstract boolean isDynamic ()

Returns whether the ranking should be dynamic (values of the metric change when report is pivoted) or static (values of the metric are moved, but not changed when is pivoted).

Returns
  • Whether the ranking should be dynamic or static.

public abstract void setAscending (boolean ascending)

Sets whether the ranking should be ascending or descending.

Parameters
ascending This should be true if the ranking should be ascending, false otherwise

public abstract void setBreakByUnit (WebObjectInfo object)

Sets the unit over which the rank will be performed.

Parameters
object The WebObjectInfo object that contains the information about the break by unit. It has to be contained in the template.
Throws
IllegalArgumentException Thrown if the WebObjectInfo object does not exist in the template.
See Also

public abstract void setDynamic (boolean dynamic)

Sets whether the ranking should be dynamic or static.

Parameters
dynamic This should be true if the ranking should be dynamic, false otherwise.