org.rhq.enterprise.server.measurement
Interface MeasurementDataManagerLocal

All Known Implementing Classes:

MeasurementDataManagerBean

public interface MeasurementDataManagerLocal

A manager for MeasurementDatas.

Method Summary

void	addNumericData(java.util.Set<MeasurementDataNumeric> data)
void	addTraitData(java.util.Set<MeasurementDataTrait> data)
java.util.List<MeasurementDataTrait>	findCurrentTraitsForResource(Subject subject, int resourceId, DisplayType displayType)
java.util.List<java.util.List<MeasurementDataNumericHighLowComposite>>	findDataForAutoGroup(Subject subject, int autoGroupParentResourceId, int autoGroupChildResourceTypeId, int measurementDefinitionId, long beginTime, long endTime, int numberOfDataPoints, boolean aggregateOverAutoGroup) Returns a list of numeric data point lists for the given auto group - one per specified measurement definition.
java.util.List<java.util.List<MeasurementDataNumericHighLowComposite>>	findDataForCompatibleGroup(Subject subject, int groupId, int definitionId, long beginTime, long endTime, int numPoints, boolean groupAggregateOnly) Returns a list of numeric data point lists for the given compatible group - one per specified measurement definition.
java.util.List<java.util.List<MeasurementDataNumericHighLowComposite>>	findDataForResource(Subject subject, int resourceId, int[] definitionIds, long beginTime, long endTime, int numPoints)
java.util.List<java.util.List<MeasurementDataNumericHighLowComposite>>	findDataForSiblingResources(Subject subject, int[] resourceIds, int measurementDefinitionId, long beginTime, long endTime, int numberOfdataPoints) Returns a list of numeric data point lists for the given measurement definition - one per specified resource.
java.util.Set<MeasurementData>	findLiveData(Subject subject, int resourceId, int[] definitionIds) Get live metrics for a given MeasurementSchedule
java.util.Map<java.lang.Integer,java.util.List<MetricDisplaySummary>>	findNarrowedMetricDisplaySummariesForCompatibleResources(Subject subject, java.util.Collection<Resource> resources, long beginTime, long endTime) Get the MetricDisplaySummarys for the resources passed in, that all need to be of the same ResourceType.
java.util.Map<java.lang.Integer,java.util.List<MetricDisplaySummary>>	findNarrowedMetricDisplaySummariesForResourcesAndParent(Subject subject, int resourceTypeId, int parentId, java.util.List<java.lang.Integer> resourceIds, long begin, long end) Return a map of <resource id, List<MetricDisplaySummary>>, where the list contains the MetricDisplaySummary for the (enabled) schedules of the resource
java.util.Map<java.lang.Integer,java.util.List<MetricDisplaySummary>>	findNarrowedMetricsDisplaySummariesForAutoGroup(Subject subject, int parentId, int cType, long beginTime, long endTime)
java.util.Map<java.lang.Integer,java.util.List<MetricDisplaySummary>>	findNarrowedMetricsDisplaySummariesForCompGroup(Subject subject, ResourceGroup group, long beginTime, long endTime) Get metric display summaries for the resources of the passed compatible group, where the MetricDisplaySummary only contains the metric name and number of alerts.
java.util.List<MeasurementDataTrait>	findTraits(Subject subject, int resourceId, int definitionId) Return all known trait data for the passed schedule, defined by resourceId and definitionId
MeasurementAggregate	getAggregate(Subject subject, int groupId, int definitionId, long startTime, long endTime)
MeasurementAggregate	getAggregate(Subject subject, int scheduleId, long startTime, long endTime) Get the aggregate values of the numerical values for a given schedule.
MeasurementDataNumeric	getCurrentNumericForSchedule(int scheduleId) Return the current numeric value for the passed schedule
MeasurementDataTrait	getCurrentTraitForSchedule(int scheduleId) Return the current trait value for the passed schedule
void	mergeMeasurementReport(MeasurementReport report)
int	purgeTraits(long oldest)

Method Detail

purgeTraits

int purgeTraits(long oldest)

mergeMeasurementReport

void mergeMeasurementReport(MeasurementReport report)

addNumericData

void addNumericData(java.util.Set<MeasurementDataNumeric> data)

addTraitData

void addTraitData(java.util.Set<MeasurementDataTrait> data)

findDataForSiblingResources

java.util.List<java.util.List<MeasurementDataNumericHighLowComposite>> findDataForSiblingResources(Subject subject,
                                                                                                   int[] resourceIds,
                                                                                                   int measurementDefinitionId,
                                                                                                   long beginTime,
                                                                                                   long endTime,
                                                                                                   int numberOfdataPoints)

Returns a list of numeric data point lists for the given measurement definition - one per specified resource.

Parameters:

subject -

resourceIds -

measurementDefinitionId - measurement definition id for a numeric metric associated with the given sibling resources

beginTime -

endTime -

numberOfdataPoints -

Returns:

findDataForAutoGroup

java.util.List<java.util.List<MeasurementDataNumericHighLowComposite>> findDataForAutoGroup(Subject subject,
                                                                                            int autoGroupParentResourceId,
                                                                                            int autoGroupChildResourceTypeId,
                                                                                            int measurementDefinitionId,
                                                                                            long beginTime,
                                                                                            long endTime,
                                                                                            int numberOfDataPoints,
                                                                                            boolean aggregateOverAutoGroup)

Returns a list of numeric data point lists for the given auto group - one per specified measurement definition. The data points represent the average min/avg/max values of the members of the group.

Parameters:

subject -

autoGroupParentResourceId -

autoGroupChildResourceTypeId -

measurementDefinitionId - measurement definition id of numeric metrics associated with the given auto group

