org.opennms.netmgt.collection.api

Interface CollectionAttribute

All Superinterfaces:

CollectionVisitable, Persistable

All Known Implementing Classes:

AbstractCollectionAttribute, AliasedAttribute, JdbcCollectionAttribute, LatencyCollectionAttribute, SnmpAttribute, TcaCollectionAttribute, VmwareCimCollectionAttribute, VmwareCollectionAttribute, WmiCollectionAttribute, XmlCollectionAttribute, XmpCollectionAttribute

public interface CollectionAttribute
extends CollectionVisitable, Persistable

CollectionAttribute interface.

Version:

$Id: $

Author:

ranger

Method Summary

Methods

Modifier and Type	Method and Description
CollectionAttributeType	getAttributeType() Return the attribute type for this attribute.
String	getMetricIdentifier() Get the metric identifier for the attribute to be used for NRTG collection
String	getName() Gets the name of the attribute
String	getNumericValue() Get the numeric value of the attribute, as a String.
CollectionResource	getResource() getResource
String	getStringValue() Get the value of the attribute as a String.
String	getType() Returns type of value (typically one of "counter", "gauge", "timeticks", "integer", "octetstring" - see NumericAttributeType)
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

String getStringValue()

Get the value of the attribute as a String.

Returns:

a String representing the attribute value

getNumericValue

String getNumericValue()

Get the numeric value of the attribute, as a String. Assumes the underlying value is actually numeric, and will return null if it is not parseable.

Returns:

a string representation of the numeric value of this attribute

getName

String getName()

Gets the name of the attribute

Returns:

a name

getMetricIdentifier

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

String getType()

Returns type of value (typically one of "counter", "gauge", "timeticks", "integer", "octetstring" - see NumericAttributeType)

Returns:

type of value stored in this attribute (SNMP semantics)