Package org.opennms.features.topology.api.topo

Interface BackendGraph

All Superinterfaces:

NamespaceAware

All Known Implementing Classes:

BusinessServiceGraph, CollapsibleGraph, LegacyBackendGraph, SimpleGraph

public interface BackendGraph
extends NamespaceAware

Graph interface which are provided by a GraphProvider. Name is BackendGraph as there is already a Graph used in the UI.

Method Summary

Modifier and Type	Method	Description
void	addEdgeListener(EdgeListener listener)
void	addEdges(Edge... edges)
void	addVertexListener(VertexListener vertexListener)
void	addVertices(Vertex... vertices)
void	clearEdges()
void	clearVertices()
Edge	connectVertices(String edgeId, VertexRef sourceVertextId, VertexRef targetVertextId)
boolean	containsVertexId(String id)	Deprecated. Use containsVertexId(VertexRef, Criteria...) instead.
boolean	containsVertexId(VertexRef id, Criteria... criteria)
Edge	getEdge(String namespace, String id)
Edge	getEdge(EdgeRef reference)
EdgeRef[]	getEdgeIdsForVertex(VertexRef vertex)
Map<VertexRef,Set<EdgeRef>>	getEdgeIdsForVertices(VertexRef... vertices)	This function can be used for efficiency when you need the EdgeRef instances for a large number of vertices.
List<Edge>	getEdges(Collection<? extends EdgeRef> references)	Return an immutable list of all edges that match this set of references.
List<Edge>	getEdges(Criteria... criteria)	Return an immutable list of edges that match the criteria.
int	getEdgeTotalCount()
Vertex	getVertex(String namespace, String id)
Vertex	getVertex(VertexRef reference, Criteria... criteria)
int	getVertexTotalCount()
List<Vertex>	getVertices(Collection<? extends VertexRef> references, Criteria... criteria)
List<Vertex>	getVertices(Criteria... criteria)	Return an immutable list of vertices that match the criteria.
void	removeEdgeListener(EdgeListener listener)
void	removeEdges(EdgeRef... edges)
void	removeVertex(VertexRef... vertexId)
void	removeVertexListener(VertexListener vertexListener)
void	resetContainer()

Methods inherited from interface org.opennms.features.topology.api.NamespaceAware

contributesTo, getNamespace

Method Detail

containsVertexId

@Deprecated
boolean containsVertexId(String id)

Deprecated.

Use containsVertexId(VertexRef, Criteria...) instead.

containsVertexId

boolean containsVertexId(VertexRef id,
                         Criteria... criteria)

getVertex

Vertex getVertex(String namespace,
                 String id)

getVertex

Vertex getVertex(VertexRef reference,
                 Criteria... criteria)

getVertices

List<Vertex> getVertices(Criteria... criteria)

Return an immutable list of vertices that match the criteria.

getVertices

List<Vertex> getVertices(Collection<? extends VertexRef> references,
                         Criteria... criteria)

addVertexListener

void addVertexListener(VertexListener vertexListener)

removeVertexListener

void removeVertexListener(VertexListener vertexListener)

clearVertices

void clearVertices()

getVertexTotalCount

int getVertexTotalCount()

addVertices

void addVertices(Vertex... vertices)

removeVertex

void removeVertex(VertexRef... vertexId)

getEdge

Edge getEdge(String namespace,
             String id)

getEdge

Edge getEdge(EdgeRef reference)

getEdges

List<Edge> getEdges(Criteria... criteria)

Return an immutable list of edges that match the criteria.

getEdges

List<Edge> getEdges(Collection<? extends EdgeRef> references)

Return an immutable list of all edges that match this set of references.

addEdgeListener

void addEdgeListener(EdgeListener listener)

removeEdgeListener

void removeEdgeListener(EdgeListener listener)

clearEdges

void clearEdges()

getEdgeTotalCount

int getEdgeTotalCount()

getEdgeIdsForVertex

EdgeRef[] getEdgeIdsForVertex(VertexRef vertex)

getEdgeIdsForVertices

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

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(String edgeId,
                     VertexRef sourceVertextId,
                     VertexRef targetVertextId)

resetContainer

void resetContainer()