public interface StatisticQuery extends OsidCompendiumQuery
This is the query for searching statistics. Each method specifies an
AND
term while multiple invocations of the same method
produce a nested OR.
Modifier and Type | Method and Description |
---|---|
void |
clearAverageRateTerms()
Clears the average rate query terms.
|
void |
clearDeltaTerms()
Clears the delta query terms.
|
void |
clearMeanTerms()
Clears the mean query terms.
|
void |
clearMedianTerms()
Clears the median query terms.
|
void |
clearMeteredObjectIdTerms()
Clears the object query terms.
|
void |
clearMeterIdTerms()
Clears the meter
Id query term. |
void |
clearMeterTerms()
Clears the meter query terms.
|
void |
clearMinimumDeltaTerms()
Clears the minimum delta query terms.
|
void |
clearMinimumMeanTerms()
Clears the minimum mean query terms.
|
void |
clearMinimumMedianTerms()
Clears the minimum median query terms.
|
void |
clearMinimumModeTerms()
Clears the minimum mode query terms.
|
void |
clearMinimumPercentChangeTerms()
Clears the minimum percentage change query terms.
|
void |
clearMinimumRMSTerms()
Clears the minimum rms query terms.
|
void |
clearMinimumStandardDeviationTerms()
Clears the minimum standard deviation query terms.
|
void |
clearMinimumSumTerms()
Clears the minimum sum query terms.
|
void |
clearModeTerms()
Clears the mode query terms.
|
void |
clearPercentChangeTerms()
Clears the delta query terms.
|
void |
clearRMSTerms()
Clears the rms query terms.
|
void |
clearStandardDeviationTerms()
Clears the standard deviation query terms.
|
void |
clearSumTerms()
Clears the sum query terms.
|
MeterQuery |
getMeterQuery()
Gets the query for a meter.
|
StatisticQueryRecord |
getStatisticQueryRecord(Type statisticRecordType)
Gets the statistic query record corresponding to the given
Statistic record Type. |
void |
matchAverageRate(java.math.BigDecimal low,
java.math.BigDecimal high,
boolean match)
Matches statistics with the average rate between the given range
inclusive.
|
void |
matchDelta(java.math.BigDecimal low,
java.math.BigDecimal high,
boolean match)
Matches statistics with the delta between the given range inclusive.
|
void |
matchMean(java.math.BigDecimal low,
java.math.BigDecimal high,
boolean match)
Matches statistics with the mean between the given range inclusive.
|
void |
matchMedian(java.math.BigDecimal low,
java.math.BigDecimal high,
boolean match)
Matches statistics with the median between the given range inclusive.
|
void |
matchMeteredObjectId(Id objectId,
boolean match)
Sets an object
Id. |
void |
matchMeterId(Id meterId,
boolean match)
Sets a meter
Id. |
void |
matchMinimumDelta(java.math.BigDecimal value,
boolean match)
Matches statistics with the minimum delta value inclusive.
|
void |
matchMinimumMean(java.math.BigDecimal value,
boolean match)
Matches statistics with the minimum mean value inclusive.
|
void |
matchMinimumMedian(java.math.BigDecimal value,
boolean match)
Matches statistics with the minimum median value inclusive.
|
void |
matchMinimumMode(java.math.BigDecimal value,
boolean match)
Matches statistics with the minimum mode value inclusive.
|
void |
matchMinimumPercentChange(java.math.BigDecimal value,
boolean match)
Matches statistics with the minimum percentage change value inclusive.
|
void |
matchMinimumRMS(java.math.BigDecimal value,
boolean match)
Matches statistics with the minimum rms value inclusive.
|
void |
matchMinimumStandardDeviation(java.math.BigDecimal value,
boolean match)
Matches statistics with the minimum standard deviation value
inclusive.
|
void |
matchMinimumSum(java.math.BigDecimal value,
boolean match)
Matches statistics with the minimum sum value inclusive.
|
void |
matchMode(java.math.BigDecimal low,
java.math.BigDecimal high,
boolean match)
Matches statistics with the mode between the given range inclusive.
|
void |
matchPercentChange(java.math.BigDecimal low,
java.math.BigDecimal high,
boolean match)
Matches statistics with the percentage change between the given range
inclusive.
|
void |
matchRMS(java.math.BigDecimal low,
java.math.BigDecimal high,
boolean match)
Matches statistics with the root mean square between the given range
inclusive.
|
void |
matchStandardDeviation(java.math.BigDecimal low,
java.math.BigDecimal high,
boolean match)
Matches statistics with the standard deviation between the given range
inclusive.
|
void |
matchSum(java.math.BigDecimal low,
java.math.BigDecimal high,
boolean match)
Matches statistics with the sum between the given range inclusive.
|
void |
setTimeRange(DateTime start,
DateTime end)
Sets the time for the statistics to generate.
|
boolean |
supportsMeterQuery()
Tests if a meter query is available.
|
clearEndDateTerms, clearExtrapolatedTerms, clearInterpolatedTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchEndDate, matchExtrapolated, matchInterpolated, matchStartDate
clearCommentIdTerms, clearCommentTerms, clearCreditIdTerms, clearCreditTerms, clearDescriptionTerms, clearDisplayNameTerms, clearGenusTypeTerms, clearJournalEntryIdTerms, clearJournalEntryTerms, clearParentGenusTypeTerms, clearRelationshipIdTerms, clearRelationshipPeerIdTerms, clearRelationshipTerms, clearStateIdTerms, clearStateTerms, clearStatisticTerms, clearSubjectIdTerms, clearSubjectRelevancyTerms, clearSubjectTerms, getCommentQuery, getCreditQuery, getJournalEntryQuery, getRelationshipQuery, getStateQuery, getStatisticQuery, getSubjectQuery, getSubjectRelevancyQuery, matchAnyComment, matchAnyCredit, matchAnyDescription, matchAnyDisplayName, matchAnyGenusType, matchAnyJournalEntry, matchAnyRelationship, matchAnyState, matchAnyStatistic, matchAnySubject, matchCommentId, matchCreditId, matchDescription, matchDisplayName, matchGenusType, matchJournalEntryId, matchParentGenusType, matchRelationshipId, matchRelationshipPeerId, matchStateId, matchSubjectId, supportsCommentQuery, supportsCreditQuery, supportsJournalEntryQuery, supportsRelationshipQuery, supportsStateQuery, supportsStatisticQuery, supportsSubjectQuery, supportsSubjectRelevancyQuery
clearIdTerms, matchId
clearRecordTerms, matchAnyRecord, matchRecordType
getRecordTypes, hasRecordType
clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType
void matchMeterId(Id meterId, boolean match)
Id.
meterId
- a meter Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- meterId
is
null
mandatory
- This method must be implemented. void clearMeterIdTerms()
Id
query term.mandatory
- This method must be implemented. boolean supportsMeterQuery()
true
if a meter query is available,
false
otherwisemandatory
- This method must be implemented. MeterQuery getMeterQuery()
UnimplementedException
- supportsMeterQuery()
is false
optional
- This method must be implemented if
supportsMeterQuery()
is true.
void clearMeterTerms()
mandatory
- This method must be implemented. void matchMeteredObjectId(Id objectId, boolean match)
Id.
objectId
- an object Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- objectId
is
null
mandatory
- This method must be implemented. void clearMeteredObjectIdTerms()
mandatory
- This method must be implemented. void setTimeRange(DateTime start, DateTime end)
start
- the start timeend
- the end timeNullArgumentException
- start
or
end
is null
mandatory
- This method must be implemented. void matchSum(java.math.BigDecimal low, java.math.BigDecimal high, boolean match)
low
- the low end of the rangehigh
- the high end of the rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- the low is greater than the
highmandatory
- This method must be implemented. void clearSumTerms()
mandatory
- This method must be implemented. void matchMinimumSum(java.math.BigDecimal value, boolean match)
value
- the low end of the rangematch
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearMinimumSumTerms()
mandatory
- This method must be implemented. void matchMean(java.math.BigDecimal low, java.math.BigDecimal high, boolean match)
low
- the low end of the rangehigh
- the high end of the rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- the low is greater than the
highmandatory
- This method must be implemented. void clearMeanTerms()
mandatory
- This method must be implemented. void matchMinimumMean(java.math.BigDecimal value, boolean match)
value
- the low end of the rangematch
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearMinimumMeanTerms()
mandatory
- This method must be implemented. void matchMedian(java.math.BigDecimal low, java.math.BigDecimal high, boolean match)
low
- the low end of the rangehigh
- the high end of the rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- the low is greater than the
highmandatory
- This method must be implemented. void clearMedianTerms()
mandatory
- This method must be implemented. void matchMinimumMedian(java.math.BigDecimal value, boolean match)
value
- the low end of the rangematch
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearMinimumMedianTerms()
mandatory
- This method must be implemented. void matchMode(java.math.BigDecimal low, java.math.BigDecimal high, boolean match)
low
- the low end of the rangehigh
- the high end of the rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- the low is greater than the
highmandatory
- This method must be implemented. void clearModeTerms()
mandatory
- This method must be implemented. void matchMinimumMode(java.math.BigDecimal value, boolean match)
value
- the low end of the rangematch
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearMinimumModeTerms()
mandatory
- This method must be implemented. void matchStandardDeviation(java.math.BigDecimal low, java.math.BigDecimal high, boolean match)
low
- the low end of the rangehigh
- the high end of the rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- the low is greater than the
highmandatory
- This method must be implemented. void clearStandardDeviationTerms()
mandatory
- This method must be implemented. void matchMinimumStandardDeviation(java.math.BigDecimal value, boolean match)
value
- the low end of the rangematch
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearMinimumStandardDeviationTerms()
mandatory
- This method must be implemented. void matchRMS(java.math.BigDecimal low, java.math.BigDecimal high, boolean match)
low
- the low end of the rangehigh
- the high end of the rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- the low is greater than the
highmandatory
- This method must be implemented. void clearRMSTerms()
mandatory
- This method must be implemented. void matchMinimumRMS(java.math.BigDecimal value, boolean match)
value
- the low end of the rangematch
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearMinimumRMSTerms()
mandatory
- This method must be implemented. void matchDelta(java.math.BigDecimal low, java.math.BigDecimal high, boolean match)
low
- the low end of the rangehigh
- the high end of the rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- the low is greater than the
highmandatory
- This method must be implemented. void clearDeltaTerms()
mandatory
- This method must be implemented. void matchMinimumDelta(java.math.BigDecimal value, boolean match)
value
- the low end of the rangematch
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearMinimumDeltaTerms()
mandatory
- This method must be implemented. void matchPercentChange(java.math.BigDecimal low, java.math.BigDecimal high, boolean match)
low
- the low end of the rangehigh
- the high end of the rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- the low is greater than the
highmandatory
- This method must be implemented. void clearPercentChangeTerms()
mandatory
- This method must be implemented. void matchMinimumPercentChange(java.math.BigDecimal value, boolean match)
value
- the low end of the rangematch
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearMinimumPercentChangeTerms()
mandatory
- This method must be implemented. void matchAverageRate(java.math.BigDecimal low, java.math.BigDecimal high, boolean match)
low
- the low end of the rangehigh
- the high end of the rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- the low is greater than the
highmandatory
- This method must be implemented. void clearAverageRateTerms()
mandatory
- This method must be implemented. StatisticQueryRecord getStatisticQueryRecord(Type statisticRecordType) throws OperationFailedException
Statistic
record Type.
Multiple retrievals
produce a nested OR
term.statisticRecordType
- a statistic record typeNullArgumentException
- statisticRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(statisticRecordType)
is false
mandatory
- This method must be implemented.