Package org.opennms.netmgt.dao.support

Class GenericIndexResourceType

java.lang.Object

org.opennms.netmgt.dao.support.GenericIndexResourceType

All Implemented Interfaces:

OnmsResourceType

public final class GenericIndexResourceType
extends Object
implements OnmsResourceType

Generic index resources are stored in paths like: snmp/1/${name}/${index}/ds.rrd The name and index elements depend on the implementation. Implementations are loaded from the data-collection configuration at run-time.

Constructor Summary

Constructors

Constructor	Description
GenericIndexResourceType(ResourceStorageDao resourceStorageDao, String name, String label, String resourceLabelExpression, StorageStrategy storageStrategy)	Constructor for GenericIndexResourceType.

Method Summary

Modifier and Type	Method	Description
protected static Map<String,GenericIndexResourceType>	createTypes(Map<String,ResourceType> configuredResourceTypes, ResourceStorageDao resourceStorageDao)
OnmsResource	getChildByName(OnmsResource parent, String index)	Retrieves a child resource with the given name from the parent.
String	getLabel()	getLabel
String	getLinkForResource(OnmsResource resource)	getLinkForResource
String	getName()	getName
OnmsResource	getResourceByPath(ResourcePath path, OnmsResource parent)
List<OnmsResource>	getResourcesForParent(OnmsResource parent)	Returns the set of resources that are available on the given parent.
StorageStrategy	getStorageStrategy()	getStorageStrategy
boolean	isResourceTypeOnParent(OnmsResource parent)	Returns true if one on more instances of the resource type are present on the parent resource.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericIndexResourceType

public GenericIndexResourceType(ResourceStorageDao resourceStorageDao,
                                String name,
                                String label,
                                String resourceLabelExpression,
                                StorageStrategy storageStrategy)

Constructor for GenericIndexResourceType.

Parameters:

resourceStorageDao - a ResourceStorageDao object.

name - a String object.

label - a String object.

resourceLabelExpression - a String object.

storageStrategy - a StorageStrategy object.

Method Detail

getName

public String getName()

getName

Specified by:

getName in interface OnmsResourceType

Returns:

a String object.

getLabel

public String getLabel()

getLabel

Specified by:

getLabel in interface OnmsResourceType

Returns:

a String object.

getStorageStrategy

public StorageStrategy getStorageStrategy()

getStorageStrategy

Returns:

a StorageStrategy object.

isResourceTypeOnParent

public boolean isResourceTypeOnParent(OnmsResource parent)

Returns true if one on more instances of the resource type are present on the parent resource. Top-level resource types should always return false.

Specified by:

isResourceTypeOnParent in interface OnmsResourceType

getResourcesForParent

public List<OnmsResource> getResourcesForParent(OnmsResource parent)

Returns the set of resources that are available on the given parent. If none are available, i.e. isResourceTypeOnParent() would return false, then an empty list should be returned. Top-level resource types should return the set of top-level resources when parent is null.

Specified by:

getResourcesForParent in interface OnmsResourceType

getChildByName

public OnmsResource getChildByName(OnmsResource parent,
                                   String index)

Retrieves a child resource with the given name from the parent.

Specified by:

getChildByName in interface OnmsResourceType

Returns:

null if no resource with the given name was found

getLinkForResource

public String getLinkForResource(OnmsResource resource)

getLinkForResource

Specified by:

getLinkForResource in interface OnmsResourceType

Parameters:

resource - a OnmsResource object.

Returns:

a String object.

getResourceByPath

public OnmsResource getResourceByPath(ResourcePath path,
                                      OnmsResource parent)

createTypes

protected static Map<String,GenericIndexResourceType> createTypes(Map<String,ResourceType> configuredResourceTypes,
                                                                        ResourceStorageDao resourceStorageDao)

toString

public String toString()

Overrides:

toString in class Object