org.opennms.features.topology.api.support

Class VertexHopGraphProvider

java.lang.Object

org.opennms.features.topology.api.support.VertexHopGraphProvider

All Implemented Interfaces:

SelectionAware, EdgeProvider, GraphProvider, VertexProvider

public class VertexHopGraphProvider
extends Object
implements GraphProvider, SelectionAware

This class will be used to filter a topology so that the semantic zoom level is interpreted as a hop distance away from a set of selected vertices. The vertex selection is specified using sets of VertexHopGraphProvider.VertexHopCriteria filters.

Author:

Seth

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VertexHopGraphProvider.DefaultVertexHopCriteria Helper criteria class to reference to existing VertexRefs.
static class	VertexHopGraphProvider.VertexHopCriteria
static class	VertexHopGraphProvider.WrappedVertexHopCriteria Wrapper class to wrap a bunch of VertexHopGraphProvider.VertexHopCriteria.

Constructor Summary

Constructors

Constructor and Description
VertexHopGraphProvider(GraphProvider delegate)

Method Summary

Modifier and Type	Method and Description
void	addEdgeListener(EdgeListener listener)
void	addEdges(Edge... edges)
Vertex	addGroup(String label, String iconKey)
Vertex	addVertex(int x, int y)
void	addVertexListener(VertexListener vertexListener)
void	addVertices(Vertex... vertices)
void	clearEdges()
void	clearVertices()
static Set<Edge>	collapseEdges(Set<Edge> edges, CollapsibleCriteria[] criteria) This function assumes that all criteria passed in are marked as collapsed.
static Set<Vertex>	collapseVertices(Set<Vertex> vertices, CollapsibleCriteria[] criteria)
Edge	connectVertices(VertexRef sourceVertextId, VertexRef targetVertextId)
boolean	containsVertexId(String id) Deprecated.
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
List<Vertex>	getChildren(VertexRef group, Criteria... criteria)
static CollapsibleCriteria[]	getCollapsedCriteria(Criteria[] criteria)
static CollapsibleCriteria[]	getCollapsedCriteriaForContainer(GraphContainer graphContainer)
static CollapsibleCriteria[]	getCollapsibleCriteria(Criteria[] criteria)
static CollapsibleCriteria[]	getCollapsibleCriteria(Criteria[] criteria, boolean onlyCollapsed)
static CollapsibleCriteria[]	getCollapsibleCriteriaForContainer(GraphContainer graphContainer)
Defaults	getDefaults()
Edge	getEdge(EdgeRef reference)
Edge	getEdge(String namespace, String id)
EdgeRef[]	getEdgeIdsForVertex(VertexRef vertex)
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.)
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.
Set<VertexRef>	getFocusNodes(Criteria... criteria)
static Map<VertexRef,Set<Vertex>>	getMapOfVerticesToCollapsedVertices(CollapsibleCriteria[] criteria)
int	getMaxSemanticZoomLevel(Criteria... criteria)
Vertex	getParent(VertexRef vertex)
List<Vertex>	getRootGroup() TODO: Is this correct?
SelectionChangedListener.Selection	getSelection(List<VertexRef> selectedVertices, ContentType type) Converts the provided selectedVertices to a Selection.
int	getSemanticZoomLevel(VertexRef vertex)
TopologyProviderInfo	getTopologyProviderInfo()
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.
static VertexHopGraphProvider.WrappedVertexHopCriteria	getWrappedVertexHopCriteria(GraphContainer graphContainer)
boolean	groupingSupported() This function indicates support for (mostly legacy) grouping operations.
boolean	hasChildren(VertexRef group)
void	load(String filename)
void	refresh()
void	removeEdgeListener(EdgeListener listener)
void	removeEdges(EdgeRef... edges)
void	removeVertex(VertexRef... vertexId)
void	removeVertexListener(VertexListener vertexListener)
void	resetContainer()
void	save()
boolean	setParent(VertexRef child, VertexRef parent)

Methods inherited from class java.lang.Object

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

