org.opennms.netmgt.collectd

Class GenericIndexResource

java.lang.Object

org.opennms.netmgt.collectd.SnmpCollectionResource

org.opennms.netmgt.collectd.GenericIndexResource

All Implemented Interfaces:

CollectionResource, CollectionVisitable, Persistable, ResourceIdentifier

public class GenericIndexResource
extends SnmpCollectionResource

GenericIndexResource class.

Version:

$Id: $

Author:

ranger

Field Summary

Fields inherited from interface org.opennms.netmgt.collection.api.CollectionResource

RESOURCE_TYPE_IF, RESOURCE_TYPE_LATENCY, RESOURCE_TYPE_NODE

Constructor Summary

Constructors

Constructor and Description
GenericIndexResource(ResourceType def, String name, SnmpInstId inst) Constructor for GenericIndexResource.

Method Summary

Modifier and Type	Method and Description
String	getInstance() getInstance
String	getInterfaceLabel() getLabel
ResourcePath	getParent() Returns the name of the parent resource.
ResourcePath	getPath() Retrieves path for the resource, relative to the root of the associated RrdRepository.
String	getResourceTypeName() getResourceTypeName
int	getSnmpIfType() Returns ifType; is (but not sure if it should be) -1 for non interface type collections, otherwise the SNMP type of the interface.
String	getUnmodifiedInstance() Returns the unmodified instance string this CollectionResource represents.
boolean	shouldPersist(ServiceParameters params) Determines whether the attribute should be persisted.
String	toString() toString

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

getCollectionAgent, getGroups, getGroupType, getOwnerName, getResourceType, getStringAttributes, getTimeKeeper, rescanNeeded, setAttributeValue, visit

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericIndexResource

public GenericIndexResource(ResourceType def,
                            String name,
                            SnmpInstId inst)

Constructor for GenericIndexResource.

Parameters:

def - a ResourceType object.

name - a String object.

inst - a SnmpInstId object.

Method Detail

getPath

public ResourcePath getPath()

Description copied from interface: ResourceIdentifier

Retrieves path for the resource, relative to the root of the associated RrdRepository.

Returns:

ResourcePath object.

toString

public String toString()

toString

Overrides:

toString in class Object

Returns:

a String object.

getSnmpIfType

public int getSnmpIfType()

Returns ifType; is (but not sure if it should be) -1 for non interface type collections, otherwise the SNMP type of the interface. This field is used to match the ifType field of the group from datacollection-config.xml.

Specified by:

getSnmpIfType in class SnmpCollectionResource

Returns:

a int.

shouldPersist

public boolean shouldPersist(ServiceParameters params)

Determines whether the attribute should be persisted.

Specified by:

shouldPersist in interface Persistable

Specified by:

shouldPersist in class SnmpCollectionResource

Parameters:

params - a ServiceParameters object.

Returns:

a boolean.

getResourceTypeName

public String getResourceTypeName()

getResourceTypeName

Returns:

a String object.

getInstance

public String getInstance()

getInstance

Returns:

a String object.

getUnmodifiedInstance

public String getUnmodifiedInstance()

Description copied from interface: CollectionResource

Returns the unmodified instance string this CollectionResource represents.

Returns:

a String object.

getParent

public ResourcePath getParent()

Description copied from interface: CollectionResource

Returns the name of the parent resource.

Returns:

a String object.

getInterfaceLabel

public String getInterfaceLabel()

getLabel

Returns:

a String object.