com.prosyst.mprm.admin.statistics

Interface Statistic

public interface Statistic

This interface represents a statistic for whole mPRM or is scoped to a particular host/set of hosts. A statistic is related to a specific variable quantity. It supports one or more statistic reports (views) for that quantity, e.g. average, min, max.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AVERAGE Current value merge type - returns average of all values.
static java.lang.String	COUNT Current value merge type - sums all values.
static java.lang.String	MAX Current value merge type - returns maximum of all values.
static java.lang.String	MIN Current value merge type - returns minimum of all values.

Method Summary

Modifier and Type	Method and Description
void	delete(java.lang.String sourceTypeFilter, java.lang.String sourceNameFilter) Deleted (if the statistics supports it) the information for matching sources.
java.lang.Number	getCurrentValue(Source... source) Returns the current value of the quantity.
java.lang.Number	getCurrentValue(java.lang.String sourceTypeFilter, java.lang.String sourceNameFilter) Returns the current value of the quantity.
java.lang.String	getGroup() Returns the group of this statistic.
java.lang.String	getMergeType() Return the value merge type merging current type value or period infos of multiple hosts.
java.lang.String	getName() Returns the name of this statistic.
java.lang.String[]	getReportTypes() Returns the report types this statistic supports.
StatisticReport	getStatisticReport(java.lang.String reportType, Source... source) Returns a statistic report representing the combination of all the statistics with this name and type from all the hosts with host ids related with this statistic.
StatisticReport	getStatisticReport(java.lang.String reportType, java.lang.String sourceTypeFilter, java.lang.String sourceNameFilter) Returns a statistic report representing the combination of all the statistics with this name and type from all the hosts with host ids related with this statistic.
boolean	hasCurrentValueSupport() Return the if current value is supported.
boolean	hasInfoFromSource(java.lang.String sourceTypeFilter, java.lang.String sourceNameFilter) Tests if there is info for source matching the filter.
Enumerator<Source,ManagementException>	listSources(java.lang.String sourceTypeFilter, java.lang.String sourceNameFilter) List all available sources of this statistic.

Field Detail

COUNT

static final java.lang.String COUNT

Current value merge type - sums all values.

See Also:

Constant Field Values

MIN

static final java.lang.String MIN

Current value merge type - returns minimum of all values.

See Also:

Constant Field Values

MAX

static final java.lang.String MAX

Current value merge type - returns maximum of all values.

See Also:

Constant Field Values

AVERAGE

static final java.lang.String AVERAGE

Current value merge type - returns average of all values.

See Also:

Constant Field Values

Method Detail

getGroup

java.lang.String getGroup()

Returns the group of this statistic.

Returns:

the group of the statistic

getName

java.lang.String getName()

Returns the name of this statistic.

Returns:

the name of the statistic

getReportTypes

java.lang.String[] getReportTypes()
                           throws ManagementException

Returns the report types this statistic supports.

Returns:

the names of reports supported by the statistic

Throws:

ManagementException

getMergeType

java.lang.String getMergeType()
                       throws ManagementException

Return the value merge type merging current type value or period infos of multiple hosts.

Returns:

merge type that refers registered MergeProvider.

Throws:

ManagementException

hasCurrentValueSupport

boolean hasCurrentValueSupport()
                        throws ManagementException

Return the if current value is supported.

Returns:

if current value is supported. If false the calls to #getCurrentValue() shall throw UnsupportedOperationException.

Throws:

ManagementException

listSources

Enumerator<Source,ManagementException> listSources(java.lang.String sourceTypeFilter,
                                                   java.lang.String sourceNameFilter)
                                            throws ManagementException

List all available sources of this statistic.

Parameters:

sourceTypeFilter - optional wild card filter for the source type. Assumed "*" if null

sourceNameFilter - optional wild card filter for the source name. Assumed "*" if null

Returns:

null if this statistic do not support source, empty enumerator if the statistic has no sources and non-empty enumerator in other cases

Throws:

ManagementException

hasInfoFromSource

boolean hasInfoFromSource(java.lang.String sourceTypeFilter,
                          java.lang.String sourceNameFilter)
                   throws ManagementException

Tests if there is info for source matching the filter.

Parameters:

sourceTypeFilter - optional wild card filter for the source type. Assumed "*" if null

sourceNameFilter - optional wild card filter for the source name. Assumed "*" if null

Returns:

null if this statistic has information for source matching the filter

Throws:

ManagementException

getStatisticReport

StatisticReport getStatisticReport(java.lang.String reportType,
                                   Source... source)
                            throws ManagementException

Returns a statistic report representing the combination of all the statistics with this name and type from all the hosts with host ids related with this statistic. (For example if the statistics represent count, the combination statistic w ill be the sum of all counts obtained from the statistics on different hosts).

Parameters:

reportType - the name of the report the statistic is queried

source - source(s) of the requested statistic. It shall be null or empty array if the statistic do not support sources.

Returns:

statistic report for the source (if one source) or statistic report value (if more then one source)

Throws:

ManagementException

getStatisticReport

StatisticReport getStatisticReport(java.lang.String reportType,
                                   java.lang.String sourceTypeFilter,
                                   java.lang.String sourceNameFilter)
                            throws ManagementException

Returns a statistic report representing the combination of all the statistics with this name and type from all the hosts with host ids related with this statistic. (For example if the statistics represent count, the combination statistic w ill be the sum of all counts obtained from the statistics on different hosts).

Note that the mPRM could decide that the matching sources are too many and could reject the query!

Parameters:

reportType - the name of the report the statistic is queried

sourceTypeFilter - optional wild card filter for the source type. Assumed "*" if null

sourceNameFilter - optional wild card filter for the source name. Assumed "*" if null

Returns:

combined statistic report

Throws:

ManagementException

getCurrentValue

java.lang.Number getCurrentValue(Source... source)
                          throws ManagementException

Returns the current value of the quantity. If the current value is not supported this method shall throw an exception.

Parameters:

source - source(s) of the statistic. It must be null iff the statistic do not support sources.

Returns:

current value of the source (if one) or combined current value (if more then one).

Throws:

ManagementException

getCurrentValue

java.lang.Number getCurrentValue(java.lang.String sourceTypeFilter,
                                 java.lang.String sourceNameFilter)
                          throws ManagementException

Returns the current value of the quantity. If the current value is not supported this method shall throw an exception.

Parameters:

sourceTypeFilter - optional wild card filter for the source type. Assumed "*" if null

sourceNameFilter - optional wild card filter for the source name. Assumed "*" if null

Returns:

current value of the source (if one) or combined current value (if more then one).

Throws:

ManagementException

delete

void delete(java.lang.String sourceTypeFilter,
            java.lang.String sourceNameFilter)
     throws ManagementException

Deleted (if the statistics supports it) the information for matching sources.

Parameters:

sourceTypeFilter -

sourceNameFilter -

Throws:

ManagementException