org.hawkular.agent.monitor.inventory

Class MeasurementInstance<L,T extends MeasurementType<L>>

java.lang.Object

org.hawkular.agent.monitor.inventory.IDObject

org.hawkular.agent.monitor.inventory.NamedObject

org.hawkular.agent.monitor.inventory.AttributeLocationProvider<L>

org.hawkular.agent.monitor.inventory.Instance<L,T>

org.hawkular.agent.monitor.inventory.MeasurementInstance<L,T>

Type Parameters:

L - the type of the protocol specific location typically a subclass of NodeLocation

T - the measurement type

public final class MeasurementInstance<L,T extends MeasurementType<L>>
extends Instance<L,T>

A measurement instance that can be used to represent either numeric metric data or availability data.

Author:

Peter Palaga

Constructor Summary

Constructors

Constructor and Description
MeasurementInstance(ID id, Name name, AttributeLocation<L> attributeLocation, T type)
MeasurementInstance(MeasurementInstance<L,T> copy, boolean disown)

Method Summary

Modifier and Type	Method and Description
String	getAssociatedMetricId() This returns this instance's associated metric ID.
void	setAssociatedMetricId(String metricId) This tells this instance what its metric ID should be.

Methods inherited from class org.hawkular.agent.monitor.inventory.Instance

getResource, getType, setResource

Methods inherited from class org.hawkular.agent.monitor.inventory.AttributeLocationProvider

getAttributeLocation

Methods inherited from class org.hawkular.agent.monitor.inventory.NamedObject

getName

Methods inherited from class org.hawkular.agent.monitor.inventory.IDObject

addProperty, equals, getID, getProperties, hashCode, isPersisted, removeProperty, setPersisted, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MeasurementInstance

public MeasurementInstance(ID id,
                           Name name,
                           AttributeLocation<L> attributeLocation,
                           T type)

MeasurementInstance

public MeasurementInstance(MeasurementInstance<L,T> copy,
                           boolean disown)

Method Detail

getAssociatedMetricId

public String getAssociatedMetricId()

This returns this instance's associated metric ID. A metric ID is that ID which is used to store the metric data associated with this measurement instance into Hawkular Metrics. There is an explicit rule that all clients must follow - if a measurement instance has a property called then that ID must be used when storing and retrieving metric data associated with this measurement instance. If there is no such property, then the implicit rule takes effect, and that is the metric ID to be used will be the same as the id of this measurement instance. This method follows those rules - if there is such a property, its value is returned; otherwise this instance's ID string is returned.

Returns:

the metric ID that should be used to read/write metric data from/to Hawkular Metrics

setAssociatedMetricId

public void setAssociatedMetricId(String metricId)

This tells this instance what its metric ID should be. A metric ID is that ID which is used to store the metric data associated with this measurement instance into Hawkular Metrics. See getAssociatedMetricId() for more details.

Parameters:

metricId - the metric ID to be associated with this measurement instance. If this is null or empty, the metric ID will be assumed to be the same as this instance's ID.