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
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. Criteria
buildCriteriaFromQuery(SearchResult input, GraphContainer container)
boolean
contributesTo(String namespace)
This is the topology provider namespace to which this search provider contributes.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 whatare associated with a particular . 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. 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 void
setHiddenCategoryPrefix(String prefix)
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
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 String getSearchProviderNamespace()
Description copied from interface:SearchProvider
This is a namespace for search providers...- Specified by:
getSearchProviderNamespace
in interfaceSearchProvider
- 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 interfaceSearchProvider
- 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 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
-
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 interfaceSearchProvider
- 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 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
-
setHiddenCategoryPrefix
public void setHiddenCategoryPrefix(String prefix)
-
buildCriteriaFromQuery
public Criteria buildCriteriaFromQuery(SearchResult input, GraphContainer container)
- Specified by:
buildCriteriaFromQuery
in interfaceHistoryAwareSearchProvider
-
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
- Overrides:
onToggleCollapse
in classAbstractSearchProvider
-
-