Constructor Detail

VertexHopGraphProvider

public VertexHopGraphProvider(GraphProvider delegate)

Method Detail

getWrappedVertexHopCriteria

public static VertexHopGraphProvider.WrappedVertexHopCriteria getWrappedVertexHopCriteria(GraphContainer graphContainer)

getCollapsedCriteriaForContainer

public static CollapsibleCriteria[] getCollapsedCriteriaForContainer(GraphContainer graphContainer)

getCollapsedCriteria

public static CollapsibleCriteria[] getCollapsedCriteria(Criteria[] criteria)

getCollapsibleCriteriaForContainer

public static CollapsibleCriteria[] getCollapsibleCriteriaForContainer(GraphContainer graphContainer)

getCollapsibleCriteria

public static CollapsibleCriteria[] getCollapsibleCriteria(Criteria[] criteria)

getCollapsibleCriteria

public static CollapsibleCriteria[] getCollapsibleCriteria(Criteria[] criteria,
                                                           boolean onlyCollapsed)

save

public void save()

Specified by:

save in interface GraphProvider

load

public void load(String filename)
          throws MalformedURLException,
                 JAXBException

Specified by:

load in interface GraphProvider

Throws:

MalformedURLException

JAXBException

refresh

public void refresh()

Specified by:

refresh in interface GraphProvider

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

containsVertexId

@Deprecated
public boolean containsVertexId(String id)

Deprecated.

Specified by:

containsVertexId in interface VertexProvider

containsVertexId

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

Specified by:

containsVertexId in interface VertexProvider

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

getFocusNodes

public Set<VertexRef> getFocusNodes(Criteria... criteria)

getMaxSemanticZoomLevel

public int getMaxSemanticZoomLevel(Criteria... criteria)

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

collapseVertices

public static Set<Vertex> collapseVertices(Set<Vertex> vertices,
                                           CollapsibleCriteria[] criteria)

getMapOfVerticesToCollapsedVertices

public static Map<VertexRef,Set<Vertex>> getMapOfVerticesToCollapsedVertices(CollapsibleCriteria[] criteria)

collapseEdges

public static Set<Edge> collapseEdges(Set<Edge> edges,
                                      CollapsibleCriteria[] criteria)

This function assumes that all criteria passed in are marked as collapsed.

Parameters:

edges -

criteria -

Returns:

getVertices

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

Specified by:

getVertices in interface VertexProvider

getRootGroup

public List<Vertex> getRootGroup()

TODO: Is this correct?

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

clearVertices

public void clearVertices()

Specified by:

clearVertices in interface VertexProvider

getVertexTotalCount

public int getVertexTotalCount()

Specified by:

getVertexTotalCount 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

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

resetContainer

public void resetContainer()

Specified by:

resetContainer in interface GraphProvider

addVertices

public void addVertices(Vertex... vertices)

Specified by:

addVertices in interface GraphProvider

removeVertex

public void removeVertex(VertexRef... vertexId)

Specified by:

removeVertex in interface GraphProvider

addVertex

public Vertex addVertex(int x,
                        int y)

Specified by:

addVertex in interface GraphProvider

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 Vertex addGroup(String label,
                       String iconKey)

Specified by:

addGroup in interface GraphProvider

getEdgeIdsForVertex

public EdgeRef[] getEdgeIdsForVertex(VertexRef vertex)

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

addEdges

public void addEdges(Edge... edges)

Specified by:

addEdges in interface GraphProvider

removeEdges

public void removeEdges(EdgeRef... edges)

Specified by:

removeEdges in interface GraphProvider

connectVertices

public Edge connectVertices(VertexRef sourceVertextId,
                            VertexRef targetVertextId)

Specified by:

connectVertices in interface GraphProvider

getDefaults

public Defaults getDefaults()

Specified by:

getDefaults in interface GraphProvider

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

getTopologyProviderInfo

public TopologyProviderInfo getTopologyProviderInfo()

Specified by:

getTopologyProviderInfo in interface GraphProvider