org.opennms.netmgt.collection.support

Class AbstractCollectionAttribute

java.lang.Object

org.opennms.netmgt.collection.support.AbstractCollectionAttribute

All Implemented Interfaces:

CollectionAttribute, CollectionVisitable, Persistable

Direct Known Subclasses:

DistributedLatencyCollectionAttribute, JdbcCollectionAttribute, SnmpAttribute, TcaCollectionAttribute, VmwareCimCollectionAttribute, VmwareCollectionAttribute, WmiCollectionAttribute, XmlCollectionAttribute, XmpCollectionAttribute

public abstract class AbstractCollectionAttribute
extends Object
implements CollectionAttribute

Abstract AbstractCollectionAttribute class.

Version:

$Id: $

Author:

ranger

Field Summary

Fields

Modifier and Type	Field and Description
protected CollectionAttributeType	m_attribType
protected CollectionResource	m_resource

Constructor Summary

Constructors

Constructor and Description
AbstractCollectionAttribute(CollectionAttributeType attribType, CollectionResource resource)

Method Summary

Modifier and Type	Method and Description
CollectionAttributeType	getAttributeType() getAttributeType
String	getName() Gets the name of the attribute
abstract Number	getNumericValue() getNumericValue
CollectionResource	getResource() getResource
abstract String	getStringValue() getStringValue
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) Since a CollectionAttribute is a terminal value, we just visit and complete it since it doesn't have any "children".

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getMetricIdentifier

Field Detail

m_attribType

protected final CollectionAttributeType m_attribType

m_resource

protected final CollectionResource m_resource

Constructor Detail

AbstractCollectionAttribute

public AbstractCollectionAttribute(CollectionAttributeType attribType,
                                   CollectionResource resource)

Method Detail

getAttributeType

public final CollectionAttributeType getAttributeType()

getAttributeType

Specified by:

getAttributeType in interface CollectionAttribute

Returns:

a CollectionAttributeType object.

getResource

public final CollectionResource getResource()

Description copied from interface: CollectionAttribute

getResource

Specified by:

getResource in interface CollectionAttribute

Returns:

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

getName

public final String getName()

Description copied from interface: CollectionAttribute

Gets the name of the attribute

Specified by:

getName in interface CollectionAttribute

Returns:

a name

getType

public final String getType()

Description copied from interface: CollectionAttribute

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

Specified by:

getType in interface CollectionAttribute

Returns:

type of value stored in this attribute (SNMP semantics)

getNumericValue

public abstract Number getNumericValue()

getNumericValue

Specified by:

getNumericValue in interface CollectionAttribute

Returns:

a Number object.

getStringValue

public abstract String getStringValue()

getStringValue

Specified by:

getStringValue in interface CollectionAttribute

Returns:

a String object.

shouldPersist

public boolean shouldPersist(ServiceParameters params)

Description copied from interface: Persistable

Determines whether the attribute should be persisted.

Specified by:

shouldPersist in interface Persistable

Parameters:

params - a ServiceParameters object.

Returns:

a boolean.

storeAttribute

public void storeAttribute(Persister persister)

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

Specified by:

storeAttribute in interface CollectionAttribute

Parameters:

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

visit

public final void visit(CollectionSetVisitor visitor)

Since a CollectionAttribute is a terminal value, we just visit and complete it since it doesn't have any "children".

Specified by:

visit in interface CollectionVisitable

Parameters:

visitor - a CollectionSetVisitor object.