Interface Statistic

All Superinterfaces:
Browsable, Extensible, Identifiable, OsidCompendium, OsidObject, Subjugateable
public interface Statistic extends OsidCompendium

A Statistic represents a reading of a Meter for a reference metered object over a period of time.

  • Method Details

    • getMeterId

      Id getMeterId()
      Gets the Id of the Meter associated with this reading.
      Returns:
      the Id of the Meter
      Compliance:
      mandatory - This method must be implemented.

    • getMeter

      Meter getMeter() throws OperationFailedException
      Gets the Meter associated with this reading.
      Returns:
      the Meter
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getMeteredObjectId

      Id getMeteredObjectId()
      Gets the metered object associated with this reading.
      Returns:
      the metered object Id
      Compliance:
      mandatory - This method must be implemented.

    • getSum

      BigDecimal getSum()
      Gets the total.
      Returns:
      the sum
      Compliance:
      mandatory - This method must be implemented.

    • getMean

      BigDecimal getMean()
      Gets the mean.
      Returns:
      the mean
      Compliance:
      mandatory - This method must be implemented.

    • getMedian

      BigDecimal getMedian()
      Gets the median.
      Returns:
      the mean
      Compliance:
      mandatory - This method must be implemented.

    • getMode

      BigDecimal getMode()
      Gets the mode.
      Returns:
      the mode
      Compliance:
      mandatory - This method must be implemented.

    • getStandardDeviation

      BigDecimal getStandardDeviation()
      Gets the standard deviation.
      Returns:
      the standard deviation
      Compliance:
      mandatory - This method must be implemented.

    • getRMS

      BigDecimal getRMS()
      Gets the root mean square.
      Returns:
      the rms
      Compliance:
      mandatory - This method must be implemented.

    • getDelta

      BigDecimal getDelta()
      Gets the difference between the end and start values.
      Returns:
      the delta
      Compliance:
      mandatory - This method must be implemented.

    • getPercentChange

      BigDecimal getPercentChange()
      Gets the percent change between the end and start values (e.g. 50.25%).
      Returns:
      the delta
      Compliance:
      mandatory - This method must be implemented.

    • getAverageRate

      BigDecimal getAverageRate(DateTimeResolution units)
      Gets the average rate of change.
      Parameters:
      units - the time units
      Returns:
      the average rate
      Throws:
      NullArgumentException - units is null
      Compliance:
      mandatory - This method must be implemented.

    • getStatisticRecord

      StatisticRecord getStatisticRecord(Type statisticRecordType) throws OperationFailedException
      Gets the statistic record corresponding to the given 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.
      Parameters:
      statisticRecordType - the statistic record type
      Returns:
      the statistic record
      Throws:
      NullArgumentException - statisticRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(statisticRecordType) is false
      Compliance:
      mandatory - This method must be implemented.