org.opennms.features.topology.plugins.ncs

Class NCSPathEdgeProvider

java.lang.Object

org.opennms.features.topology.plugins.ncs.NCSPathEdgeProvider

All Implemented Interfaces:

EdgeProvider

public class NCSPathEdgeProvider
extends Object
implements EdgeProvider

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NCSPathEdgeProvider.NCSPathEdge
static class	NCSPathEdgeProvider.NCSServicePathCriteria

Field Summary

Fields

Modifier and Type	Field and Description
static String	PATH_NAMESPACE

Constructor Summary

Constructors

Constructor and Description
NCSPathEdgeProvider()

Method Summary

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)

Methods inherited from class java.lang.Object

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

Field Detail

PATH_NAMESPACE

public static final String PATH_NAMESPACE

See Also:

Constant Field Values

Constructor Detail

NCSPathEdgeProvider

public NCSPathEdgeProvider()

Method Detail

getEdgeNamespace

public 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

contributesTo

public boolean contributesTo(String namespace)

Description copied from interface: EdgeProvider

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

Specified by:

contributesTo in interface EdgeProvider

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

public Edge getEdge(String namespace,
                    String id)

Specified by:

getEdge in interface EdgeProvider

getEdge

public Edge getEdge(EdgeRef reference)

Specified by:

getEdge in interface EdgeProvider

getEdges

public 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 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

addEdgeListener

public void addEdgeListener(EdgeListener listener)

Specified by:

addEdgeListener in interface EdgeProvider

removeEdgeListener

public void removeEdgeListener(EdgeListener listener)

Specified by:

removeEdgeListener in interface EdgeProvider

clearEdges

public void clearEdges()

Specified by:

clearEdges in interface EdgeProvider