org.opennms.features.topology.api.topo

Class DelegatingVertexEdgeProvider

java.lang.Object

org.opennms.features.topology.api.topo.DelegatingVertexEdgeProvider

All Implemented Interfaces:

EdgeProvider, VertexProvider

Direct Known Subclasses:

AbstractTopologyProvider

public class DelegatingVertexEdgeProvider
extends Object
implements VertexProvider, EdgeProvider

Field Summary

Fields

Modifier and Type	Field and Description
protected SimpleEdgeProvider	m_edgeProvider
protected SimpleVertexProvider	m_vertexProvider

Constructor Summary

Constructors

Constructor and Description
DelegatingVertexEdgeProvider(SimpleVertexProvider vertexProvider, SimpleEdgeProvider edgeProvider)
DelegatingVertexEdgeProvider(String namespace)
DelegatingVertexEdgeProvider(String vertexNamespace, String edgeNamespace)

Method Summary

Modifier and Type	Method and Description
void	addEdgeListener(EdgeListener listener)
void	addVertexListener(VertexListener vertexListener)
void	clearEdges()
void	clearVertices()
boolean	containsVertexId(String id)
boolean	containsVertexId(VertexRef id, Criteria... criteria)
boolean	contributesTo(String namespace) This boolean returns true if the vertices in this provider are intended to contribute to or overlay another namespace
List<Vertex>	getChildren(VertexRef group, Criteria... criteria)
Edge	getEdge(EdgeRef reference)
Edge	getEdge(String namespace, String id)
String	getEdgeNamespace() A string used to identify references belonging to this provider May only container characters that make for a reasonable java identifier such as letters digits and underscore (no colons, periods, commans etc.)
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.
Vertex	getParent(VertexRef vertex)
List<Vertex>	getRootGroup()
int	getSemanticZoomLevel(VertexRef vertex)
protected SimpleEdgeProvider	getSimpleEdgeProvider()
protected SimpleVertexProvider	getSimpleVertexProvider()
Vertex	getVertex(String namespace, String id)
Vertex	getVertex(VertexRef reference, Criteria... criteria)
String	getVertexNamespace() 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	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.
boolean	hasChildren(VertexRef group)
void	removeEdgeListener(EdgeListener listener)
void	removeVertexListener(VertexListener vertexListener)
boolean	setParent(VertexRef child, VertexRef parent)

Methods inherited from class java.lang.Object

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

Field Detail

m_vertexProvider

protected SimpleVertexProvider m_vertexProvider

m_edgeProvider

protected SimpleEdgeProvider m_edgeProvider

Constructor Detail

DelegatingVertexEdgeProvider

public DelegatingVertexEdgeProvider(String namespace)

DelegatingVertexEdgeProvider

public DelegatingVertexEdgeProvider(String vertexNamespace,
                                    String edgeNamespace)

DelegatingVertexEdgeProvider

public DelegatingVertexEdgeProvider(SimpleVertexProvider vertexProvider,
                                    SimpleEdgeProvider edgeProvider)

Method Detail

getSimpleVertexProvider

protected final SimpleVertexProvider getSimpleVertexProvider()

getSimpleEdgeProvider

protected final SimpleEdgeProvider getSimpleEdgeProvider()

addVertexListener

public final void addVertexListener(VertexListener vertexListener)

Specified by:

addVertexListener in interface VertexProvider

clearVertices

public final void clearVertices()

Specified by:

clearVertices in interface VertexProvider

getVertexTotalCount

public int getVertexTotalCount()

Specified by:

getVertexTotalCount in interface VertexProvider

contributesTo

public final boolean contributesTo(String namespace)

Description copied from interface: VertexProvider

This boolean returns true if the vertices in this provider are intended to contribute to or overlay another namespace

Specified by:

contributesTo in interface EdgeProvider

Specified by:

contributesTo in interface VertexProvider

Parameters:

namespace - the namespace of a provider

Returns:

true if this provider contributes the the given namespace, false otherwise. Should return false when passing in its own namepace. A provider doesn't contribute to itself.

containsVertexId

public boolean containsVertexId(String id)

Specified by:

containsVertexId in interface VertexProvider

containsVertexId

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

Specified by:

containsVertexId in interface VertexProvider

getChildren

public final List<Vertex> getChildren(VertexRef group,
                                      Criteria... criteria)

Specified by:

getChildren in interface VertexProvider

getVertexNamespace

public final String getVertexNamespace()

Description copied from interface: VertexProvider

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:

getVertexNamespace in interface VertexProvider

getParent

public final Vertex getParent(VertexRef vertex)

Specified by:

getParent in interface VertexProvider

getRootGroup

public final List<Vertex> getRootGroup()

Specified by:

getRootGroup in interface VertexProvider

getSemanticZoomLevel

public final int getSemanticZoomLevel(VertexRef vertex)

Specified by:

getSemanticZoomLevel in interface VertexProvider

getVertex

public final Vertex getVertex(String namespace,
                              String id)

Specified by:

getVertex in interface VertexProvider

getVertex

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

Specified by:

getVertex in interface VertexProvider

getVertices

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

Description copied from interface: VertexProvider

Return an immutable list of vertices that match the criteria.

Specified by:

getVertices in interface VertexProvider

getVertices

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

Specified by:

getVertices in interface VertexProvider

hasChildren

public final boolean hasChildren(VertexRef group)

Specified by:

hasChildren in interface VertexProvider

removeVertexListener

public final void removeVertexListener(VertexListener vertexListener)

Specified by:

removeVertexListener in interface VertexProvider

setParent

public final boolean setParent(VertexRef child,
                               VertexRef parent)

Specified by:

setParent in interface VertexProvider

addEdgeListener

public final void addEdgeListener(EdgeListener listener)

Specified by:

addEdgeListener in interface EdgeProvider

clearEdges

public final void clearEdges()

Specified by:

clearEdges in interface EdgeProvider

getEdge

public final Edge getEdge(String namespace,
                          String id)

Specified by:

getEdge in interface EdgeProvider

getEdge

public final Edge getEdge(EdgeRef reference)

Specified by:

getEdge in interface EdgeProvider

getEdgeNamespace

public final String getEdgeNamespace()

Description copied from interface: EdgeProvider

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

Specified by:

getEdgeNamespace in interface EdgeProvider

getEdges

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

Description copied from interface: EdgeProvider

Return an immutable list of edges that match the criteria.

Specified by:

getEdges in interface EdgeProvider

getEdges

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

Description copied from interface: EdgeProvider

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

Specified by:

getEdges in interface EdgeProvider

removeEdgeListener

public final void removeEdgeListener(EdgeListener listener)

Specified by:

removeEdgeListener in interface EdgeProvider