beginTime -

endTime -

numberOfDataPoints -

aggregateOverAutoGroup - TODO

Returns:

getCurrentTraitForSchedule

MeasurementDataTrait getCurrentTraitForSchedule(int scheduleId)

Return the current trait value for the passed schedule

Parameters:

scheduleId - id of a MeasurementSchedule that 'points' to a Trait

Returns:

One trait

getCurrentNumericForSchedule

MeasurementDataNumeric getCurrentNumericForSchedule(int scheduleId)

Return the current numeric value for the passed schedule

Parameters:

scheduleId - id of a MeasurementSchedule that 'points' to a MeasurementDataNumeric record

Returns:

One MeasurementDataNumeric or null if nothing was found

findNarrowedMetricsDisplaySummariesForCompGroup

java.util.Map<java.lang.Integer,java.util.List<MetricDisplaySummary>> findNarrowedMetricsDisplaySummariesForCompGroup(Subject subject,
                                                                                                                      ResourceGroup group,
                                                                                                                      long beginTime,
                                                                                                                      long endTime)

Get metric display summaries for the resources of the passed compatible group, where the MetricDisplaySummary only contains the metric name and number of alerts. All other fields are not set.

Parameters:

subject - subject of the caller

group - compatible group

Returns:

a Map of resource id, List of summaries for this resource

findNarrowedMetricDisplaySummariesForCompatibleResources

java.util.Map<java.lang.Integer,java.util.List<MetricDisplaySummary>> findNarrowedMetricDisplaySummariesForCompatibleResources(Subject subject,
                                                                                                                               java.util.Collection<Resource> resources,
                                                                                                                               long beginTime,
                                                                                                                               long endTime)

Get the MetricDisplaySummarys for the resources passed in, that all need to be of the same ResourceType. Summaries only contain a basic selection of fields for the purpose of filling the Child resource popups.

findNarrowedMetricsDisplaySummariesForAutoGroup

java.util.Map<java.lang.Integer,java.util.List<MetricDisplaySummary>> findNarrowedMetricsDisplaySummariesForAutoGroup(Subject subject,
                                                                                                                      int parentId,
                                                                                                                      int cType,
                                                                                                                      long beginTime,
                                                                                                                      long endTime)

findNarrowedMetricDisplaySummariesForResourcesAndParent

java.util.Map<java.lang.Integer,java.util.List<MetricDisplaySummary>> findNarrowedMetricDisplaySummariesForResourcesAndParent(Subject subject,
                                                                                                                              int resourceTypeId,
                                                                                                                              int parentId,
                                                                                                                              java.util.List<java.lang.Integer> resourceIds,
                                                                                                                              long begin,
                                                                                                                              long end)

Return a map of <resource id, List<MetricDisplaySummary>>, where the list contains the MetricDisplaySummary for the (enabled) schedules of the resource

Parameters:

subject - Subject of the caller

resourceTypeId - ResourceTypeId of the child resources

parentId - ID of the common parent resource

resourceIds - List of primary keys of the resources we are interested in

begin - begin time

end - end time

getAggregate

MeasurementAggregate getAggregate(Subject subject,
                                  int scheduleId,
                                  long startTime,
                                  long endTime)

Get the aggregate values of the numerical values for a given schedule. This can only provide aggregates for data in the "live" table

Parameters:

subject - the user requesting the aggregate

scheduleId - the id of the MeasurementSchedule for which this aggregate is being requested

start - the start time

end - the end time

Returns:

MeasurementAggregate bean with the data

Throws:

FetchException - if the schedule does not reference numerical data or if the user is not allowed to view the Resource corresponding to this scheduleId

getAggregate

MeasurementAggregate getAggregate(Subject subject,
                                  int groupId,
                                  int definitionId,
                                  long startTime,
                                  long endTime)

findTraits

java.util.List<MeasurementDataTrait> findTraits(Subject subject,
                                                int resourceId,
                                                int definitionId)

Return all known trait data for the passed schedule, defined by resourceId and definitionId

Parameters:

resourceId - PK of a Resource

definitionId - PK of a MeasurementDefinition

Returns:

a List of MeasurementDataTrait objects.

findCurrentTraitsForResource

java.util.List<MeasurementDataTrait> findCurrentTraitsForResource(Subject subject,
                                                                  int resourceId,
                                                                  DisplayType displayType)

findLiveData

java.util.Set<MeasurementData> findLiveData(Subject subject,
                                            int resourceId,
                                            int[] definitionIds)

Get live metrics for a given MeasurementSchedule

Parameters:

sched - MeasurementSchedule to obtain the data for

Returns:

MeasurementData for this Schedule

findDataForCompatibleGroup

java.util.List<java.util.List<MeasurementDataNumericHighLowComposite>> findDataForCompatibleGroup(Subject subject,
                                                                                                  int groupId,
                                                                                                  int definitionId,
                                                                                                  long beginTime,
                                                                                                  long endTime,
                                                                                                  int numPoints,
                                                                                                  boolean groupAggregateOnly)

Returns a list of numeric data point lists for the given compatible group - one per specified measurement definition. The data points represent the average min/avg/max values of the members of the group.

Parameters:

subject -

compatibleGroupId -

measurementDefinitionId - measurement definition id for numeric metric associated with the given compatible group

beginTime -

endTime -

numberOfDataPoints -

aggregateOverGroup - TODO

Returns:

findDataForResource

java.util.List<java.util.List<MeasurementDataNumericHighLowComposite>> findDataForResource(Subject subject,
                                                                                           int resourceId,
                                                                                           int[] definitionIds,
                                                                                           long beginTime,
                                                                                           long endTime,
                                                                                           int numPoints)