org.rhq.metrics.core

Class Metric<T extends MetricData>

java.lang.Object

org.rhq.metrics.core.Metric<T>

Direct Known Subclasses:

AvailabilityMetric, NumericMetric

public abstract class Metric<T extends MetricData>
extends Object

Author:

John Sanda

Field Summary

Fields

Modifier and Type	Field and Description
static long	DPART

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Metric(String tenantId, MetricId id)
protected	Metric(String tenantId, MetricId id, Map<String,String> Metadata)
protected	Metric(String tenantId, MetricId id, Map<String,String> Metadata, Integer dataRetention)

Method Summary

Modifier and Type	Method and Description
void	addData(T d)
boolean	equals(Object o)
List<T>	getData()
Integer	getDataRetention()
long	getDpart()
MetricId	getId()
Map<String,String>	getMetadata() A set of key/value pairs that are shared by all data points for the metric.
String	getTenantId()
abstract MetricType	getType()
int	hashCode()
void	setAttribute(String name, String value) Stores an attribute which will be shared by all data points for the metric when it is persisted.
void	setDataRetention(Integer dataRetention)
void	setDpart(long dpart)
void	setId(MetricId id)
void	setMetadata(Map<String,String> metadata)
Metric	setTenantId(String tenantId)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DPART

public static final long DPART

See Also:

Constant Field Values

Constructor Detail

Metric

protected Metric(String tenantId,
                 MetricId id)

Metric

protected Metric(String tenantId,
                 MetricId id,
                 Map<String,String> Metadata)

Metric

protected Metric(String tenantId,
                 MetricId id,
                 Map<String,String> Metadata,
                 Integer dataRetention)

Method Detail

getType

public abstract MetricType getType()

getTenantId

public String getTenantId()

setTenantId

public Metric setTenantId(String tenantId)

getId

public MetricId getId()

setId

public void setId(MetricId id)

getDpart

public long getDpart()

setDpart

public void setDpart(long dpart)

getMetadata

public Map<String,String> getMetadata()

A set of key/value pairs that are shared by all data points for the metric. A good example is units like KB/sec.

setMetadata

public void setMetadata(Map<String,String> metadata)

setAttribute

public void setAttribute(String name,
                         String value)

Stores an attribute which will be shared by all data points for the metric when it is persisted. If an attribute with the same name already exists, it will be overwritten.

Parameters:

name - The attribute name.

value - The attribute value

getData

public List<T> getData()

addData

public void addData(T d)

getDataRetention

public Integer getDataRetention()

setDataRetention

public void setDataRetention(Integer dataRetention)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object