Package org.opennms.netmgt.collection.api

Interface CollectionAttribute

All Superinterfaces:

CollectionVisitable, Persistable

All Known Implementing Classes:

AbstractCollectionAttribute, AliasedAttribute, CollectionAttributeWrapper, LatencyCollectionAttribute, SnmpAttribute

public interface CollectionAttribute
extends CollectionVisitable, Persistable

CollectionAttribute interface.

Version:

$Id: $

Author:

ranger

Method Summary

Modifier and Type	Method	Description
CollectionAttributeType	getAttributeType()	Return the attribute type for this attribute.
java.lang.String	getMetricIdentifier()	Get the metric identifier for the attribute to be used for NRTG collection
java.lang.String	getName()	Gets the name of the attribute
java.lang.Number	getNumericValue()	Get the numeric value of the attribute.
CollectionResource	getResource()	getResource
java.lang.String	getStringValue()	Get the value of the attribute as a String.
AttributeType	getType()	The type of metric that the attribute represents.
void	storeAttribute(Persister persister)	Stores the attribute using the persister.

Methods inherited from interface org.opennms.netmgt.collection.api.CollectionVisitable

visit

Methods inherited from interface org.opennms.netmgt.collection.api.Persistable

shouldPersist

Method Detail

getResource

CollectionResource getResource()

getResource

Returns:

a org.opennms.netmgt.config.collector.CollectionResource object.

getStringValue

java.lang.String getStringValue()

Get the value of the attribute as a String.

Returns:

a String representing the attribute value

getNumericValue

java.lang.Number getNumericValue()

Get the numeric value of the attribute.

Returns:

a Number object.

getName

java.lang.String getName()

Gets the name of the attribute

Returns:

a name

getMetricIdentifier

java.lang.String getMetricIdentifier()

Get the metric identifier for the attribute to be used for NRTG collection

Returns:

the metric identifier

storeAttribute

void storeAttribute(Persister persister)

Stores the attribute using the persister. Not sure this should be here...

Parameters:

persister - a org.opennms.netmgt.collectd.Persister object.

getAttributeType

CollectionAttributeType getAttributeType()

Return the attribute type for this attribute. Not sure what an CollectionAttributeType is yet... please fill in if you do know

Returns:

a org.opennms.netmgt.collectd.CollectionAttributeType object.

getType

AttributeType getType()

The type of metric that the attribute represents.

Returns:

a AttributeType object.