com.prosyst.mprm.admin.statistics

Interface StatisticReport

public interface StatisticReport

This interface represents useful for users information gathered by a statistic, or a group of related statistics.

Method Summary

Modifier and Type	Method and Description
PeriodInfo[]	getInfo() Returns all the information of the report, represented as period and the value of the statistic for each period.
PeriodInfo[]	getInfo(java.util.Date periodStart, java.util.Date periodEnd) Returns the information of the report, collected for some period.
java.lang.String[]	getSummaryNames() Returns names of predefined (summary) statistic values.
java.lang.Number	getSummaryValue(java.lang.String summaryName) Given a summary name returns its value.
java.lang.String	getType() Returns the report type.

Method Detail

getType

java.lang.String getType()

Returns the report type.

Returns:

report type.

Throws:

ManagementException

getInfo

PeriodInfo[] getInfo()
              throws ManagementException

Returns all the information of the report, represented as period and the value of the statistic for each period.

Parameters:

minPeriodHint - parameter specifies a hint for the smallest period duration (i.e. the caller is interested in dividing of the information in chunks with duration not less then this period). However the returned periods could be lesser (for instance if minPeriodHint is bigger then the time the statistics has been recorded). It is in milliseconds.

Returns:

values of the statistic by periods. The values are ordered ascending on the period start time, i.e. the older is the first.

Throws:

ManagementException

getInfo

PeriodInfo[] getInfo(java.util.Date periodStart,
                     java.util.Date periodEnd)
              throws ManagementException

Returns the information of the report, collected for some period.

Parameters:

periodStart - start of the period for which values will be returned

periodEnd - end of the period for which values will be returned

minPeriodHint - parameter specifies a hint for the smallest period duration (i.e. the caller is interested in dividing of the information in chunks with duration not less then this period). However the returned periods could be lesser (for instance if minPeriodHint is bigger then the time the statistics has been recorded). It is in milliseconds.

Returns:

values of the statistic by periods. The values are ordered ascending on the period start time, i.e. the older is the first.

Throws:

ManagementException

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

getSummaryValue

java.lang.Number getSummaryValue(java.lang.String summaryName)
                          throws ManagementException

Given a summary name returns its value.

Parameters:

summaryName - the name of the summary

Returns:

summary value (null if the statistic has no summary with the given name)

Throws:

ManagementException