public interface Indexer<T>
Modifier and Type | Field and Description |
---|---|
static int |
DEFAULT_INTERVAL |
Modifier and Type | Method and Description |
---|---|
void |
delete(long companyId,
java.lang.String uid) |
void |
delete(T object) |
java.lang.String |
getClassName() |
Document |
getDocument(T object) |
BooleanFilter |
getFacetBooleanFilter(java.lang.String className,
SearchContext searchContext) |
BooleanQuery |
getFullQuery(SearchContext searchContext) |
IndexerPostProcessor[] |
getIndexerPostProcessors() |
java.lang.String[] |
getSearchClassNames() |
java.lang.String |
getSearchEngineId() |
java.lang.String |
getSortField(java.lang.String orderByCol)
Deprecated.
As of Judson (7.1.x), replaced by
com.liferay.portal.sort.SortFieldBuilder |
Summary |
getSummary(Document document,
java.lang.String snippet,
javax.portlet.PortletRequest portletRequest,
javax.portlet.PortletResponse portletResponse) |
boolean |
hasPermission(PermissionChecker permissionChecker,
java.lang.String entryClassName,
long entryClassPK,
java.lang.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(java.util.Collection<T> objects) |
void |
reindex(java.lang.String[] ids) |
void |
reindex(java.lang.String className,
long classPK) |
void |
reindex(T object) |
Hits |
search(SearchContext searchContext) |
Hits |
search(SearchContext searchContext,
java.lang.String... selectedFieldNames) |
long |
searchCount(SearchContext searchContext) |
void |
setIndexerEnabled(boolean indexerEnabled) |
void |
unregisterIndexerPostProcessor(IndexerPostProcessor indexerPostProcessor) |
static final int DEFAULT_INTERVAL
void delete(long companyId, java.lang.String uid) throws SearchException
SearchException
@Bufferable void delete(T object) throws SearchException
SearchException
java.lang.String getClassName()
Document getDocument(T object) throws SearchException
SearchException
BooleanFilter getFacetBooleanFilter(java.lang.String className, SearchContext searchContext) throws java.lang.Exception
java.lang.Exception
BooleanQuery getFullQuery(SearchContext searchContext) throws SearchException
SearchException
IndexerPostProcessor[] getIndexerPostProcessors()
java.lang.String[] getSearchClassNames()
java.lang.String getSearchEngineId()
@Deprecated java.lang.String getSortField(java.lang.String orderByCol)
com.liferay.portal.sort.SortFieldBuilder
Summary getSummary(Document document, java.lang.String snippet, javax.portlet.PortletRequest portletRequest, javax.portlet.PortletResponse portletResponse) throws SearchException
SearchException
boolean hasPermission(PermissionChecker permissionChecker, java.lang.String entryClassName, long entryClassPK, java.lang.String actionId) throws java.lang.Exception
java.lang.Exception
boolean isCommitImmediately()
boolean isFilterSearch()
true
if the indexer participates in post-search
result filtering.true
if the indexer participates in post-search
result filtering; false
otherwiseSearchResultPermissionFilter
boolean 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
otherwiseSearchPermissionChecker
boolean isStagingAware()
boolean isVisible(long classPK, int status) throws java.lang.Exception
java.lang.Exception
void postProcessContextBooleanFilter(BooleanFilter contextBooleanFilter, SearchContext searchContext) throws java.lang.Exception
java.lang.Exception
@Deprecated void postProcessContextQuery(BooleanQuery contextQuery, SearchContext searchContext) throws java.lang.Exception
postProcessContextBooleanFilter(BooleanFilter,
SearchContext)
java.lang.Exception
void postProcessSearchQuery(BooleanQuery searchQuery, BooleanFilter fullQueryBooleanFilter, SearchContext searchContext) throws java.lang.Exception
java.lang.Exception
@Deprecated void postProcessSearchQuery(BooleanQuery searchQuery, SearchContext searchContext) throws java.lang.Exception
postProcessSearchQuery(BooleanQuery, BooleanFilter,
SearchContext)
java.lang.Exception
void registerIndexerPostProcessor(IndexerPostProcessor indexerPostProcessor)
@Bufferable void reindex(java.util.Collection<T> objects) throws SearchException
SearchException
@Bufferable void reindex(java.lang.String className, long classPK) throws SearchException
SearchException
void reindex(java.lang.String[] ids) throws SearchException
SearchException
@Bufferable void reindex(T object) throws SearchException
SearchException
Hits search(SearchContext searchContext) throws SearchException
SearchException
Hits search(SearchContext searchContext, java.lang.String... selectedFieldNames) throws SearchException
SearchException
long searchCount(SearchContext searchContext) throws SearchException
SearchException
void setIndexerEnabled(boolean indexerEnabled)
void unregisterIndexerPostProcessor(IndexerPostProcessor indexerPostProcessor)