org.opennms.features.topology.api.topo

Interface GraphProvider

All Superinterfaces:

EdgeProvider, VertexProvider

All Known Implementing Classes:

AbstractLinkdTopologyProvider, AbstractTopologyProvider, EnhancedLinkdTopologyProvider, LinkdTopologyProvider, MergingGraphProvider, NodeACLVertexProvider, OnmsTopologyProvider, SFreeTopologyProvider, SimpleGraphProvider, VertexHopGraphProvider, VmwareTopologyProvider

public interface GraphProvider
extends VertexProvider, EdgeProvider

Method Summary

Methods

Modifier and Type	Method and Description
void	addEdges(Edge... edges)
Vertex	addGroup(String label, String iconKey)
Vertex	addVertex(int x, int y) Deprecated. Convert calls to this to addVertices
void	addVertices(Vertex... vertices)
Edge	connectVertices(VertexRef sourceVertextId, VertexRef targetVertextId)
Criteria	getDefaultCriteria()
EdgeRef[]	getEdgeIdsForVertex(VertexRef vertex)
Map<VertexRef,Set<EdgeRef>>	getEdgeIdsForVertices(VertexRef... vertex) This function can be used for efficiency when you need the EdgeRef instances for a large number of vertices.
boolean	groupingSupported() This function indicates support for (mostly legacy) grouping operations.
void	load(String filename)
void	refresh()
void	removeEdges(EdgeRef... edges)
void	removeVertex(VertexRef... vertexId)
void	resetContainer()
void	save()

Methods inherited from interface org.opennms.features.topology.api.topo.VertexProvider

addVertexListener, clearVertices, containsVertexId, containsVertexId, contributesTo, getChildren, getParent, getRootGroup, getSemanticZoomLevel, getVertex, getVertex, getVertexNamespace, getVertexTotalCount, getVertices, getVertices, hasChildren, removeVertexListener, setParent

Methods inherited from interface org.opennms.features.topology.api.topo.EdgeProvider

addEdgeListener, clearEdges, contributesTo, getEdge, getEdge, getEdgeNamespace, getEdges, getEdges, removeEdgeListener

Method Detail

save

void save()

load

void load(String filename)
          throws MalformedURLException,
                 JAXBException

Throws:

MalformedURLException

JAXBException

refresh

void refresh()

resetContainer

void resetContainer()

addVertices

void addVertices(Vertex... vertices)

removeVertex

void removeVertex(VertexRef... vertexId)

addVertex

Vertex addVertex(int x,
               int y)

Deprecated. Convert calls to this to addVertices

groupingSupported

boolean groupingSupported()

This function indicates support for (mostly legacy) grouping operations. If true then addGroup() should work as expected.

addGroup

Vertex addGroup(String label,
              String iconKey)

getEdgeIdsForVertex

EdgeRef[] getEdgeIdsForVertex(VertexRef vertex)

getEdgeIdsForVertices

Map<VertexRef,Set<EdgeRef>> getEdgeIdsForVertices(VertexRef... vertex)

This function can be used for efficiency when you need the EdgeRef instances for a large number of vertices.

addEdges

void addEdges(Edge... edges)

removeEdges

void removeEdges(EdgeRef... edges)

connectVertices

Edge connectVertices(VertexRef sourceVertextId,
                   VertexRef targetVertextId)

getDefaultCriteria

Criteria getDefaultCriteria()