org.opennms.features.topology.app.internal

Class MergingGraphProvider

java.lang.Object

org.opennms.features.topology.app.internal.MergingGraphProvider

All Implemented Interfaces:

SelectionAware, EdgeListener, EdgeProvider, GraphProvider, VertexListener, VertexProvider, ProviderManager.ProviderListener

public class MergingGraphProvider
extends Object
implements GraphProvider, VertexListener, EdgeListener, ProviderManager.ProviderListener

Field Summary

Fields

Modifier and Type	Field and Description
static GraphProvider	NULL_PROVIDER

Constructor Summary

Constructors

Constructor and Description
MergingGraphProvider(ProviderManager providerManager)

Method Summary

Modifier and Type	Method and Description
void	addEdgeListener(EdgeListener edgeListener)
protected void	addEdgeProvider(EdgeProvider edgeProvider)
void	addEdges(Edge... edges)
Vertex	addGroup(String label, String iconKey) TODO Is this going to work properly?
Vertex	addVertex(int x, int y) TODO Is this going to work properly?
void	addVertexListener(VertexListener vertexListener)
protected void	addVertexProvider(VertexProvider vertexProvider)
void	addVertices(Vertex... vertices)
void	clearEdges()
void	clearVertices()
Edge	connectVertices(VertexRef sourceVertextId, VertexRef targetVertextId) TODO Is this going to work properly?
boolean	containsVertexId(String id)
boolean	containsVertexId(VertexRef id, Criteria... criteria)
boolean	contributesTo(ContentType type) Allows the GraphProvider to define if it contributes to a certain ContentType.
boolean	contributesTo(String namespace) This boolean returns true if the vertices in this provider are intended to contribute to or overlay another namespace
void	edgeProviderAdded(EdgeProvider oldProvider, EdgeProvider newProvider)
void	edgeProviderRemoved(EdgeProvider removedProvider)
void	edgeSetChanged(EdgeProvider provider)
void	edgeSetChanged(EdgeProvider provider, Collection<? extends Edge> added, Collection<? extends Edge> updated, Collection<String> removedEdgeIds)
protected List<? extends Edge>	filteredEdges(EdgeProvider edgeProvider, Criteria[] criteria, boolean returnAllOnNullFilter)
protected List<? extends Vertex>	filteredVertices(VertexProvider vertexProvider, Criteria[] criteria, boolean returnAllOnNullFilter)
protected void	fireEdgeChanged()
protected void	fireVertexChanged()
protected GraphProvider	getBaseGraphProvider()
List<Vertex>	getChildren(VertexRef group, Criteria... criteria)
Criteria	getDefaultCriteria()
Edge	getEdge(EdgeRef reference)
Edge	getEdge(String namespace, String id)
EdgeRef[]	getEdgeIdsForVertex(VertexRef vertex) TODO This will miss edges provided by auxiliary edge providers
Map<VertexRef,Set<EdgeRef>>	getEdgeIdsForVertices(VertexRef... vertices) TODO This will miss edges provided by auxiliary edge providers
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.)
protected EdgeProvider	getEdgeProvider(EdgeRef edgeRef)
protected EdgeProvider	getEdgeProvider(String namespace)
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.
MetaInfo	getMetaInfo()
Vertex	getParent(VertexRef vertex)
List<Vertex>	getRootGroup()
SelectionChangedListener.Selection	getSelection(List<VertexRef> selectedVertices, ContentType type) Converts the provided selectedVertices to a Selection.
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.)
protected VertexProvider	getVertexProvider(String namespace)
protected VertexProvider	getVertexProvider(VertexRef vertexRef)
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	groupingSupported() TODO Is this going to work properly?
boolean	hasChildren(VertexRef group)
void	load(String filename)
void	refresh()
void	removeEdgeListener(EdgeListener edgeListener)
protected void	removeEdgeProvider(EdgeProvider edgeProvider)
void	removeEdges(EdgeRef... edges)
void	removeVertex(VertexRef... vertexId)
void	removeVertexListener(VertexListener vertexListener)
protected void	removeVertexProvider(VertexProvider vertexProvider)
void	resetContainer()
void	save()
protected void	setBaseGraphProvider(GraphProvider baseGraphProvider)
boolean	setParent(VertexRef vertexId, VertexRef parentId) This function will always delegate to the base graph provider.
void	vertexProviderAdded(VertexProvider oldProvider, VertexProvider newProvider)
void	vertexProviderRemoved(VertexProvider removedProvider)
void	vertexSetChanged(VertexProvider provider)
void	vertexSetChanged(VertexProvider provider, Collection<? extends Vertex> added, Collection<? extends Vertex> update, Collection<String> removedVertexIds)

Methods inherited from class java.lang.Object

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

Field Detail

NULL_PROVIDER

public static final GraphProvider NULL_PROVIDER

Constructor Detail

MergingGraphProvider

public MergingGraphProvider(ProviderManager providerManager)

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

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: 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 EdgeProvider

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.

getBaseGraphProvider

protected GraphProvider getBaseGraphProvider()

setBaseGraphProvider

protected void setBaseGraphProvider(GraphProvider baseGraphProvider)

addVertexProvider

protected void addVertexProvider(VertexProvider vertexProvider)

removeVertexProvider

protected void removeVertexProvider(VertexProvider vertexProvider)

addEdgeProvider

protected void addEdgeProvider(EdgeProvider edgeProvider)

removeEdgeProvider

protected void removeEdgeProvider(EdgeProvider edgeProvider)

getVertexProvider

protected VertexProvider getVertexProvider(String namespace)

