com.liferay.portal.kernel.search

Interface Indexer<T>

All Known Implementing Classes:

BaseIndexer, BaseSearcher, DummyIndexer, FacetedSearcher, FolderSearcher

public interface Indexer<T>

Author:

Brian Wing Shun Chan, Raymond Augé, Ryan Park

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_INTERVAL

Method Summary

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
String	getSortField(String orderByCol, int sortType) 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)
boolean	isVisibleRelatedEntry(long classPK, int status) Deprecated. As of Judson (7.1.x), replaced by RelatedEntryIndexer.isVisibleRelatedEntry(long, int)
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)

Field Detail

DEFAULT_INTERVAL

static final int DEFAULT_INTERVAL

See Also:

Constant Field Values

Method Detail

delete

void delete(long companyId,
            String uid)
     throws SearchException

Throws:

SearchException

delete

@Bufferable
void delete(T object)
                 throws SearchException

Throws:

SearchException

getClassName

String getClassName()

getDocument

Document getDocument(T object)
              throws SearchException

Throws:

SearchException

getFacetBooleanFilter

BooleanFilter getFacetBooleanFilter(String className,
                                    SearchContext searchContext)
                             throws Exception

Throws:

Exception

getFullQuery

BooleanQuery getFullQuery(SearchContext searchContext)
                   throws SearchException

Throws:

SearchException

getIndexerPostProcessors

IndexerPostProcessor[] getIndexerPostProcessors()

getSearchClassNames

String[] getSearchClassNames()

getSearchEngineId

String getSearchEngineId()

getSortField

@Deprecated
String getSortField(String orderByCol)

Deprecated. As of Judson (7.1.x), replaced by com.liferay.portal.sort.SortFieldBuilder

getSortField

@Deprecated
String getSortField(String orderByCol,
                                int sortType)

Deprecated. As of Judson (7.1.x), replaced by com.liferay.portal.sort.SortFieldBuilder

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()

Return true if the indexer participates in post-search result filtering.

Returns:

true if the indexer participates in post-search result filtering; false otherwise

See Also:

SearchResultPermissionFilter

isIndexerEnabled

boolean isIndexerEnabled()

isPermissionAware

boolean isPermissionAware()

Returns true 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:

SearchPermissionChecker

isStagingAware

boolean isStagingAware()

isVisible

boolean isVisible(long classPK,
                  int status)
           throws Exception

Throws:

Exception

isVisibleRelatedEntry

@Deprecated
boolean isVisibleRelatedEntry(long classPK,
                                          int status)
                                   throws Exception

Deprecated. As of Judson (7.1.x), replaced by RelatedEntryIndexer.isVisibleRelatedEntry(long, int)

Parameters:

classPK -

status -

Returns:

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 by postProcessContextBooleanFilter(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 by postProcessSearchQuery(BooleanQuery, BooleanFilter, SearchContext)

Throws:

Exception

registerIndexerPostProcessor

void registerIndexerPostProcessor(IndexerPostProcessor indexerPostProcessor)

reindex

@Bufferable
void reindex(Collection<T> objects)
                  throws SearchException

Throws:

SearchException

reindex

@Bufferable
void reindex(String className,
                         long classPK)
                  throws SearchException

Throws:

SearchException

reindex

void reindex(String[] ids)
      throws SearchException

Throws:

SearchException

reindex

@Bufferable
void reindex(T object)
                  throws SearchException

Throws:

SearchException

search

Hits search(SearchContext searchContext)
     throws SearchException

Throws:

SearchException

search

Hits search(SearchContext searchContext,
            String... selectedFieldNames)
     throws SearchException

Throws:

SearchException

searchCount

long searchCount(SearchContext searchContext)
          throws SearchException

Throws:

SearchException

setIndexerEnabled

void setIndexerEnabled(boolean indexerEnabled)

unregisterIndexerPostProcessor

void unregisterIndexerPostProcessor(IndexerPostProcessor indexerPostProcessor)