Class LinkdSearchProvider
- java.lang.Object
-
- org.opennms.features.topology.plugins.topo.linkd.internal.LinkdSearchProvider
-
- All Implemented Interfaces:
SearchProvider
public class LinkdSearchProvider extends java.lang.Object implements SearchProvider
-
-
Constructor Summary
Constructors Constructor Description LinkdSearchProvider(GraphProvider delegate)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addVertexHopCriteria(SearchResult searchResult, GraphContainer container)
This method is called when the selection is made from the list ofreturned 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 whatare associated with a particular . 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 theprovided 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 offrom 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 thefrom the 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
-
-
-
Constructor Detail
-
LinkdSearchProvider
public LinkdSearchProvider(GraphProvider delegate)
-
-
Method Detail
-
query
public java.util.List<SearchResult> query(SearchQuery searchQuery, GraphContainer graphContainer)
Description copied from interface:SearchProvider
This API is for getting a list offrom all the search providers. - Specified by:
query
in interfaceSearchProvider
- Parameters:
searchQuery
- This is an API for Vaadin UI code for implementing various search queries types.- Returns:
- A list of SearchResults
-
getSearchProviderNamespace
public java.lang.String getSearchProviderNamespace()
Description copied from interface:SearchProvider
This is a namespace for search providers...- Specified by:
getSearchProviderNamespace
in interfaceSearchProvider
- Returns:
-
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 interfaceSearchProvider
-
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 interfaceSearchProvider
-
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 interfaceSearchProvider
- 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 whatare associated with a particular . - Specified by:
getVertexRefsBy
in interfaceSearchProvider
- 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 ofreturned 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 interfaceSearchProvider
-
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 thefrom the - Specified by:
removeVertexHopCriteria
in interfaceSearchProvider
-
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 interfaceSearchProvider
-
onToggleCollapse
public void onToggleCollapse(SearchResult searchResult, GraphContainer graphContainer)
Description copied from interface:SearchProvider
This method is called if theprovided 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 interfaceSearchProvider
-
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 interfaceSearchProvider
- Returns:
- returns true if the provider support the <@param namespace>.
-
-