org.opennms.features.topology.plugins.ncs

Class NCSSearchProvider

java.lang.Object

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

org.opennms.features.topology.plugins.ncs.NCSSearchProvider

All Implemented Interfaces:

HistoryAwareSearchProvider, SearchProvider

public class NCSSearchProvider
extends AbstractSearchProvider
implements HistoryAwareSearchProvider

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NCSSearchProvider.NCSHopCriteria

Constructor Summary

Constructors

Constructor and Description
NCSSearchProvider()

Method Summary

Modifier and Type	Method and 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(String namespace) This is the topology provider namespace to which this search provider contributes.
protected static void	deselectVerticesForEdge(NCSEdgeProvider provider, Criteria criteria, SelectionManager selectionManager)
String	getSearchProviderNamespace() This is a namespace for search providers...
Set<VertexRef>	getVertexRefsBy(SearchResult searchResult, GraphContainer container) This method is called when the topology UI needs to know what are associated with a particular .
static Set<VertexRef>	getVertexRefsForEdges(NCSEdgeProvider provider, Criteria criteria)
void	onCenterSearchResult(SearchResult searchResult, GraphContainer graphContainer) This method called when the user clicks the focus icon on the .
void	onDefocusSearchResult(SearchResult searchResult, OperationContext operationContext) This method is called from the UI when the user wants to remove a vertex that currently in the focus list.
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<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
protected static void	selectVerticesForEdge(NCSEdgeProvider provider, Criteria criteria, SelectionManager selectionManager)
void	setNcsComponentRepository(NCSComponentRepository ncsComponentRepository)
void	setNcsCriteriaServiceManager(NCSCriteriaServiceManager manager)
void	setNcsEdgeProvider(NCSEdgeProvider ncsEdgeProvider)
boolean	supportsPrefix(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

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

onToggleCollapse

Constructor Detail

NCSSearchProvider

public NCSSearchProvider()

Method Detail

buildCriteriaFromQuery

public Criteria buildCriteriaFromQuery(SearchResult input,
                                       GraphContainer container)

Specified by:

buildCriteriaFromQuery in interface HistoryAwareSearchProvider

setNcsComponentRepository

public void setNcsComponentRepository(NCSComponentRepository ncsComponentRepository)

selectVerticesForEdge

protected static void selectVerticesForEdge(NCSEdgeProvider provider,
                                            Criteria criteria,
                                            SelectionManager selectionManager)

deselectVerticesForEdge

protected static void deselectVerticesForEdge(NCSEdgeProvider provider,
                                              Criteria criteria,
                                              SelectionManager selectionManager)

getVertexRefsForEdges

public static Set<VertexRef> getVertexRefsForEdges(NCSEdgeProvider provider,
                                                   Criteria criteria)

setNcsEdgeProvider

public void setNcsEdgeProvider(NCSEdgeProvider ncsEdgeProvider)

setNcsCriteriaServiceManager

public void setNcsCriteriaServiceManager(NCSCriteriaServiceManager manager)

getSearchProviderNamespace

public 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(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 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

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

onDefocusSearchResult

public void onDefocusSearchResult(SearchResult searchResult,
                                  OperationContext operationContext)

Description copied from interface: SearchProvider

This method is called from the UI when the user wants to remove a vertex that currently in the focus list.

Specified by:

onDefocusSearchResult in interface SearchProvider

Overrides:

onDefocusSearchResult in class AbstractSearchProvider

supportsPrefix

public boolean supportsPrefix(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 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

onCenterSearchResult

public void onCenterSearchResult(SearchResult searchResult,
                                 GraphContainer graphContainer)

Description copied from interface: SearchProvider

This method called when the user clicks the focus icon on the . No implementation is required unless you want to enhance the zoom behavior. This call will be followed by a call to getVertexRefsBy.

Specified by:

onCenterSearchResult in interface SearchProvider

Overrides:

onCenterSearchResult in class AbstractSearchProvider