Package org.opennms.features.topology.app.internal

Class CategorySearchProvider

java.lang.Object

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

org.opennms.features.topology.app.internal.CategorySearchProvider

All Implemented Interfaces:

HistoryAwareSearchProvider, SearchProvider

public class CategorySearchProvider
extends AbstractSearchProvider
implements HistoryAwareSearchProvider

Constructor Summary

Constructors

Constructor	Description
CategorySearchProvider(TopologyService topologyService, CategoryProvider categoryProvider)

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.
Criteria	buildCriteriaFromQuery(SearchResult input, GraphContainer container)
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 .
void	onToggleCollapse(SearchResult searchResult, GraphContainer graphContainer)	This method is called if the provided by the implementation of this API is flagged as collapsible and the user has clicked the toggle icon.
java.util.List<SearchResult>	query(SearchQuery searchQuery, GraphContainer graphContainer)	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	setHiddenCategoryPrefix(java.lang.String prefix)
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, 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

Constructor Detail

CategorySearchProvider

public CategorySearchProvider(TopologyService topologyService,
                              CategoryProvider categoryProvider)

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

query

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

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

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:

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

setHiddenCategoryPrefix

public void setHiddenCategoryPrefix(java.lang.String prefix)

buildCriteriaFromQuery

public Criteria buildCriteriaFromQuery(SearchResult input,
                                       GraphContainer container)

Specified by:

buildCriteriaFromQuery in interface HistoryAwareSearchProvider

onToggleCollapse

public void onToggleCollapse(SearchResult searchResult,
                             GraphContainer graphContainer)

Description copied from interface: SearchProvider

This method is called if the provided by the implementation of this API is flagged as collapsible and the user has clicked the toggle icon. This requires that the implementation created by the implemenation of this API should be able to implement the API. The set of provided by the Criteria will not change, however, the criteria should be able to provide the both the collapsed and uncollapsed representations of the SearchResult.

Specified by:

onToggleCollapse in interface SearchProvider

Overrides:

onToggleCollapse in class AbstractSearchProvider