com.prosyst.mprm.backend.statistics.spi

Interface SummaryProvider

All Known Implementing Classes:

SummaryProvider.LastSP

public interface SummaryProvider

Provides summaries. Such providers may be used to provide compact view of statistics for certain periods. It may filter/modify the values.
Instances of such providers shall be registered into the OSGi registry in order to be used by the statistics service.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SummaryProvider.LastSP Summary provider for last milliseconds.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ALL_TIMES
static SummaryProvider	ALL_TIMES_SP
static java.lang.String	LAST_DAY
static SummaryProvider	LAST_DAY_SP
static java.lang.String	LAST_HOUR
static SummaryProvider	LAST_HOUR_SP
static java.lang.String	LAST_WEEK
static SummaryProvider	LAST_WEEK_SP

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName() The name of the summary provider.
java.lang.Number	getSummary(StatisticReport report, ReportProvider reportProvider) Calculate summary for a statistic report optionally using the report provider if it want to merge periods.

Field Detail

ALL_TIMES

static final java.lang.String ALL_TIMES

See Also:

Constant Field Values

LAST_WEEK

static final java.lang.String LAST_WEEK

See Also:

Constant Field Values

LAST_DAY

static final java.lang.String LAST_DAY

See Also:

Constant Field Values

LAST_HOUR

static final java.lang.String LAST_HOUR

See Also:

Constant Field Values

ALL_TIMES_SP

static final SummaryProvider ALL_TIMES_SP

LAST_WEEK_SP

static final SummaryProvider LAST_WEEK_SP

LAST_DAY_SP

static final SummaryProvider LAST_DAY_SP

LAST_HOUR_SP

static final SummaryProvider LAST_HOUR_SP

Method Detail

getName

java.lang.String getName()

The name of the summary provider.

Returns:

the name.

getSummary

java.lang.Number getSummary(StatisticReport report,
                            ReportProvider reportProvider)
                     throws ManagementException

Calculate summary for a statistic report optionally using the report provider if it want to merge periods.

Parameters:

report - the report that needs summary.

reportProvider - report provider used by the report.

Throws:

ManagementException