public interface Statistic extends OsidCompendium
A Statistic
represents a reading of a Meter
for a reference metered object over a period of time.
Modifier and Type | Method and Description |
---|---|
java.math.BigDecimal |
getAverageRate(DateTimeResolution units)
Gets the average rate of change.
|
java.math.BigDecimal |
getDelta()
Gets the difference between the end and start values.
|
java.math.BigDecimal |
getMean()
Gets the mean.
|
java.math.BigDecimal |
getMedian()
Gets the median.
|
Meter |
getMeter()
Gets the
Meter associated with this reading. |
Id |
getMeteredObjectId()
Gets the metered object associated with this reading.
|
Id |
getMeterId()
Gets the
Id of the Meter associated with
this reading. |
java.math.BigDecimal |
getMode()
Gets the mode.
|
java.math.BigDecimal |
getPercentChange()
Gets the percent change between the end and start values (e.g.
|
java.math.BigDecimal |
getRMS()
Gets the root mean square.
|
java.math.BigDecimal |
getStandardDeviation()
Gets the standard deviation.
|
StatisticRecord |
getStatisticRecord(Type statisticRecordType)
Gets the statistic record corresponding to the given
Statistic
record Type. |
java.math.BigDecimal |
getSum()
Gets the total.
|
getEndDate, getStartDate, isExtrapolated, isInterpolated
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
Id getMeterId()
Id
of the Meter
associated with
this reading. Id
of the Meter
mandatory
- This method must be implemented. Meter getMeter() throws OperationFailedException
Meter
associated with this reading. Meter
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Id getMeteredObjectId()
Id
mandatory
- This method must be implemented. java.math.BigDecimal getSum()
mandatory
- This method must be implemented. java.math.BigDecimal getMean()
mandatory
- This method must be implemented. java.math.BigDecimal getMedian()
mandatory
- This method must be implemented. java.math.BigDecimal getMode()
mandatory
- This method must be implemented. java.math.BigDecimal getStandardDeviation()
mandatory
- This method must be implemented. java.math.BigDecimal getRMS()
mandatory
- This method must be implemented. java.math.BigDecimal getDelta()
mandatory
- This method must be implemented. java.math.BigDecimal getPercentChange()
mandatory
- This method must be implemented. java.math.BigDecimal getAverageRate(DateTimeResolution units)
units
- the time unitsNullArgumentException
- units
is
null
mandatory
- This method must be implemented. StatisticRecord getStatisticRecord(Type statisticRecordType) throws OperationFailedException
Statistic
record Type.
This method is used to retrieve an
object implementing the requested record. The
statisticRecordType
may be the Type
returned in
getRecordTypes()
or any of its parents in a Type
hierarchy where hasRecordType(statisticRecordType)
is true
.statisticRecordType
- the statistic record typeNullArgumentException
- statisticRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(statisticRecordType)
is false
mandatory
- This method must be implemented.