public abstract class AbstractOmniSearchHandler extends java.lang.Object implements OmniSearchHandler, EventListener
AbstractOmniSearchHandler
is an abstract class
which other can extend to provide implemenation of OmniSearchHandler
If any Module implements OmniSearchHandler
using AbstractOmniSearchHandler
,
It needs to create contentNode under path METADATA_PATH. And provide all the property details in that Node.
Modifier and Type | Field and Description |
---|---|
java.lang.String |
METADATA_PATH |
Constructor and Description |
---|
AbstractOmniSearchHandler() |
Modifier and Type | Method and Description |
---|---|
void |
destroy(ResourceResolver resolver)
This function clear the predicateSuggestionList and remove all the eventListeners.
|
PredicateSuggestion |
getLocationSuggestion(ResourceResolver resolver,
I18n i18n,
java.lang.String searchTerm) |
Resource |
getModuleConfig(ResourceResolver resolver)
Every search module will store additional configuration i.e.
|
java.util.List<PredicateSuggestion> |
getPredicateSuggestions(ResourceResolver resolver,
I18n i18n,
java.lang.String searchTerm)
This function provide List of Predicates that matched to current
request parameters.
|
Query |
getSpellCheckQuery(ResourceResolver resolver,
java.lang.String searchTerm)
This function returns
Query that provides spell check suggestions
based on parameters provide in the request. |
Query |
getSuggestionQuery(ResourceResolver resolver,
java.lang.String searchTerm)
This function returns
Query that provides suggestions
based on parameters provide in the request. |
void |
init(ResourceResolver resolver)
This function intialize the
ResourceResolver instace. |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getID, getResults
onEvent
public final java.lang.String METADATA_PATH
public Query getSuggestionQuery(ResourceResolver resolver, java.lang.String searchTerm)
Query
that provides suggestions
based on parameters provide in the request. It will look for "fulltext"
paramter in request and "fulltext" parameter will treated as search term.
Based on this search term suggestion query will be created.getSuggestionQuery
in interface OmniSearchHandler
resolver
- ResourceResolver instancesearchTerm
- text term for which suggestions are requireQuery
that returns suggestions on executionpublic java.util.List<PredicateSuggestion> getPredicateSuggestions(ResourceResolver resolver, I18n i18n, java.lang.String searchTerm)
PredicateSuggestion
to the search term. Currently predicate suggestion works only if
length of search term is more than MIN_SUGGESTION_REQUIRE_SIZEgetPredicateSuggestions
in interface OmniSearchHandler
resolver
- ResourceResolver instancei18n
- I18n instancesearchTerm
- text term for which suggestions are require @return List
of PredicateSuggestion
List
of Predicatespublic Query getSpellCheckQuery(ResourceResolver resolver, java.lang.String searchTerm)
Query
that provides spell check suggestions
based on parameters provide in the request. It will look for "fulltext"
paramter in request and "fulltext" parameter will treated as search term.
Based on this search term spell check query will be created.getSpellCheckQuery
in interface OmniSearchHandler
resolver
- ResourceResolver instancesearchTerm
- text term for which suggestions are requireQuery
that returns spell check suggestion on execution.public Resource getModuleConfig(ResourceResolver resolver)
OmniSearchHandler
itemCardType
itemListType
to specify configuration that can be used to represent
search module resources i.e. assets, sites, users, groups.
This api returns such a resource that stores the config.
Additionally, this allows ability to control the visibility of particular search module
to a user. If a user does not have access to this resource. OmniSearch will not include this search
module in its searches i.e. suggestions, search etc.getModuleConfig
in interface OmniSearchHandler
resolver
- ResourceResolver instanceResource
of content Nodepublic PredicateSuggestion getLocationSuggestion(ResourceResolver resolver, I18n i18n, java.lang.String searchTerm)
public void init(ResourceResolver resolver)
ResourceResolver
instace.
It usually called on activation of OmniSearchHandler
or on event from
implementation of OmniSearchHandler
resolver
- ResourceResolver
instance, AbstractOmniSearchHandler
expects that
this ResourceResolver
will not be closed before deactivation.public void destroy(ResourceResolver resolver)
OmniSearchHandler
resolver
- ResourceResolver
instanceCopyright © 2010 - 2020 Adobe. All Rights Reserved