org.opennms.netmgt.collection.support.builder

Interface Resource

All Known Implementing Classes:

GenericTypeResource, GenericTypeResourceWithoutInstance, InterfaceLevelResource, NodeLevelResource

public interface Resource

Method Summary

Modifier and Type	Method and Description
String	getInstance() Returns a unique name for the instance of this resource.
String	getLabel(CollectionResource resource) Returns a unique label for the instance of this resource.
Resource	getParent()
Path	getPath(CollectionResource resource) Retrieves the path of the resource, relative to the repository root.
String	getTypeName() Returns the type name associated with the resource.

Method Detail

getParent

Resource getParent()

getTypeName

String getTypeName()

Returns the type name associated with the resource. Used for thresholding.

Returns:

type name

getInstance

String getInstance()

Returns a unique name for the instance of this resource. Used by the IndexStorageStrategy

Returns:

instance name

getLabel

String getLabel(CollectionResource resource)

Returns a unique label for the instance of this resource. This label is used by threshd to generate a unique id on a per resource basis, grouped by node. See CollectionResourceWrapper

Returns:

a String object.

getPath

Path getPath(CollectionResource resource)

Retrieves the path of the resource, relative to the repository root.

Parameters:

resource - Used by the GenericTypeResource in order to determine the instance name.

Returns:

relative path