getVertexProvider

protected VertexProvider getVertexProvider(VertexRef vertexRef)

getEdgeProvider

protected EdgeProvider getEdgeProvider(EdgeRef edgeRef)

getEdgeProvider

protected EdgeProvider getEdgeProvider(String namespace)

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

getSemanticZoomLevel

public int getSemanticZoomLevel(VertexRef vertex)

Specified by:

getSemanticZoomLevel in interface VertexProvider

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

filteredVertices

protected List<? extends Vertex> filteredVertices(VertexProvider vertexProvider,
                                                  Criteria[] criteria,
                                                  boolean returnAllOnNullFilter)

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

getChildren

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

Specified by:

getChildren in interface VertexProvider

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

filteredEdges

protected List<? extends Edge> filteredEdges(EdgeProvider edgeProvider,
                                             Criteria[] criteria,
                                             boolean returnAllOnNullFilter)

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

clearEdges

public void clearEdges()

Specified by:

clearEdges in interface EdgeProvider

addEdges

public void addEdges(Edge... edges)

Specified by:

addEdges in interface GraphProvider

groupingSupported

public boolean groupingSupported()

TODO Is this going to work properly?

Specified by:

groupingSupported in interface GraphProvider

addGroup

public Vertex addGroup(String label,
                       String iconKey)

TODO Is this going to work properly?

Specified by:

addGroup in interface GraphProvider

addVertex

public Vertex addVertex(int x,
                        int y)

TODO Is this going to work properly?

Specified by:

addVertex in interface GraphProvider

addVertices

public void addVertices(Vertex... vertices)

Specified by:

addVertices in interface GraphProvider

connectVertices

public Edge connectVertices(VertexRef sourceVertextId,
                            VertexRef targetVertextId)

TODO Is this going to work properly?

Specified by:

connectVertices in interface GraphProvider

getDefaultCriteria

public Criteria getDefaultCriteria()

Specified by:

getDefaultCriteria in interface GraphProvider

getEdgeIdsForVertex

public EdgeRef[] getEdgeIdsForVertex(VertexRef vertex)

TODO This will miss edges provided by auxiliary edge providers

Specified by:

getEdgeIdsForVertex in interface GraphProvider

getEdgeIdsForVertices

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

TODO This will miss edges provided by auxiliary edge providers

Specified by:

getEdgeIdsForVertices in interface GraphProvider

load

public void load(String filename)

Specified by:

load in interface GraphProvider

refresh

public void refresh()

Specified by:

refresh in interface GraphProvider

removeEdges

public void removeEdges(EdgeRef... edges)

Specified by:

removeEdges in interface GraphProvider

removeVertex

public void removeVertex(VertexRef... vertexId)

Specified by:

removeVertex in interface GraphProvider

resetContainer

public void resetContainer()

Specified by:

resetContainer in interface GraphProvider

save

public void save()

Specified by:

save in interface GraphProvider

setParent

public boolean setParent(VertexRef vertexId,
                         VertexRef parentId)

This function will always delegate to the base graph provider. It must be responsible for grouping.

Specified by:

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

Specified by:

containsVertexId in interface VertexProvider

containsVertexId

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

Specified by:

containsVertexId in interface VertexProvider

fireVertexChanged

protected void fireVertexChanged()

vertexSetChanged

public void vertexSetChanged(VertexProvider provider)

Specified by:

vertexSetChanged in interface VertexListener

vertexSetChanged

public void vertexSetChanged(VertexProvider provider,
                             Collection<? extends Vertex> added,
                             Collection<? extends Vertex> update,
                             Collection<String> removedVertexIds)

Specified by:

vertexSetChanged in interface VertexListener

addVertexListener

public void addVertexListener(VertexListener vertexListener)

Specified by:

addVertexListener in interface VertexProvider

removeVertexListener

public void removeVertexListener(VertexListener vertexListener)

Specified by:

removeVertexListener in interface VertexProvider

fireEdgeChanged

protected void fireEdgeChanged()

edgeSetChanged

public void edgeSetChanged(EdgeProvider provider)

Specified by:

edgeSetChanged in interface EdgeListener

edgeSetChanged

public void edgeSetChanged(EdgeProvider provider,
                           Collection<? extends Edge> added,
                           Collection<? extends Edge> updated,
                           Collection<String> removedEdgeIds)

Specified by:

edgeSetChanged in interface EdgeListener

addEdgeListener

public void addEdgeListener(EdgeListener edgeListener)

Specified by:

addEdgeListener in interface EdgeProvider

removeEdgeListener

public void removeEdgeListener(EdgeListener edgeListener)

Specified by:

removeEdgeListener in interface EdgeProvider

getSelection

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

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.

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

edgeProviderAdded

public void edgeProviderAdded(EdgeProvider oldProvider,
                              EdgeProvider newProvider)

Specified by:

edgeProviderAdded in interface ProviderManager.ProviderListener

edgeProviderRemoved

public void edgeProviderRemoved(EdgeProvider removedProvider)

Specified by:

edgeProviderRemoved in interface ProviderManager.ProviderListener

vertexProviderAdded

public void vertexProviderAdded(VertexProvider oldProvider,
                                VertexProvider newProvider)

Specified by:

vertexProviderAdded in interface ProviderManager.ProviderListener

vertexProviderRemoved

public void vertexProviderRemoved(VertexProvider removedProvider)

Specified by:

vertexProviderRemoved in interface ProviderManager.ProviderListener

getMetaInfo

public MetaInfo getMetaInfo()

Specified by:

getMetaInfo in interface GraphProvider