Package com.microstrategy.web.objects.admin.monitors

Interface Counter

  • All Known Implementing Classes:
    AbstractCounter
    public interface Counter
    This interface represents a Counter object.
    Since:
    MicroStrategy Web 7.5.0

    • Method Detail

      • getName

        java.lang.String getName()
        Returns the name of the counter.
        Returns:
        The name of the counter.

      • getLocalizedName

        java.lang.String getLocalizedName​(java.util.Locale locale)
        Returns the localized name of the counter
        Parameters:
        locale - Locale The locale to localize to.
        Returns:
        String The localized counter name.
        Since:
        MicroStrategy Web 8.0.0

      • getValue

        CounterData getValue()
        Returns a CounterData object containing the last data value collected for this counter. Note that the counter must be monitored in order for this to exist.
        Returns:
        A CounterData object containing the last data value collected.

      • getHelpMessage

        java.lang.String getHelpMessage()
        Returns the help message for the counter. This is an optional string containing additional information about the counter.
        Returns:
        The help message for the counter, if one exists.

      • getLocalizedHelpMessage

        java.lang.String getLocalizedHelpMessage​(java.util.Locale locale)
        Returns localized help message.
        Parameters:
        locale - Locale The locale to localize to.
        Returns:
        String The localized help message.
        Since:
        MicroStrategy Web 8.0.0

      • getOwnerInstance

        Instance getOwnerInstance()
        Returns the Instance to which this counter belongs to.
        Returns:
        The instance to which this counter belongs to.

      • getValues

        CounterDataList getValues()
        Returns a counter data list. The counter data list represents a snapshot of the data values history, at the time when this method is called. Thus, to get updated archived values, this method can be used periodically. The number of data values archived depends on the value of historySize set on the PerformanceMonitorManager using PerformanceMonitorManager.setHistorySize(int). Note that if the historySize is increased, each subsequent call to this method will return snapshots whose size (length of their data values archive) reflects incremental growth with each new data collection from IServer (happens at times fixed by PerformanceMonitorManager.setListRefresh(int) till the archive length equals the historySize set.
        Returns:
        CounterDataList the counter data list.

      • isLogged

        boolean isLogged()
        Conveys if logging is enabled for this counter.
        Returns:
        boolean True if logging is enabled for this counter.
        Since:
        MicroStrategy Web 9.0.0

      • isLoggedToStats

        boolean isLoggedToStats()
        Conveys if logging to Statistic is enabled for this counter.
        Returns:
        boolean True if logging to Statistic is enabled for this counter.
        Since:
        MicroStrategy Web 9.0.0