org.opennms.protocols.xml.collector

Class XmlCollectionAttribute

java.lang.Object

org.opennms.netmgt.collectd.AbstractCollectionAttribute

org.opennms.protocols.xml.collector.XmlCollectionAttribute

All Implemented Interfaces:

CollectionAttribute

public class XmlCollectionAttribute
extends AbstractCollectionAttribute
implements CollectionAttribute

The Class XmlCollectionAttribute.

This is related with the configuration class XmlObject (the attribute to be stored on a RRD file).

Author:

Alejandro Galue

Constructor Summary

Constructors

Constructor and Description
XmlCollectionAttribute(XmlCollectionResource resource, XmlCollectionAttributeType attribType, String value) Instantiates a new XML collection attribute.

Method Summary

Methods

Modifier and Type	Method and Description
CollectionAttributeType	getAttributeType() getAttributeType
String	getMetricIdentifier() Get the metric identifier for the attribute to be used for NRTG collection
String	getName() getName
String	getNumericValue() getNumericValue
CollectionResource	getResource() getResource
String	getStringValue() getStringValue
String	getType() Returns type of value (typically one of "counter", "gauge", "timeticks", "integer", "octetstring" - see NumericAttributeType)
protected ThreadCategory	log() Log.
boolean	shouldPersist(ServiceParameters params) Determines whether the attribute should be persisted.
String	toString()

Methods inherited from class org.opennms.netmgt.collectd.AbstractCollectionAttribute

storeAttribute, visit

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opennms.netmgt.config.collector.CollectionAttribute

storeAttribute, visit

Constructor Detail

XmlCollectionAttribute

public XmlCollectionAttribute(XmlCollectionResource resource,
                      XmlCollectionAttributeType attribType,
                      String value)

Instantiates a new XML collection attribute.

Parameters:

resource - the resource

attribType - the attribute type

value - the attribute value

Method Detail

getAttributeType

public CollectionAttributeType getAttributeType()

Description copied from class: AbstractCollectionAttribute

getAttributeType

Specified by:

getAttributeType in interface CollectionAttribute

Specified by:

getAttributeType in class AbstractCollectionAttribute

Returns:

a CollectionAttributeType object.

getName

public String getName()

Description copied from class: AbstractCollectionAttribute

getName

Specified by:

getName in interface CollectionAttribute

Specified by:

getName in class AbstractCollectionAttribute

Returns:

a String object.

getNumericValue

public String getNumericValue()

Description copied from class: AbstractCollectionAttribute

getNumericValue

Specified by:

getNumericValue in interface CollectionAttribute

Specified by:

getNumericValue in class AbstractCollectionAttribute

Returns:

a String object.

getResource

public CollectionResource getResource()

Description copied from class: AbstractCollectionAttribute

getResource

Specified by:

getResource in interface CollectionAttribute

Specified by:

getResource in class AbstractCollectionAttribute

Returns:

a CollectionResource object.

getStringValue

public String getStringValue()

Description copied from class: AbstractCollectionAttribute

getStringValue

Specified by:

getStringValue in interface CollectionAttribute

Specified by:

getStringValue in class AbstractCollectionAttribute

Returns:

a String object.

shouldPersist

public boolean shouldPersist(ServiceParameters params)

Description copied from class: AbstractCollectionAttribute

Determines whether the attribute should be persisted.

Specified by:

shouldPersist in interface CollectionAttribute

Specified by:

shouldPersist in class AbstractCollectionAttribute

Parameters:

params - a ServiceParameters object.

Returns:

a boolean.

getType

public 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)

toString

public String toString()

Overrides:

toString in class Object

log

protected ThreadCategory log()

Log.

Overrides:

log in class AbstractCollectionAttribute

Returns:

the thread category

getMetricIdentifier

public String getMetricIdentifier()

Description copied from interface: CollectionAttribute

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

Specified by:

getMetricIdentifier in interface CollectionAttribute

Returns:

the metric identifier