Package com.microstrategy.web.objects

Interface WebRankMetric

  • public interface WebRankMetric
    The WebRankMetric interface represents a rank metric object.
    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      WebObjectInfo getBreakByUnit()
      Returns the unit over which the rank will be performed.
      WebMetric getMetric()
      Returns the WebMetric object whose values should be ranked.
      boolean isAscending()
      Returns whether the ranking is ascending(true) or descending(false).
      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).
      void setAscending​(boolean ascending)
      Sets whether the ranking should be ascending or descending.
      void setBreakByUnit​(WebObjectInfo object)
      Sets the unit over which the rank will be performed.
      void setDynamic​(boolean dynamic)
      Sets whether the ranking should be dynamic or static.

    • Method Detail

      • getMetric

        WebMetric getMetric()
        Returns the WebMetric object whose values should be ranked.
        Returns:
        The WebMetric object whose values should be ranked.

      • isAscending

        boolean isAscending()
        Returns whether the ranking is ascending(true) or descending(false). Default value is true.
        Returns:
        Whether the ranking is ascending or descending.

      • setAscending

        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

      • setBreakByUnit

        void setBreakByUnit​(WebObjectInfo object)
             throws java.lang.IllegalArgumentException
        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:
        java.lang.IllegalArgumentException - Thrown if the WebObjectInfo object does not exist in the template.
        See Also:
        getBreakByUnit()

      • isDynamic

        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.

      • setDynamic

        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.