com.prosyst.mprm.backend.statistics.utils

Class BasicStatisticProvider

java.lang.Object

com.prosyst.mprm.backend.statistics.utils.BasicStatisticProvider

All Implemented Interfaces:

StatisticProvider

Direct Known Subclasses:

BasicPeriodicStatisticProvider

public class BasicStatisticProvider
extends java.lang.Object
implements StatisticProvider

Abstract class that ease implementations of StatisticProviders.

Field Summary

Fields inherited from interface com.prosyst.mprm.backend.statistics.spi.StatisticProvider

DEFAULT_PRECISION_INFO

Constructor Summary

Constructors

Constructor and Description
BasicStatisticProvider(java.lang.String group, java.lang.String name, java.lang.String[] reportTypes, java.lang.String mergeType, boolean hasCurrentValueSupport, int[][] precisionInfo, java.lang.String db) If this constructor is used with currentValueProvider != null the method getCurrentValue(com.prosyst.mprm.admin.statistics.Source) shall be overridden.
BasicStatisticProvider(java.lang.String group, java.lang.String name, java.lang.String[] reportTypes, java.lang.String mergeType, boolean hasCurrentValueSupport, java.lang.String db) If this constructor is used with currentValueProvider != null the method getCurrentValue(com.prosyst.mprm.admin.statistics.Source) shall be overridden.

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	putSnapshot(Snapshot snapshot) Shall be called by the extender to put snapshot to all report supports.
void	setUp(Context context) Sets up the provider.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BasicStatisticProvider

public BasicStatisticProvider(java.lang.String group,
                              java.lang.String name,
                              java.lang.String[] reportTypes,
                              java.lang.String mergeType,
                              boolean hasCurrentValueSupport,
                              java.lang.String db)

If this constructor is used with currentValueProvider != null the method getCurrentValue(com.prosyst.mprm.admin.statistics.Source) shall be overridden.

Parameters:

group - statistic group

name - statistic name

reportTypes - the report type

mergeType - the merge strategy

hasCurrentValueSupport - if has support for current value

precisionInfo - the precision information

db - db to be used for persistence.

BasicStatisticProvider

public BasicStatisticProvider(java.lang.String group,
                              java.lang.String name,
                              java.lang.String[] reportTypes,
                              java.lang.String mergeType,
                              boolean hasCurrentValueSupport,
                              int[][] precisionInfo,
                              java.lang.String db)

If this constructor is used with currentValueProvider != null the method getCurrentValue(com.prosyst.mprm.admin.statistics.Source) shall be overridden.

Parameters:

group - statistic group

name - statistic name

reportTypes - the report type

mergeType - the merge strategy

hasCurrentValueSupport - if has support for current value

precisionInfo - the precision information

db - db to be used for persistence.

Method Detail

getGroup

public java.lang.String getGroup()

Description copied from interface: StatisticProvider

Returns statistic group.

Specified by:

getGroup in interface StatisticProvider

Returns:

statistic group.

getName

public java.lang.String getName()

Description copied from interface: StatisticProvider

Returns statistic name.

Specified by:

getName in interface StatisticProvider

Returns:

statistic name.

getReportTypes

public java.lang.String[] getReportTypes()

Description copied from interface: StatisticProvider

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

Specified by:

getReportTypes in interface StatisticProvider

Returns:

supported reports.

hasCurrentValueSupport

public boolean hasCurrentValueSupport()

Description copied from interface: StatisticProvider

Return the if current value is supported.

Specified by:

hasCurrentValueSupport in interface StatisticProvider

Returns:

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

getPrecisionInfo

public int[][] getPrecisionInfo()

Description copied from interface: StatisticProvider

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.

Specified by:

getPrecisionInfo in interface StatisticProvider

Returns:

the period sizes.

getDB

public java.lang.String getDB()

Description copied from interface: StatisticProvider

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

Specified by:

getDB in interface StatisticProvider

Returns:

if persistent.

setUp

public void setUp(Context context)

Description copied from interface: StatisticProvider

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.

Specified by:

setUp in interface StatisticProvider

getMergeType

public java.lang.String getMergeType()

Description copied from interface: StatisticProvider

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.

Specified by:

getMergeType in interface StatisticProvider

Returns:

report provider name

getCurrentValue

public java.lang.Number getCurrentValue(Source source)

Description copied from interface: StatisticProvider

Exported as current report if supported.

Specified by:

getCurrentValue in interface StatisticProvider

Parameters:

source - source of the statistic.

Returns:

current value.

getSummaryNames

public java.lang.String[] getSummaryNames()

Description copied from interface: StatisticProvider

Returns names of predefined (summary) statistic values.

Specified by:

getSummaryNames in interface StatisticProvider

Returns:

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

putSnapshot

public void putSnapshot(Snapshot snapshot)

Shall be called by the extender to put snapshot to all report supports.

Parameters:

snapshot - snapshot