org.opennms.netmgt.config.collector
Interface CollectionAttribute

All Known Implementing Classes:

AbstractCollectionAttribute, AliasedAttribute, JdbcCollectionAttribute, LatencyCollectionAttribute, SnmpAttribute, WmiCollectionAttribute, XmlCollectionAttribute, XmpCollectionAttribute

public interface CollectionAttribute

CollectionAttribute interface.

Version:

$Id: $

Author:

ranger

Method Summary

CollectionAttributeType	getAttributeType() Return the attribute type for this attribute.
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)
boolean	shouldPersist(ServiceParameters params) Determines whether the attribute should be persisted.
void	storeAttribute(Persister persister) Stores the attribute using the persister.
void	visit(CollectionSetVisitor visitor) Visit this attribute

Method Detail

getResource

CollectionResource getResource()

getResource

Returns:

a 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

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.

shouldPersist

boolean shouldPersist(ServiceParameters params)

Determines whether the attribute should be persisted.

Parameters:

params - a ServiceParameters object.

Returns:

a boolean.

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.

visit

void visit(CollectionSetVisitor visitor)

Visit this attribute

Parameters:

visitor - a CollectionSetVisitor 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)