org.opennms.netmgt.graph.api.service

Interface GraphProvider

All Known Implementing Classes:

ApplicationGraphProvider, BusinessServiceGraphProvider, LegacyGraphProvider

public interface GraphProvider

Convenient interface if a GraphContainerProvider only provides a single graph. Internally a GraphProvider will be converted to a GraphContainerProvider which provides a single graph.

Author:

mvrueden

Method Summary

Modifier and Type	Method and Description
GraphInfo	getGraphInfo() The GraphInfo should be used to provide details of the graph's nature, e.g.
ImmutableGraph<?,?>	loadGraph() Loads the graph, this GraphProvider handles.

Method Detail

loadGraph

ImmutableGraph<?,?> loadGraph()

Loads the graph, this GraphProvider handles. Loading may be performed very quickly, but also may take some time.

Returns:

The populated graph.

getGraphInfo

GraphInfo getGraphInfo()

The GraphInfo should be used to provide details of the graph's nature, e.g. the namespace, label or description A ImmutableGraph should also embed this information. The difference is, that the info should always be available, even if the graph is not yet loaded, and should also never change during the provider's live time, whereas the graph itself may change (e.g. different vertices/edges and properties (besides the ones defining the info)).

Returns:

the meta information of the graph