com.liferay.portal.kernel.search

Interface Indexer

All Known Implementing Classes:

BaseIndexer, BaseSearcher, DummyIndexer, FacetedSearcher, FolderSearcher, IndexerWrapper

public interface Indexer

Author:

Brian Wing Shun Chan, Raymond Augé, Ryan Park

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_INTERVAL

Method Summary

Methods

Modifier and Type	Method and Description
void	addRelatedEntryFields(Document document, java.lang.Object obj)
void	delete(long companyId, java.lang.String uid)
void	delete(java.lang.Object obj)
java.lang.String[]	getClassNames()
Document	getDocument(java.lang.Object obj)
BooleanQuery	getFacetQuery(java.lang.String className, SearchContext searchContext)
BooleanQuery	getFullQuery(SearchContext searchContext)
IndexerPostProcessor[]	getIndexerPostProcessors()
java.lang.String	getPortletId()
java.lang.String	getSearchEngineId()
java.lang.String	getSortField(java.lang.String orderByCol)
java.lang.String	getSortField(java.lang.String orderByCol, int sortType)
Summary	getSummary(Document document, java.util.Locale locale, java.lang.String snippet, javax.portlet.PortletURL portletURL)
boolean	hasPermission(PermissionChecker permissionChecker, java.lang.String entryClassName, long entryClassPK, java.lang.String actionId)
boolean	isFilterSearch()
boolean	isPermissionAware()
boolean	isStagingAware()
boolean	isVisible(long classPK, int status)
boolean	isVisibleRelatedEntry(long classPK, int status)
void	postProcessContextQuery(BooleanQuery contextQuery, SearchContext searchContext)
void	postProcessSearchQuery(BooleanQuery searchQuery, SearchContext searchContext)
void	registerIndexerPostProcessor(IndexerPostProcessor indexerPostProcessor)
void	reindex(java.lang.Object obj)
void	reindex(java.lang.String[] ids)
void	reindex(java.lang.String className, long classPK)
void	reindexDDMStructures(java.util.List<java.lang.Long> ddmStructureIds)
Hits	search(SearchContext searchContext)
void	unregisterIndexerPostProcessor(IndexerPostProcessor indexerPostProcessor)

Field Detail

DEFAULT_INTERVAL

static final int DEFAULT_INTERVAL

See Also:

Constant Field Values

Method Detail

addRelatedEntryFields

void addRelatedEntryFields(Document document,
                         java.lang.Object obj)
                           throws java.lang.Exception

Throws:

java.lang.Exception

delete

void delete(long companyId,
          java.lang.String uid)
            throws SearchException

Throws:

SearchException

delete

void delete(java.lang.Object obj)
            throws SearchException

Throws:

SearchException

getClassNames

java.lang.String[] getClassNames()

getDocument

Document getDocument(java.lang.Object obj)
                     throws SearchException

Throws:

SearchException

getFacetQuery

BooleanQuery getFacetQuery(java.lang.String className,
                         SearchContext searchContext)
                           throws java.lang.Exception

Throws:

java.lang.Exception

getFullQuery

BooleanQuery getFullQuery(SearchContext searchContext)
                          throws SearchException

Throws:

SearchException

getIndexerPostProcessors

IndexerPostProcessor[] getIndexerPostProcessors()

getPortletId

java.lang.String getPortletId()

getSearchEngineId

java.lang.String getSearchEngineId()

getSortField

java.lang.String getSortField(java.lang.String orderByCol)

getSortField

java.lang.String getSortField(java.lang.String orderByCol,
                            int sortType)

getSummary

Summary getSummary(Document document,
                 java.util.Locale locale,
                 java.lang.String snippet,
                 javax.portlet.PortletURL portletURL)
                   throws SearchException

Throws:

SearchException

hasPermission

boolean hasPermission(PermissionChecker permissionChecker,
                    java.lang.String entryClassName,
                    long entryClassPK,
                    java.lang.String actionId)
                      throws java.lang.Exception

Throws:

java.lang.Exception

isFilterSearch

boolean isFilterSearch()

isPermissionAware

boolean isPermissionAware()

isStagingAware

boolean isStagingAware()

isVisible

boolean isVisible(long classPK,
                int status)
                  throws java.lang.Exception

Throws:

java.lang.Exception

isVisibleRelatedEntry

boolean isVisibleRelatedEntry(long classPK,
                            int status)
                              throws java.lang.Exception

Throws:

java.lang.Exception

postProcessContextQuery

void postProcessContextQuery(BooleanQuery contextQuery,
                           SearchContext searchContext)
                             throws java.lang.Exception

Throws:

java.lang.Exception

postProcessSearchQuery

void postProcessSearchQuery(BooleanQuery searchQuery,
                          SearchContext searchContext)
                            throws java.lang.Exception

Throws:

java.lang.Exception

registerIndexerPostProcessor

void registerIndexerPostProcessor(IndexerPostProcessor indexerPostProcessor)

reindex

void reindex(java.lang.Object obj)
             throws SearchException

Throws:

SearchException

reindex

void reindex(java.lang.String className,
           long classPK)
             throws SearchException

Throws:

SearchException

reindex

void reindex(java.lang.String[] ids)
             throws SearchException

Throws:

SearchException

reindexDDMStructures

void reindexDDMStructures(java.util.List<java.lang.Long> ddmStructureIds)
                          throws SearchException

Throws:

SearchException

search

Hits search(SearchContext searchContext)
            throws SearchException

Throws:

SearchException

unregisterIndexerPostProcessor

void unregisterIndexerPostProcessor(IndexerPostProcessor indexerPostProcessor)