Package com.liferay.portal.kernel.search
Interface Indexer<T>
- All Known Implementing Classes:
BaseIndexer
,BaseSearcher
,DummyIndexer
,FolderSearcher
public interface Indexer<T>
- Author:
- Brian Wing Shun Chan, Raymond Augé, Ryan Park
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionvoid
void
default long
getDocument
(T object) getFacetBooleanFilter
(String className, SearchContext searchContext) getFullQuery
(SearchContext searchContext) String[]
getSortField
(String orderByCol) Deprecated.getSummary
(Document document, String snippet, PortletRequest portletRequest, PortletResponse portletResponse) default Summary
getSummary
(Document document, Locale locale, String snippet) boolean
hasPermission
(PermissionChecker permissionChecker, String entryClassName, long entryClassPK, String actionId) boolean
boolean
Returntrue
if the indexer participates in post-search result filtering.boolean
boolean
Returnstrue
if the indexer adds permission related filters to the search query prior to executionboolean
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 bypostProcessContextBooleanFilter(BooleanFilter, SearchContext)
void
postProcessSearchQuery
(BooleanQuery searchQuery, BooleanFilter fullQueryBooleanFilter, SearchContext searchContext) void
postProcessSearchQuery
(BooleanQuery searchQuery, SearchContext searchContext) Deprecated.As of Wilberforce (7.0.x), replaced bypostProcessSearchQuery(BooleanQuery, BooleanFilter, SearchContext)
void
void
void
reindex
(Collection<T> objects) void
default void
search
(SearchContext searchContext) search
(SearchContext searchContext, String... selectedFieldNames) long
searchCount
(SearchContext searchContext) void
setIndexerEnabled
(boolean indexerEnabled)
-
Field Details
-
DEFAULT_INTERVAL
static final int DEFAULT_INTERVAL- See Also:
-
-
Method Details
-
delete
- Throws:
SearchException
-
delete
- Throws:
SearchException
-
getClassName
String getClassName() -
getCompanyId
default long getCompanyId() -
getDocument
- Throws:
SearchException
-
getFacetBooleanFilter
- Throws:
Exception
-
getFullQuery
- Throws:
SearchException
-
getIndexerPostProcessors
IndexerPostProcessor[] getIndexerPostProcessors() -
getSearchClassNames
String[] getSearchClassNames() -
getSortField
Deprecated.As of Judson (7.1.x), replaced bycom.liferay.portal.sort.SortFieldBuilder
-
getSummary
- Throws:
SearchException
-
getSummary
Summary getSummary(Document document, String snippet, PortletRequest portletRequest, PortletResponse portletResponse) throws SearchException - Throws:
SearchException
-
hasPermission
boolean hasPermission(PermissionChecker permissionChecker, String entryClassName, long entryClassPK, String actionId) throws Exception - Throws:
Exception
-
isCommitImmediately
boolean isCommitImmediately() -
isFilterSearch
boolean isFilterSearch()Returntrue
if the indexer participates in post-search result filtering.- Returns:
true
if the indexer participates in post-search result filtering;false
otherwise- See Also:
-
isIndexerEnabled
boolean isIndexerEnabled() -
isPermissionAware
boolean isPermissionAware()Returnstrue
if the indexer adds permission related filters to the search query prior to execution- Returns:
true
if the indexer adds permission related filters to the search query prior to execution;false
otherwise- See Also:
-
isStagingAware
boolean isStagingAware() -
isVisible
- Throws:
Exception
-
postProcessContextBooleanFilter
void postProcessContextBooleanFilter(BooleanFilter contextBooleanFilter, SearchContext searchContext) throws Exception - Throws:
Exception
-
postProcessContextQuery
@Deprecated void postProcessContextQuery(BooleanQuery contextQuery, SearchContext searchContext) throws Exception Deprecated.As of Wilberforce (7.0.x), replaced bypostProcessContextBooleanFilter(BooleanFilter, SearchContext)
- Throws:
Exception
-
postProcessSearchQuery
void postProcessSearchQuery(BooleanQuery searchQuery, BooleanFilter fullQueryBooleanFilter, SearchContext searchContext) throws Exception - Throws:
Exception
-
postProcessSearchQuery
@Deprecated void postProcessSearchQuery(BooleanQuery searchQuery, SearchContext searchContext) throws Exception Deprecated.As of Wilberforce (7.0.x), replaced bypostProcessSearchQuery(BooleanQuery, BooleanFilter, SearchContext)
- Throws:
Exception
-
reindex
- Throws:
SearchException
-
reindex
- Throws:
SearchException
-
reindex
- Throws:
SearchException
-
reindex
- Throws:
SearchException
-
reindex
- Throws:
SearchException
-
search
- Throws:
SearchException
-
search
- Throws:
SearchException
-
searchCount
- Throws:
SearchException
-
setIndexerEnabled
void setIndexerEnabled(boolean indexerEnabled)
-
com.liferay.portal.sort.SortFieldBuilder