com.prosyst.mprm.backend.statistics.spi

Interface StatisticProvider

All Known Subinterfaces:

PeriodicalStatisticProvider

All Known Implementing Classes:

BasicPeriodicStatisticProvider, BasicStatisticProvider

public interface StatisticProvider

Statistic provider provides measurements for a given variable/quantity. It is registered into OSGi service registry. It specifies its id - group and name, as well as the database its statistics will be stored

Field Summary

Fields

Modifier and Type	Field and Description
static int[][]	DEFAULT_PRECISION_INFO

Method Summary

Modifier and Type	Method and Description
java.lang.Number	getCurrentValue(Source source) Exported as current report if supported.
java.lang.String	getDB() Returns the DB name that shall be used for storing the information for values of this statistic.
java.lang.String	getGroup() Returns statistic group.
java.lang.String	getMergeType() Returns a ReportProvider name that could be used for merging current values on more then one hosts.
java.lang.String	getName() Returns statistic name.
int[][]	getPrecisionInfo() In order to save memory/disk the statistic provider keeps the statistics records in samples (period infos) with different precisions.
java.lang.String[]	getReportTypes() Return the handler for report support.
java.lang.String[]	getSummaryNames() Returns names of predefined (summary) statistic values.
boolean	hasCurrentValueSupport() Return the if current value is supported.
void	setUp(Context context) Sets up the provider.

Field Detail

DEFAULT_PRECISION_INFO

static final int[][] DEFAULT_PRECISION_INFO

Method Detail

getGroup

java.lang.String getGroup()

Returns statistic group.

Returns:

statistic group.

getName

java.lang.String getName()

Returns statistic name.

Returns:

statistic name.

getReportTypes

java.lang.String[] getReportTypes()

Return the handler for report support. For instance average, max, min.

Returns:

supported reports.

hasCurrentValueSupport

boolean hasCurrentValueSupport()

Return the if current value is supported.

Returns:

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

Throws:

ManagementException

getPrecisionInfo

int[][] getPrecisionInfo()

In order to save memory/disk the statistic provider keeps the statistics records in samples (period infos) with different precisions. The precisions are minute/hour/day/month/year based. The statistic provider shall specify how many samples it want to use for every precisions (precision simple count) and how many units of the corresponded precision will be long a sample (precision factor).

This method returns the precisions info requested by the statistics provider. If null the default one for the statistics subsystem is used.

The returned array has 5 elements. Every element is int[] with 2 elements: [0] - precision sample count, [1] - precision factor.
The five elements stands for:

[0] - minutes: sample count must be 0 or >= 60, factor must be in 30, 20, 15, 10, 6, 5, 3, 2, 1
[1] - hours: sample count must be 0 (only if minutes are 0) or >= 24, factor must be in 12, 8, 6, 4, 3, 2, 1
[2] - days: sample count must be0( only if hours are 0) or >= 31 or < 31 (only if months are 0), factor must be 1
[3] - months: sample count must be0(only if days are 0) or >= 12 or < 12 (only if years are 0), factor must be in 6, 4, 3, 2, 1
[4] - years: sample count must be >= 0, factor must be 1

Note: the factor if the last non empty (sample count != 0) precision must be 1.

Returns:

the period sizes.

getDB

java.lang.String getDB()

Returns the DB name that shall be used for storing the information for values of this statistic.

Returns:

if persistent.

setUp

void setUp(Context context)

Sets up the provider. After that the provider should push snapshots to this (if not null) context. When the passed context is null the provider MUST stop use the previously set context.

getMergeType

java.lang.String getMergeType()

Returns a ReportProvider name that could be used for merging current values on more then one hosts. If current value is not supported returns null.

Returns:

report provider name

getCurrentValue

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

Exported as current report if supported.

Parameters:

source - source of the statistic.

Returns:

current value.

Throws:

java.lang.UnsupportedOperationException

getSummaryNames

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

Returns names of predefined (summary) statistic values.

Returns:

summaries names (null if the statistic does not provide predefined values)

Throws:

ManagementException