Package org.opennms.features.topology.plugins.topo.graphml

Class GraphMLSearchProvider

java.lang.Object

org.opennms.features.topology.api.topo.AbstractSearchProvider

org.opennms.features.topology.api.topo.simple.SimpleSearchProvider

org.opennms.features.topology.plugins.topo.graphml.GraphMLSearchProvider

All Implemented Interfaces:

SearchProvider

public class GraphMLSearchProvider
extends SimpleSearchProvider

SearchProvider for GraphML definitions. The provider searches for matching vertices in ALL graphs, not only the current visible one.

Constructor Summary

Constructors

Constructor	Description
GraphMLSearchProvider(GraphMLTopologyProvider graphMLTopologyProvider)

Method Summary

Modifier and Type	Method	Description
boolean	contributesTo(String namespace)	In GraphML graphs the namespace of each graph contained in the GraphML file should be prefixed, e.g.
String	getSearchProviderNamespace()	This is a namespace for search providers...
void	onFocusSearchResult(SearchResult searchResult, OperationContext operationContext)	This method is called from the UI when the user wants to add a vertex that is in the current context to the focus list.
List<? extends VertexRef>	queryVertices(SearchQuery searchQuery, GraphContainer container)

Methods inherited from class org.opennms.features.topology.api.topo.simple.SimpleSearchProvider

addVertexHopCriteria, getVertexRefsBy, query, removeVertexHopCriteria, supportsPrefix

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

onCenterSearchResult, onDefocusSearchResult, onToggleCollapse, supportsPrefix

Methods inherited from class java.lang.Object

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

Constructor Detail

GraphMLSearchProvider

public GraphMLSearchProvider(GraphMLTopologyProvider graphMLTopologyProvider)

Method Detail

contributesTo

public boolean contributesTo(String namespace)

In GraphML graphs the namespace of each graph contained in the GraphML file should be prefixed, e.g. namespace1:graph1, namespace1:graph2, etc.

Specified by:

contributesTo in interface SearchProvider

Overrides:

contributesTo in class SimpleSearchProvider

Parameters:

namespace - The namespace to check

Returns:

true if this SearchProvider contributes, false otherwise

onFocusSearchResult

public void onFocusSearchResult(SearchResult searchResult,
                                OperationContext operationContext)

Description copied from interface: SearchProvider

This method is called from the UI when the user wants to add a vertex that is in the current context to the focus list.

Specified by:

onFocusSearchResult in interface SearchProvider

Overrides:

onFocusSearchResult in class AbstractSearchProvider

getSearchProviderNamespace

public String getSearchProviderNamespace()

Description copied from interface: SearchProvider

This is a namespace for search providers...

Returns:

queryVertices

public List<? extends VertexRef> queryVertices(SearchQuery searchQuery,
                                               GraphContainer container)

Specified by:

queryVertices in class SimpleSearchProvider