org.opennms.netmgt.graph.api.service

Interface GraphContainerProvider

All Known Implementing Classes:

GraphmlGraphContainerProvider, PersistenceGraphContainerProvider, SingleGraphContainerProvider

public interface GraphContainerProvider

A GraphContainerProvider is responsible for providing an ImmutableGraphContainer as well as the meta information of that container. If possible the implementators should not load the full container when getContainerInfo() is invoked.

Method Summary

Modifier and Type	Method and Description
GraphContainerInfo	getContainerInfo() Invoking loadGraphContainer() may take some time, so it is not feasible to invoke it, if only the meta data of the container is requested.
ImmutableGraphContainer	loadGraphContainer() Returns a fully loaded ImmutableGraphContainer object, containing ALL vertices and edges.

Method Detail

loadGraphContainer

ImmutableGraphContainer loadGraphContainer()

Returns a fully loaded ImmutableGraphContainer object, containing ALL vertices and edges. May be slow.

Returns:

The populated container

getContainerInfo

GraphContainerInfo getContainerInfo()

Invoking loadGraphContainer() may take some time, so it is not feasible to invoke it, if only the meta data of the container is requested. Therefore the getContainerInfo() should return very quickly with the meta data of the container and its graphs.

Returns:

The container's meta data