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

Class LegacyApplicationSearchProvider

java.lang.Object

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

org.opennms.features.topology.plugins.topo.application.LegacyApplicationSearchProvider

All Implemented Interfaces:

SearchProvider

public class LegacyApplicationSearchProvider
extends AbstractSearchProvider
implements SearchProvider

We call here the new search implementation and use it in the legacy world. This class will disappear eventually and the new search will be used directly.

Constructor Summary

Constructors

Constructor	Description
LegacyApplicationSearchProvider()

Method Summary

Modifier and Type	Method	Description
void	addVertexHopCriteria(SearchResult searchResult, GraphContainer container)	This method is called when the selection is made from the list of returned by a query() method of this API.
boolean	contributesTo(java.lang.String namespace)	This is the topology provider namespace to which this search provider contributes.
java.lang.String	getSearchProviderNamespace()	This is a namespace for search providers...
java.util.Set<VertexRef>	getVertexRefsBy(SearchResult searchResult, GraphContainer container)	This method is called when the topology UI needs to know what are associated with a particular .
java.util.List<SearchResult>	query(SearchQuery searchQuery, GraphContainer container)	This API is for getting a list of from all the search providers.
void	removeVertexHopCriteria(SearchResult searchResult, GraphContainer container)	When the user requests that the current SearchResult be removed from focus, the search provider should remove the from the
void	setGraphSearchService(GraphSearchService graphSearchService)
boolean	supportsPrefix(java.lang.String searchPrefix)	This method is called by topology app the user is searching to setup prefixes that will only match from a

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

onCenterSearchResult, onDefocusSearchResult, onFocusSearchResult, onToggleCollapse, supportsPrefix

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

onCenterSearchResult, onDefocusSearchResult, onFocusSearchResult, onToggleCollapse

Constructor Detail

LegacyApplicationSearchProvider

public LegacyApplicationSearchProvider()

Method Detail

getSearchProviderNamespace

public java.lang.String getSearchProviderNamespace()

Description copied from interface: SearchProvider

This is a namespace for search providers...

Specified by:

getSearchProviderNamespace in interface SearchProvider

Returns:

contributesTo

public boolean contributesTo(java.lang.String namespace)

Description copied from interface: SearchProvider

This is the topology provider namespace to which this search provider contributes.

Specified by:

contributesTo in interface SearchProvider

Returns:

returns true if the provider support the <@param namespace>.

supportsPrefix

public boolean supportsPrefix(java.lang.String searchPrefix)

Description copied from interface: SearchProvider

This method is called by topology app the user is searching to setup prefixes that will only match from a

Specified by:

supportsPrefix in interface SearchProvider

Returns:

query

public java.util.List<SearchResult> query(SearchQuery searchQuery,
                                          GraphContainer container)

Description copied from interface: SearchProvider

This API is for getting a list of from all the search providers.

Specified by:

query in interface SearchProvider

Parameters:

searchQuery - This is an API for Vaadin UI code for implementing various search queries types.

Returns:

A list of SearchResults

getVertexRefsBy

public java.util.Set<VertexRef> getVertexRefsBy(SearchResult searchResult,
                                                GraphContainer container)

Description copied from interface: SearchProvider

This method is called when the topology UI needs to know what are associated with a particular .

Specified by:

getVertexRefsBy in interface SearchProvider

Returns:

addVertexHopCriteria

public void addVertexHopCriteria(SearchResult searchResult,
                                 GraphContainer container)

Description copied from interface: SearchProvider

This method is called when the selection is made from the list of returned by a query() method of this API. It is the criteria's responsibility is to determine the associated with the passed to the reference passed to this method.

Specified by:

addVertexHopCriteria in interface SearchProvider

removeVertexHopCriteria

public void removeVertexHopCriteria(SearchResult searchResult,
                                    GraphContainer container)

Description copied from interface: SearchProvider

When the user requests that the current SearchResult be removed from focus, the search provider should remove the from the

Specified by:

removeVertexHopCriteria in interface SearchProvider

setGraphSearchService

public void setGraphSearchService(GraphSearchService graphSearchService)