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

Class CollapsibleGraph

java.lang.Object

org.opennms.features.topology.api.topo.CollapsibleGraph

All Implemented Interfaces:

NamespaceAware, BackendGraph

public class CollapsibleGraph
extends Object
implements BackendGraph

Constructor Summary

Constructors

Constructor	Description
CollapsibleGraph(BackendGraph delegate)

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()
static Set<Edge>	collapseEdges(Set<Edge> edges, CollapsibleCriteria[] criteria)	This function assumes that all criteria passed in are marked as collapsed.
static Set<Vertex>	collapseVertices(Set<Vertex> vertices, CollapsibleCriteria[] criteria)
Edge	connectVertices(String edgeId, VertexRef sourceVertextId, VertexRef targetVertextId)
boolean	containsVertexId(String id)
boolean	containsVertexId(VertexRef id, Criteria... criteria)
boolean	contributesTo(String namespace)	Defines if the current implementation contributes to the given namespace.
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()
Set<VertexRef>	getFocusNodes(Criteria... criteria)
static Map<VertexRef,Set<Vertex>>	getMapOfVerticesToCollapsedVertices(CollapsibleCriteria[] criteria)
int	getMaxSemanticZoomLevel(Criteria... criteria)
String	getNamespace()	A string used to identify references belonging to this provider May only contain characters that make for a reasonable Java identifier such as letters digits and underscore (no colons, periods, commas etc.)
int	getSemanticZoomLevel(VertexRef vertex)
Vertex	getVertex(String namespace, String id)
Vertex	getVertex(VertexRef reference, Criteria... criteria)
int	getVertexTotalCount()
Collection<Vertex>	getVertices(int semanticZoomLevel, Criteria... criteria)
List<Vertex>	getVertices(Collection<? extends VertexRef> references, Criteria... criteria)
List<Vertex>	getVertices(CollapsibleRef collapsibleRef, 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 class java.lang.Object

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

Constructor Detail

CollapsibleGraph

public CollapsibleGraph(BackendGraph delegate)

Method Detail

containsVertexId

public boolean containsVertexId(String id)

Specified by:

containsVertexId in interface BackendGraph

containsVertexId

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

Specified by:

containsVertexId in interface BackendGraph

getVertex

public Vertex getVertex(String namespace,
                        String id)

Specified by:

getVertex in interface BackendGraph

getVertex

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

Specified by:

getVertex in interface BackendGraph

getVertices

public Collection<Vertex> getVertices(int semanticZoomLevel,
                                      Criteria... criteria)

getSemanticZoomLevel

public int getSemanticZoomLevel(VertexRef vertex)

getFocusNodes

public Set<VertexRef> getFocusNodes(Criteria... criteria)

getMaxSemanticZoomLevel

public int getMaxSemanticZoomLevel(Criteria... criteria)

getVertices

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

Description copied from interface: BackendGraph

Return an immutable list of vertices that match the criteria.

Specified by:

getVertices in interface BackendGraph

getVertices

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

Specified by:

getVertices in interface BackendGraph

addVertexListener

public void addVertexListener(VertexListener vertexListener)

Specified by:

addVertexListener in interface BackendGraph

removeVertexListener

public void removeVertexListener(VertexListener vertexListener)

Specified by:

removeVertexListener in interface BackendGraph

clearVertices

public void clearVertices()

Specified by:

clearVertices in interface BackendGraph

getVertexTotalCount

public int getVertexTotalCount()

Specified by:

getVertexTotalCount in interface BackendGraph

addVertices

public void addVertices(Vertex... vertices)

Specified by:

addVertices in interface BackendGraph

removeVertex

public void removeVertex(VertexRef... vertexId)

Specified by:

removeVertex in interface BackendGraph

getEdge

public Edge getEdge(String namespace,
                    String id)

Specified by:

getEdge in interface BackendGraph

getEdge

public Edge getEdge(EdgeRef reference)

Specified by:

getEdge in interface BackendGraph

collapseVertices

public static Set<Vertex> collapseVertices(Set<Vertex> vertices,
                                           CollapsibleCriteria[] criteria)

getMapOfVerticesToCollapsedVertices

public static Map<VertexRef,Set<Vertex>> getMapOfVerticesToCollapsedVertices(CollapsibleCriteria[] criteria)

collapseEdges

public static Set<Edge> collapseEdges(Set<Edge> edges,
                                      CollapsibleCriteria[] criteria)

This function assumes that all criteria passed in are marked as collapsed.

Parameters:

edges -

criteria -

Returns:

getVertices

public List<Vertex> getVertices(CollapsibleRef collapsibleRef,
                                Criteria... criteria)

getEdges

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

Description copied from interface: BackendGraph

Return an immutable list of edges that match the criteria.

Specified by:

getEdges in interface BackendGraph

getEdges

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

Description copied from interface: BackendGraph

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

Specified by:

getEdges in interface BackendGraph

addEdgeListener

public void addEdgeListener(EdgeListener listener)

Specified by:

addEdgeListener in interface BackendGraph

removeEdgeListener

public void removeEdgeListener(EdgeListener listener)

Specified by:

removeEdgeListener in interface BackendGraph

clearEdges

public void clearEdges()

Specified by:

clearEdges in interface BackendGraph

getEdgeTotalCount

public int getEdgeTotalCount()

Specified by:

getEdgeTotalCount in interface BackendGraph

getEdgeIdsForVertex

public EdgeRef[] getEdgeIdsForVertex(VertexRef vertex)

Specified by:

getEdgeIdsForVertex in interface BackendGraph

getEdgeIdsForVertices

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

Description copied from interface: BackendGraph

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

Specified by:

getEdgeIdsForVertices in interface BackendGraph

addEdges

public void addEdges(Edge... edges)

Specified by:

addEdges in interface BackendGraph

removeEdges

public void removeEdges(EdgeRef... edges)

Specified by:

removeEdges in interface BackendGraph

connectVertices

public Edge connectVertices(String edgeId,
                            VertexRef sourceVertextId,
                            VertexRef targetVertextId)

Specified by:

connectVertices in interface BackendGraph

resetContainer

public void resetContainer()

Specified by:

resetContainer in interface BackendGraph

getNamespace

public String getNamespace()

Description copied from interface: NamespaceAware

A string used to identify references belonging to this provider May only contain characters that make for a reasonable Java identifier such as letters digits and underscore (no colons, periods, commas etc.)

Specified by:

getNamespace in interface NamespaceAware

Returns:

the namespace, e.g. "nodes".

contributesTo

public boolean contributesTo(String namespace)

Description copied from interface: NamespaceAware

Defines if the current implementation contributes to the given namespace. This is usually the case, when the given namespaces equals NamespaceAware.getNamespace(), but is not a requirement.

Specified by:

contributesTo in interface NamespaceAware

Parameters:

namespace - the namespace to contribute to

Returns:

true, if the current implementation contributes to the given namespace, otherwise false.