org.opennms.features.topology.api.topo

Class SimpleVertexProvider

java.lang.Object

org.opennms.features.topology.api.topo.SimpleVertexProvider

All Implemented Interfaces:

VertexProvider

public class SimpleVertexProvider
extends Object
implements VertexProvider

Constructor Summary

Constructors

Constructor and Description
SimpleVertexProvider(String namespace)

Method Summary

Methods

Modifier and Type	Method and Description
void	add(Collection<Vertex> vertices)
void	add(Vertex... vertices)
void	addVertexListener(VertexListener vertexListener)
void	clearVertices()
boolean	containsVertexId(String id) Deprecated. You should search by the namespace and ID tuple instead
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)
Vertex	getParent(VertexRef vertex)
List<Vertex>	getRootGroup()
int	getSemanticZoomLevel(VertexRef vertex)
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	remove(List<VertexRef> vertices)
void	remove(VertexRef... vertices)
void	removeVertexListener(VertexListener vertexListener)
boolean	setParent(VertexRef child, VertexRef parent)
void	setVertices(List<Vertex> vertices)

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleVertexProvider

public SimpleVertexProvider(String namespace)

Method Detail

getVertexNamespace

public 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

contributesTo

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

getVertex

public Vertex getVertex(String namespace,
               String id)

Specified by:

getVertex in interface VertexProvider

getVertex

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

Specified by:

getVertex in interface VertexProvider

getVertices

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

Specified by:

getVertices in interface VertexProvider

getRootGroup

public List<Vertex> getRootGroup()

Specified by:

getRootGroup in interface VertexProvider

hasChildren

public boolean hasChildren(VertexRef group)

Specified by:

hasChildren in interface VertexProvider

getParent

public Vertex getParent(VertexRef vertex)

Specified by:

getParent in interface VertexProvider

setParent

public boolean setParent(VertexRef child,
                VertexRef parent)

Specified by:

setParent in interface VertexProvider

getChildren

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

Specified by:

getChildren in interface VertexProvider

addVertexListener

public void addVertexListener(VertexListener vertexListener)

Specified by:

addVertexListener in interface VertexProvider

removeVertexListener

public void removeVertexListener(VertexListener vertexListener)

Specified by:

removeVertexListener in interface VertexProvider

setVertices

public void setVertices(List<Vertex> vertices)

add

public void add(Vertex... vertices)

add

public void add(Collection<Vertex> vertices)

remove

public void remove(List<VertexRef> vertices)

remove

public void remove(VertexRef... vertices)

getVertices

public 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

getSemanticZoomLevel

public int getSemanticZoomLevel(VertexRef vertex)

Specified by:

getSemanticZoomLevel in interface VertexProvider

clearVertices

public void clearVertices()

Specified by:

clearVertices in interface VertexProvider

getVertexTotalCount

public int getVertexTotalCount()

Specified by:

getVertexTotalCount in interface VertexProvider

containsVertexId

public boolean containsVertexId(String id)

Deprecated. You should search by the namespace and ID tuple instead

Specified by:

containsVertexId in interface VertexProvider

containsVertexId

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

Specified by:

containsVertexId in interface VertexProvider