org.opennms.features.topology.api.topo

Interface EdgeProvider

All Known Subinterfaces:

GraphProvider

All Known Implementing Classes:

AbstractLinkdTopologyProvider, AbstractTopologyProvider, DelegatingVertexEdgeProvider, EdgeProviderMapImpl, EnhancedLinkdTopologyProvider, IsisEdgeProvider, LinkdTopologyProvider, MergingGraphProvider, NCSEdgeProvider, NCSPathEdgeProvider, NodeACLVertexProvider, OnmsTopologyProvider, OspfEdgeProvider, SFreeTopologyProvider, SimpleEdgeProvider, SimpleGraphProvider, VertexHopGraphProvider, VmwareTopologyProvider

public interface EdgeProvider

Method Summary

Methods

Modifier and Type	Method and Description
void	addEdgeListener(EdgeListener listener)
void	clearEdges()
boolean	contributesTo(String namespace) This boolean returns true if the edges in this provider are intended to contribute to or overlay another namespace
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.
void	removeEdgeListener(EdgeListener listener)

Method Detail

getEdgeNamespace

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

contributesTo

boolean contributesTo(String namespace)

This boolean returns true if the edges 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

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