org.opennms.features.topology.api.topo

Class AbstractTopologyProvider

java.lang.Object

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

org.opennms.features.topology.api.topo.AbstractTopologyProvider

All Implemented Interfaces:

EdgeProvider, GraphProvider, VertexProvider

Direct Known Subclasses:

AbstractLinkdTopologyProvider, OnmsTopologyProvider, SFreeTopologyProvider, SimpleGraphProvider

public abstract class AbstractTopologyProvider
extends DelegatingVertexEdgeProvider
implements GraphProvider

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractTopologyProvider.IdGenerator This class generates an unique id.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	SIMPLE_EDGE_ID_PREFIX
protected static String	SIMPLE_GROUP_ID_PREFIX
protected static String	SIMPLE_VERTEX_ID_PREFIX

Fields inherited from class org.opennms.features.topology.api.topo.DelegatingVertexEdgeProvider

m_edgeProvider, m_vertexProvider

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractTopologyProvider(String namespace)

Method Summary

Modifier and Type	Method and Description
void	addEdges(Edge... edges)
AbstractVertex	addGroup(String groupName, String groupIconKey)
protected AbstractVertex	addGroup(String groupId, String iconKey, String label)
AbstractVertex	addVertex(int x, int y)
protected AbstractVertex	addVertex(String id, int x, int y)
void	addVertices(Vertex... vertices)
protected void	clearCounters()
protected AbstractEdge	connectVertices(String id, VertexRef sourceId, VertexRef targetId, String namespace)
Edge	connectVertices(VertexRef sourceVertextId, VertexRef targetVertextId)
EdgeRef[]	getEdgeIdsForVertex(VertexRef vertex)
Map<VertexRef,Set<EdgeRef>>	getEdgeIdsForVertices(VertexRef... vertices) This function can be used for efficiency when you need the EdgeRef instances for a large number of vertices.
List<Vertex>	getGroups()
protected String	getNextEdgeId()
protected String	getNextGroupId()
protected String	getNextVertexId()
List<Vertex>	getVerticesWithoutGroups()
boolean	groupingSupported() This function indicates support for (mostly legacy) grouping operations.
abstract void	load(String filename)
abstract void	refresh()
void	removeEdges(EdgeRef... edge)
void	removeVertex(VertexRef... vertexId)
void	resetContainer()
abstract void	save()

Methods inherited from class org.opennms.features.topology.api.topo.DelegatingVertexEdgeProvider

addEdgeListener, addVertexListener, clearEdges, clearVertices, containsVertexId, containsVertexId, contributesTo, getChildren, getEdge, getEdge, getEdgeNamespace, getEdges, getEdges, getParent, getRootGroup, getSemanticZoomLevel, getSimpleEdgeProvider, getSimpleVertexProvider, getVertex, getVertex, getVertexNamespace, getVertexTotalCount, getVertices, getVertices, hasChildren, removeEdgeListener, removeVertexListener, setParent

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opennms.features.topology.api.topo.GraphProvider

getDefaultCriteria

Methods inherited from interface org.opennms.features.topology.api.topo.VertexProvider

addVertexListener, clearVertices, containsVertexId, containsVertexId, contributesTo, getChildren, getParent, getRootGroup, getSemanticZoomLevel, getVertex, getVertex, getVertexNamespace, getVertexTotalCount, getVertices, getVertices, hasChildren, removeVertexListener, setParent

Methods inherited from interface org.opennms.features.topology.api.topo.EdgeProvider

addEdgeListener, clearEdges, contributesTo, getEdge, getEdge, getEdgeNamespace, getEdges, getEdges, removeEdgeListener

Field Detail

SIMPLE_VERTEX_ID_PREFIX

protected static final String SIMPLE_VERTEX_ID_PREFIX

See Also:

Constant Field Values

SIMPLE_GROUP_ID_PREFIX

protected static final String SIMPLE_GROUP_ID_PREFIX

See Also:

Constant Field Values

SIMPLE_EDGE_ID_PREFIX

protected static final String SIMPLE_EDGE_ID_PREFIX

See Also:

Constant Field Values

Constructor Detail

AbstractTopologyProvider

protected AbstractTopologyProvider(String namespace)

Method Detail

getNextVertexId

protected String getNextVertexId()

getNextGroupId

protected String getNextGroupId()

getNextEdgeId

protected String getNextEdgeId()

getVerticesWithoutGroups

public List<Vertex> getVerticesWithoutGroups()

getGroups

public List<Vertex> getGroups()

removeVertex

public final void removeVertex(VertexRef... vertexId)

Specified by:

removeVertex in interface GraphProvider

addVertices

public final void addVertices(Vertex... vertices)

Specified by:

addVertices in interface GraphProvider

addVertex

public final AbstractVertex addVertex(int x,
                                      int y)

Specified by:

addVertex in interface GraphProvider

addVertex

protected final AbstractVertex addVertex(String id,
                                         int x,
                                         int y)

groupingSupported

public boolean groupingSupported()

Description copied from interface: GraphProvider

This function indicates support for (mostly legacy) grouping operations. If true then addGroup() should work as expected.

Specified by:

groupingSupported in interface GraphProvider

addGroup

public final AbstractVertex addGroup(String groupName,
                                     String groupIconKey)

Specified by:

addGroup in interface GraphProvider

addGroup

protected final AbstractVertex addGroup(String groupId,
                                        String iconKey,
                                        String label)

addEdges

public final void addEdges(Edge... edges)

Specified by:

addEdges in interface GraphProvider

removeEdges

public final void removeEdges(EdgeRef... edge)

Specified by:

removeEdges in interface GraphProvider

getEdgeIdsForVertex

public final EdgeRef[] getEdgeIdsForVertex(VertexRef vertex)

Specified by:

getEdgeIdsForVertex in interface GraphProvider

getEdgeIdsForVertices

public final Map<VertexRef,Set<EdgeRef>> getEdgeIdsForVertices(VertexRef... vertices)

Description copied from interface: GraphProvider

This function can be used for efficiency when you need the EdgeRef instances for a large number of vertices.

Specified by:

getEdgeIdsForVertices in interface GraphProvider

connectVertices

public Edge connectVertices(VertexRef sourceVertextId,
                            VertexRef targetVertextId)

Specified by:

connectVertices in interface GraphProvider

connectVertices

protected final AbstractEdge connectVertices(String id,
                                             VertexRef sourceId,
                                             VertexRef targetId,
                                             String namespace)

resetContainer

public void resetContainer()

Specified by:

resetContainer in interface GraphProvider

clearCounters

protected void clearCounters()

save

public abstract void save()

Specified by:

save in interface GraphProvider

load

public abstract void load(String filename)
                   throws MalformedURLException,
                          JAXBException

Specified by:

load in interface GraphProvider

Throws:

MalformedURLException

JAXBException

refresh

public abstract void refresh()

Specified by:

refresh in interface GraphProvider