org.opennms.features.topology.plugins.topo.simple

Class SimpleGraphProvider

java.lang.Object

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

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

org.opennms.features.topology.plugins.topo.simple.SimpleGraphProvider

All Implemented Interfaces:

SelectionAware, EdgeProvider, GraphProvider, VertexProvider

Direct Known Subclasses:

VmwareTopologyProvider

public class SimpleGraphProvider
extends AbstractTopologyProvider
implements GraphProvider

Nested Class Summary

Nested classes/interfaces inherited from class org.opennms.features.topology.api.topo.AbstractTopologyProvider

AbstractTopologyProvider.IdGenerator

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	TOPOLOGY_NAMESPACE_SIMPLE

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

metaInfo, SIMPLE_EDGE_ID_PREFIX, SIMPLE_GROUP_ID_PREFIX, SIMPLE_VERTEX_ID_PREFIX

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

m_edgeProvider, m_vertexProvider

Constructor Summary

Constructors

Constructor and Description
SimpleGraphProvider()
SimpleGraphProvider(String namespace)

Method Summary

Modifier and Type	Method and Description
boolean	contributesTo(ContentType type) Allows the GraphProvider to define if it contributes to a certain ContentType.
Criteria	getDefaultCriteria()
SelectionChangedListener.Selection	getSelection(List<VertexRef> selectedVertices, ContentType contentType) Converts the provided selectedVertices to a Selection.
protected SelectionChangedListener.Selection	getSelection(String namespace, List<VertexRef> selectedVertices, ContentType type)
URI	getTopologyLocation()
void	load(String filename)
void	refresh()
void	save()
void	save(String filename)
void	setTopologyLocation(URI topologyLocation)

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

addEdges, addGroup, addGroup, addVertex, addVertex, addVertices, clearCounters, connectVertices, connectVertices, getEdgeIdsForVertex, getEdgeIdsForVertices, getGroups, getMetaInfo, getNextEdgeId, getNextGroupId, getNextVertexId, getVerticesWithoutGroups, groupingSupported, removeEdges, removeVertex, resetContainer, setMetaInfo

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

addEdges, addGroup, addVertex, addVertices, connectVertices, getEdgeIdsForVertex, getEdgeIdsForVertices, getMetaInfo, groupingSupported, removeEdges, removeVertex, resetContainer

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

TOPOLOGY_NAMESPACE_SIMPLE

protected static final String TOPOLOGY_NAMESPACE_SIMPLE

See Also:

Constant Field Values

Constructor Detail

SimpleGraphProvider

public SimpleGraphProvider()

SimpleGraphProvider

public SimpleGraphProvider(String namespace)

Method Detail

getTopologyLocation

public URI getTopologyLocation()

setTopologyLocation

public void setTopologyLocation(URI topologyLocation)
                         throws MalformedURLException,
                                JAXBException

Throws:

MalformedURLException

JAXBException

save

public void save(String filename)
          throws MalformedURLException,
                 JAXBException

Throws:

MalformedURLException

JAXBException

save

public void save()

Specified by:

save in interface GraphProvider

Specified by:

save in class AbstractTopologyProvider

refresh

public void refresh()

Specified by:

refresh in interface GraphProvider

Specified by:

refresh in class AbstractTopologyProvider

getDefaultCriteria

public Criteria getDefaultCriteria()

Specified by:

getDefaultCriteria in interface GraphProvider

load

public void load(String filename)
          throws MalformedURLException,
                 JAXBException

Specified by:

load in interface GraphProvider

Specified by:

load in class AbstractTopologyProvider

Throws:

MalformedURLException

JAXBException

getSelection

protected SelectionChangedListener.Selection getSelection(String namespace,
                                                          List<VertexRef> selectedVertices,
                                                          ContentType type)

getSelection

public SelectionChangedListener.Selection getSelection(List<VertexRef> selectedVertices,
                                                       ContentType contentType)

Description copied from interface: SelectionAware

Converts the provided selectedVertices to a Selection. The provided type represents the according browser table. This method is only invoked if SelectionAware.contributesTo(ContentType) returns to for the provided type

Specified by:

getSelection in interface SelectionAware

Parameters:

selectedVertices - The vertices currently selected in the Topology UI.

contentType - The type to filter for. Represents the according browser table.

Returns:

The selection containing the List of Restrictions. Must NOT be null.

See Also:

SelectionChangedListener.Selection

contributesTo

public boolean contributesTo(ContentType type)

Description copied from interface: SelectionAware

Allows the GraphProvider to define if it contributes to a certain ContentType. If false it is not shown in the browsers tab at all

Specified by:

contributesTo in interface SelectionAware

Parameters:

type - The type to check if this contribute to

Returns:

true if this contributes to the provided type