public interface Indexer<T>
| Modifier and Type | Field and Description |
|---|---|
static int |
DEFAULT_INTERVAL |
| Modifier and Type | Method and Description |
|---|---|
void |
delete(long companyId,
String uid) |
void |
delete(T object) |
String |
getClassName() |
Document |
getDocument(T object) |
BooleanFilter |
getFacetBooleanFilter(String className,
SearchContext searchContext) |
BooleanQuery |
getFullQuery(SearchContext searchContext) |
IndexerPostProcessor[] |
getIndexerPostProcessors() |
String[] |
getSearchClassNames() |
String |
getSearchEngineId() |
String |
getSortField(String orderByCol)
Deprecated.
As of Judson (7.1.x), replaced by
com.liferay.portal.sort.SortFieldBuilder |
Summary |
getSummary(Document document,
String snippet,
PortletRequest portletRequest,
PortletResponse portletResponse) |
boolean |
hasPermission(PermissionChecker permissionChecker,
String entryClassName,
long entryClassPK,
String actionId) |
boolean |
isCommitImmediately() |
boolean |
isFilterSearch()
Return
true if the indexer participates in post-search
result filtering. |
boolean |
isIndexerEnabled() |
boolean |
isPermissionAware()
Returns
true if the indexer adds permission related filters
to the search query prior to execution |
boolean |
isStagingAware() |
boolean |
isVisible(long classPK,
int status) |
void |
postProcessContextBooleanFilter(BooleanFilter contextBooleanFilter,
SearchContext searchContext) |
void |
postProcessContextQuery(BooleanQuery contextQuery,
SearchContext searchContext)
Deprecated.
As of Wilberforce (7.0.x), replaced by
postProcessContextBooleanFilter(BooleanFilter,
SearchContext) |
void |
postProcessSearchQuery(BooleanQuery searchQuery,
BooleanFilter fullQueryBooleanFilter,
SearchContext searchContext) |
void |
postProcessSearchQuery(BooleanQuery searchQuery,
SearchContext searchContext)
Deprecated.
As of Wilberforce (7.0.x), replaced by
postProcessSearchQuery(BooleanQuery, BooleanFilter,
SearchContext) |
void |
registerIndexerPostProcessor(IndexerPostProcessor indexerPostProcessor) |
void |
reindex(Collection<T> objects) |
void |
reindex(String[] ids) |
void |
reindex(String className,
long classPK) |
void |
reindex(T object) |
Hits |
search(SearchContext searchContext) |
Hits |
search(SearchContext searchContext,
String... selectedFieldNames) |
long |
searchCount(SearchContext searchContext) |
void |
setIndexerEnabled(boolean indexerEnabled) |
void |
unregisterIndexerPostProcessor(IndexerPostProcessor indexerPostProcessor) |
static final int DEFAULT_INTERVAL
void delete(long companyId,
String uid)
throws SearchException
SearchException@Bufferable void delete(T object) throws SearchException
SearchExceptionString getClassName()
Document getDocument(T object) throws SearchException
SearchExceptionBooleanFilter getFacetBooleanFilter(String className, SearchContext searchContext) throws Exception
ExceptionBooleanQuery getFullQuery(SearchContext searchContext) throws SearchException
SearchExceptionIndexerPostProcessor[] getIndexerPostProcessors()
String[] getSearchClassNames()
String getSearchEngineId()
@Deprecated String getSortField(String orderByCol)
com.liferay.portal.sort.SortFieldBuilderSummary getSummary(Document document, String snippet, PortletRequest portletRequest, PortletResponse portletResponse) throws SearchException
SearchExceptionboolean hasPermission(PermissionChecker permissionChecker, String entryClassName, long entryClassPK, String actionId) throws Exception
Exceptionboolean isCommitImmediately()
boolean isFilterSearch()
true if the indexer participates in post-search
result filtering.true if the indexer participates in post-search
result filtering; false otherwiseSearchResultPermissionFilterboolean isIndexerEnabled()
boolean isPermissionAware()
true if the indexer adds permission related filters
to the search query prior to executiontrue if the indexer adds permission related filters
to the search query prior to execution; false
otherwiseSearchPermissionCheckerboolean isStagingAware()
boolean isVisible(long classPK,
int status)
throws Exception
Exceptionvoid postProcessContextBooleanFilter(BooleanFilter contextBooleanFilter, SearchContext searchContext) throws Exception
Exception@Deprecated void postProcessContextQuery(BooleanQuery contextQuery, SearchContext searchContext) throws Exception
postProcessContextBooleanFilter(BooleanFilter,
SearchContext)Exceptionvoid postProcessSearchQuery(BooleanQuery searchQuery, BooleanFilter fullQueryBooleanFilter, SearchContext searchContext) throws Exception
Exception@Deprecated void postProcessSearchQuery(BooleanQuery searchQuery, SearchContext searchContext) throws Exception
postProcessSearchQuery(BooleanQuery, BooleanFilter,
SearchContext)Exceptionvoid registerIndexerPostProcessor(IndexerPostProcessor indexerPostProcessor)
@Bufferable void reindex(Collection<T> objects) throws SearchException
SearchException@Bufferable void reindex(String className, long classPK) throws SearchException
SearchExceptionvoid reindex(String[] ids)
throws SearchException
SearchException@Bufferable void reindex(T object) throws SearchException
SearchExceptionHits search(SearchContext searchContext) throws SearchException
SearchExceptionHits search(SearchContext searchContext, String... selectedFieldNames) throws SearchException
SearchExceptionlong searchCount(SearchContext searchContext) throws SearchException
SearchExceptionvoid setIndexerEnabled(boolean indexerEnabled)
void unregisterIndexerPostProcessor(IndexerPostProcessor indexerPostProcessor)