org.opennms.features.topology.api.topo

Interface VertexProvider

All Known Subinterfaces:

GraphProvider

All Known Implementing Classes:

AbstractTopologyProvider, DelegatingVertexEdgeProvider, LinkdTopologyProvider, MergingGraphProvider, OnmsTopologyProvider, SFreeTopologyProvider, SimpleGraphProvider, SimpleVertexProvider, VmwareTopologyProvider

public interface VertexProvider

Method Summary

Methods

Modifier and Type	Method and Description
void	addVertexListener(VertexListener vertexListener)
void	clearVertices()
boolean	containsVertexId(String id) Deprecated. Use containsVertexId(VertexRef id) instead.
boolean	containsVertexId(VertexRef id)
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)
Vertex	getParent(VertexRef vertex)
List<Vertex>	getRootGroup()
int	getSemanticZoomLevel(VertexRef vertex)
Vertex	getVertex(String namespace, String id)
Vertex	getVertex(VertexRef reference)
String	getVertexNamespace() 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<Vertex>	getVertices()
List<Vertex>	getVertices(Collection<? extends VertexRef> references)
List<Vertex>	getVertices(Criteria criteria) Return an immutable list of vertices that match the criteria.
boolean	hasChildren(VertexRef group)
void	removeVertexListener(VertexListener vertexListener)
boolean	setParent(VertexRef child, VertexRef parent)

Method Detail

getVertexNamespace

String getVertexNamespace()

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.)

contributesTo

boolean contributesTo(String namespace)

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

Parameters:

namespace - the namespace of a provider

Returns:

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

containsVertexId

boolean containsVertexId(String id)

Deprecated. Use containsVertexId(VertexRef id) instead.

containsVertexId

boolean containsVertexId(VertexRef id)

getVertex

Vertex getVertex(String namespace,
               String id)

getVertex

Vertex getVertex(VertexRef reference)

getSemanticZoomLevel

int getSemanticZoomLevel(VertexRef vertex)

getVertices

List<Vertex> getVertices(Criteria criteria)

Return an immutable list of vertices that match the criteria.

getVertices

List<Vertex> getVertices()

getVertices

List<Vertex> getVertices(Collection<? extends VertexRef> references)

getRootGroup

List<Vertex> getRootGroup()

hasChildren

boolean hasChildren(VertexRef group)

getParent

Vertex getParent(VertexRef vertex)

setParent

boolean setParent(VertexRef child,
                VertexRef parent)

getChildren

List<Vertex> getChildren(VertexRef group)

addVertexListener

void addVertexListener(VertexListener vertexListener)

removeVertexListener

void removeVertexListener(VertexListener vertexListener)

clearVertices

void clearVertices()