org.opennms.features.topology.api.topo

Class AbstractSearchProvider

java.lang.Object

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

All Implemented Interfaces:

SearchProvider

Direct Known Subclasses:

AlarmSearchProvider, CategorySearchProvider, IpLikeSearchProvider, NCSSearchProvider

public abstract class AbstractSearchProvider
extends Object
implements SearchProvider

This abstract class provides empty implementations of all of the event handler functions.

Author:

root

Constructor Summary

Constructors

Constructor and Description
AbstractSearchProvider()

Method Summary

Methods

Modifier and Type	Method and Description
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.
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.
static boolean	supportsPrefix(String providerPrefix, String searchPrefix)

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

addVertexHopCriteria, contributesTo, getSearchProviderNamespace, getVertexRefsBy, query, removeVertexHopCriteria, supportsPrefix

Constructor Detail

AbstractSearchProvider

public AbstractSearchProvider()

Method Detail

supportsPrefix

public static final boolean supportsPrefix(String providerPrefix,
                     String searchPrefix)

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

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

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

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