com.liferay.portal.kernel.search

Class BaseIndexer

java.lang.Object

com.liferay.portal.kernel.search.BaseIndexer

All Implemented Interfaces:

Indexer

Direct Known Subclasses:

BaseSearcher, FacetedSearcher, FolderSearcher

public abstract class BaseIndexer
extends java.lang.Object
implements Indexer

Author:

Brian Wing Shun Chan, Hugo Huijser, Ryan Park, Raymond Augé

Field Summary

Fields

Modifier and Type	Field and Description
static int	INDEX_FILTER_SEARCH_LIMIT Deprecated. As of 7.0.0, with no direct replacement

Fields inherited from interface com.liferay.portal.kernel.search.Indexer

DEFAULT_INTERVAL

Constructor Summary

Constructors

Constructor and Description
BaseIndexer()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addAssetFields(Document document, java.lang.String className, long classPK)
protected void	addLocalizedSearchTerm(BooleanQuery searchQuery, SearchContext searchContext, java.lang.String field, boolean like) Deprecated. As of 6.2.0, replaced by addSearchLocalizedTerm(BooleanQuery, SearchContext, String, boolean)
protected void	addRelatedClassNames(BooleanQuery contextQuery, SearchContext searchContext)
void	addRelatedEntryFields(Document document, java.lang.Object obj)
protected void	addSearchArrayQuery(BooleanQuery searchQuery, SearchContext searchContext, java.lang.String field)
protected void	addSearchAssetCategoryIds(BooleanQuery contextQuery, SearchContext searchContext)
protected void	addSearchAssetCategoryTitles(Document document, java.lang.String field, java.util.List<AssetCategory> assetCategories)
protected void	addSearchAssetTagNames(BooleanQuery contextQuery, SearchContext searchContext)
protected void	addSearchClassTypeIds(BooleanQuery contextQuery, SearchContext searchContext)
protected void	addSearchDDMStruture(BooleanQuery searchQuery, SearchContext searchContext, DDMStructure ddmStructure)
protected void	addSearchEntryClassNames(BooleanQuery contextQuery, SearchContext searchContext)
protected void	addSearchExpando(BooleanQuery searchQuery, SearchContext searchContext, java.lang.String keywords)
protected void	addSearchFolderId(BooleanQuery contextQuery, SearchContext searchContext)
protected void	addSearchGroupId(BooleanQuery contextQuery, SearchContext searchContext)
protected void	addSearchKeywords(BooleanQuery searchQuery, SearchContext searchContext)
protected void	addSearchLayout(BooleanQuery contextQuery, SearchContext searchContext)
protected void	addSearchLocalizedTerm(BooleanQuery searchQuery, SearchContext searchContext, java.lang.String field, boolean like)
protected void	addSearchTerm(BooleanQuery searchQuery, SearchContext searchContext, java.lang.String field, boolean like)
protected void	addSearchUserId(BooleanQuery contextQuery, SearchContext searchContext)
protected void	addStagingGroupKeyword(Document document, long groupId)
protected void	addStatus(BooleanQuery contextQuery, SearchContext searchContext)
protected void	addTrashFields(Document document, TrashedModel trashedModel)
protected BooleanQuery	createFullQuery(BooleanQuery contextQuery, SearchContext searchContext)
protected Summary	createLocalizedSummary(Document document, java.util.Locale locale)
protected Summary	createLocalizedSummary(Document document, java.util.Locale locale, java.lang.String titleField, java.lang.String contentField)
protected Summary	createSummary(Document document)
protected Summary	createSummary(Document document, java.lang.String titleField, java.lang.String contentField)
void	delete(long companyId, java.lang.String uid)
void	delete(java.lang.Object obj)
protected void	deleteDocument(long companyId, long field1)
protected void	deleteDocument(long companyId, long field1, java.lang.String field2)
protected void	deleteDocument(long companyId, java.lang.String field1)
protected void	deleteDocument(long companyId, java.lang.String field1, java.lang.String field2)
protected abstract void	doDelete(java.lang.Object obj)
protected abstract Document	doGetDocument(java.lang.Object obj)
protected java.lang.String	doGetSortField(java.lang.String orderByCol)
protected abstract Summary	doGetSummary(Document document, java.util.Locale locale, java.lang.String snippet, javax.portlet.PortletURL portletURL)
protected abstract void	doReindex(java.lang.Object obj)
protected abstract void	doReindex(java.lang.String[] ids)
protected abstract void	doReindex(java.lang.String className, long classPK)
protected void	doReindexDDMStructures(java.util.List<java.lang.Long> structureIds)
protected Hits	doSearch(SearchContext searchContext)
protected Hits	filterSearch(Hits hits, PermissionChecker permissionChecker, SearchContext searchContext) Deprecated. As of 7.0.0, with no direct replacement
protected Document	getBaseModelDocument(java.lang.String portletId, BaseModel<?> baseModel)
protected Document	getBaseModelDocument(java.lang.String portletId, BaseModel<?> baseModel, BaseModel<?> workflowedBaseModel)
protected java.lang.String	getClassName(SearchContext searchContext)
Document	getDocument(java.lang.Object obj)
BooleanQuery	getFacetQuery(java.lang.String className, SearchContext searchContext)
BooleanQuery	getFullQuery(SearchContext searchContext)
IndexerPostProcessor[]	getIndexerPostProcessors()
protected java.util.Set<java.lang.String>	getLocalizedCountryNames(Country country)
protected long	getParentGroupId(long groupId) Deprecated. As of 6.2.0 renamed to getSiteGroupId(long)
protected abstract java.lang.String	getPortletId(SearchContext searchContext)
java.lang.String	getSearchEngineId()
protected long	getSiteGroupId(long groupId)
protected java.util.Locale	getSnippetLocale(Document document, java.util.Locale locale)
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	isCommitImmediately()
boolean	isFilterSearch()
boolean	isIndexerEnabled()
boolean	isPermissionAware()
boolean	isStagingAware()
protected boolean	isUseSearchResultPermissionFilter(SearchContext searchContext)
protected boolean	isVisible(int entryStatus, int queryStatus)
boolean	isVisible(long classPK, int status)
boolean	isVisibleRelatedEntry(long classPK, int status)
protected Document	newDocument()
protected void	populateAddresses(Document document, java.util.List<Address> addresses, long regionId, long countryId)
protected java.util.Map<java.util.Locale,java.lang.String>	populateMap(AssetEntry assetEntry, java.util.Map<java.util.Locale,java.lang.String> map)
void	postProcessContextQuery(BooleanQuery contextQuery, SearchContext searchContext)
protected void	postProcessFullQuery(BooleanQuery fullQuery, SearchContext searchContext)
void	postProcessSearchQuery(BooleanQuery searchQuery, SearchContext searchContext)
protected void	processHits(SearchContext searchContext, Hits hits)
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	setCommitImmediately(boolean commitImmediately)
protected void	setFilterSearch(boolean filterSearch)
protected void	setIndexerEnabled(boolean indexerEnabled)
protected void	setPermissionAware(boolean permissionAware)
protected void	setSortableTextFields(java.lang.String[] sortableTextFields)
protected void	setStagingAware(boolean stagingAware)
void	unregisterIndexerPostProcessor(IndexerPostProcessor indexerPostProcessor)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.liferay.portal.kernel.search.Indexer

getClassNames, getPortletId

Field Detail

INDEX_FILTER_SEARCH_LIMIT

public static final int INDEX_FILTER_SEARCH_LIMIT

Deprecated. As of 7.0.0, with no direct replacement

Constructor Detail

BaseIndexer

public BaseIndexer()

Method Detail

addRelatedEntryFields

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

Specified by:

addRelatedEntryFields in interface Indexer

Throws:

java.lang.Exception

delete

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

Specified by:

delete in interface Indexer

Throws:

SearchException

delete

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

Specified by:

delete in interface Indexer

Throws:

SearchException

getDocument

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

Specified by:

getDocument in interface Indexer

Throws:

SearchException

getFacetQuery

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

Specified by:

getFacetQuery in interface Indexer

Throws:

java.lang.Exception

getFullQuery

public BooleanQuery getFullQuery(SearchContext searchContext)
                          throws SearchException

Specified by:

getFullQuery in interface Indexer

Throws:

SearchException

getIndexerPostProcessors

public IndexerPostProcessor[] getIndexerPostProcessors()

Specified by:

getIndexerPostProcessors in interface Indexer

getSearchEngineId

public java.lang.String getSearchEngineId()

Specified by:

getSearchEngineId in interface Indexer

getSortField

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

Specified by:

getSortField in interface Indexer

getSortField

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

Specified by:

getSortField in interface Indexer

getSummary

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

Specified by:

getSummary in interface Indexer

Throws:

SearchException

hasPermission

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

Specified by:

hasPermission in interface Indexer

Throws:

java.lang.Exception

isCommitImmediately

public boolean isCommitImmediately()

isFilterSearch

public boolean isFilterSearch()

Specified by:

isFilterSearch in interface Indexer

isIndexerEnabled

public boolean isIndexerEnabled()

isPermissionAware

public boolean isPermissionAware()

Specified by:

isPermissionAware in interface Indexer

isStagingAware

public boolean isStagingAware()

Specified by:

isStagingAware in interface Indexer

isVisible

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

Specified by:

isVisible in interface Indexer

Throws:

java.lang.Exception

isVisibleRelatedEntry

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

Specified by:

isVisibleRelatedEntry in interface Indexer

Throws:

java.lang.Exception

postProcessContextQuery

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

Specified by:

postProcessContextQuery in interface Indexer

Throws:

java.lang.Exception

postProcessSearchQuery

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

Specified by:

postProcessSearchQuery in interface Indexer

Throws:

java.lang.Exception

registerIndexerPostProcessor

public void registerIndexerPostProcessor(IndexerPostProcessor indexerPostProcessor)

Specified by:

registerIndexerPostProcessor in interface Indexer

reindex

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

Specified by:

reindex in interface Indexer

Throws:

SearchException

reindex

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

Specified by:

reindex in interface Indexer

Throws:

SearchException

reindex

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

Specified by:

reindex in interface Indexer

Throws:

SearchException

reindexDDMStructures

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

Specified by:

reindexDDMStructures in interface Indexer

Throws:

SearchException

search

public Hits search(SearchContext searchContext)
            throws SearchException

Specified by:

search in interface Indexer

Throws:

SearchException

setCommitImmediately

public void setCommitImmediately(boolean commitImmediately)

unregisterIndexerPostProcessor

public void unregisterIndexerPostProcessor(IndexerPostProcessor indexerPostProcessor)

Specified by:

unregisterIndexerPostProcessor in interface Indexer

addAssetFields

protected void addAssetFields(Document document,
                  java.lang.String className,
                  long classPK)
                       throws SystemException

Throws:

SystemException

addLocalizedSearchTerm

protected void addLocalizedSearchTerm(BooleanQuery searchQuery,
                          SearchContext searchContext,
                          java.lang.String field,
                          boolean like)
                               throws java.lang.Exception

Deprecated. As of 6.2.0, replaced by addSearchLocalizedTerm(BooleanQuery, SearchContext, String, boolean)

Throws:

java.lang.Exception

addRelatedClassNames

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

Throws:

java.lang.Exception

addSearchArrayQuery

protected void addSearchArrayQuery(BooleanQuery searchQuery,
                       SearchContext searchContext,
                       java.lang.String field)
                            throws java.lang.Exception

Throws:

java.lang.Exception

addSearchAssetCategoryIds

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

Throws:

java.lang.Exception

addSearchAssetCategoryTitles

protected void addSearchAssetCategoryTitles(Document document,
                                java.lang.String field,
                                java.util.List<AssetCategory> assetCategories)

addSearchAssetTagNames

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

Throws:

java.lang.Exception

addSearchClassTypeIds

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

Throws:

java.lang.Exception

addSearchDDMStruture

protected void addSearchDDMStruture(BooleanQuery searchQuery,
                        SearchContext searchContext,
                        DDMStructure ddmStructure)
                             throws java.lang.Exception

Throws:

java.lang.Exception

addSearchEntryClassNames

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

Throws:

java.lang.Exception

addSearchExpando

protected void addSearchExpando(BooleanQuery searchQuery,
                    SearchContext searchContext,
                    java.lang.String keywords)
                         throws java.lang.Exception

Throws:

java.lang.Exception

addSearchFolderId

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

Throws:

java.lang.Exception

addSearchGroupId

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

Throws:

java.lang.Exception

addSearchKeywords

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

Throws:

java.lang.Exception

addSearchLayout

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

Throws:

java.lang.Exception

addSearchLocalizedTerm

protected void addSearchLocalizedTerm(BooleanQuery searchQuery,
                          SearchContext searchContext,
                          java.lang.String field,
                          boolean like)
                               throws java.lang.Exception

Throws:

java.lang.Exception

addSearchTerm

protected void addSearchTerm(BooleanQuery searchQuery,
                 SearchContext searchContext,
                 java.lang.String field,
                 boolean like)
                      throws java.lang.Exception

Throws:

java.lang.Exception

addSearchUserId

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

Throws:

java.lang.Exception

addStagingGroupKeyword

protected void addStagingGroupKeyword(Document document,
                          long groupId)
                               throws java.lang.Exception

Throws:

java.lang.Exception

addStatus

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

Throws:

java.lang.Exception

addTrashFields

protected void addTrashFields(Document document,
                  TrashedModel trashedModel)
                       throws SystemException

Throws:

SystemException

createFullQuery

protected BooleanQuery createFullQuery(BooleanQuery contextQuery,
                           SearchContext searchContext)
                                throws java.lang.Exception

Throws:

java.lang.Exception

createLocalizedSummary

protected Summary createLocalizedSummary(Document document,
                             java.util.Locale locale)

createLocalizedSummary

protected Summary createLocalizedSummary(Document document,
                             java.util.Locale locale,
                             java.lang.String titleField,
                             java.lang.String contentField)

createSummary

protected Summary createSummary(Document document)

createSummary

protected Summary createSummary(Document document,
                    java.lang.String titleField,
                    java.lang.String contentField)

deleteDocument

protected void deleteDocument(long companyId,
                  long field1)
                       throws java.lang.Exception

Throws:

java.lang.Exception

deleteDocument

protected void deleteDocument(long companyId,
                  long field1,
                  java.lang.String field2)
                       throws java.lang.Exception

Throws:

java.lang.Exception

deleteDocument

protected void deleteDocument(long companyId,
                  java.lang.String field1)
                       throws java.lang.Exception

Throws:

java.lang.Exception

deleteDocument

protected void deleteDocument(long companyId,
                  java.lang.String field1,
                  java.lang.String field2)
                       throws java.lang.Exception

Throws:

java.lang.Exception

doDelete

protected abstract void doDelete(java.lang.Object obj)
                          throws java.lang.Exception

Throws:

java.lang.Exception

doGetDocument

protected abstract Document doGetDocument(java.lang.Object obj)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

doGetSortField

protected java.lang.String doGetSortField(java.lang.String orderByCol)

doGetSummary

protected abstract Summary doGetSummary(Document document,
                   java.util.Locale locale,
                   java.lang.String snippet,
                   javax.portlet.PortletURL portletURL)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

doReindex

protected abstract void doReindex(java.lang.Object obj)
                           throws java.lang.Exception

Throws:

java.lang.Exception

doReindex

protected abstract void doReindex(java.lang.String className,
             long classPK)
                           throws java.lang.Exception

Throws:

java.lang.Exception

doReindex

protected abstract void doReindex(java.lang.String[] ids)
                           throws java.lang.Exception

Throws:

java.lang.Exception

doReindexDDMStructures

protected void doReindexDDMStructures(java.util.List<java.lang.Long> structureIds)
                               throws java.lang.Exception

Throws:

java.lang.Exception

doSearch

protected Hits doSearch(SearchContext searchContext)
                 throws SearchException

Throws:

SearchException

filterSearch

protected Hits filterSearch(Hits hits,
                PermissionChecker permissionChecker,
                SearchContext searchContext)

Deprecated. As of 7.0.0, with no direct replacement

getBaseModelDocument

protected Document getBaseModelDocument(java.lang.String portletId,
                            BaseModel<?> baseModel)
                                 throws SystemException

Throws:

SystemException

getBaseModelDocument

protected Document getBaseModelDocument(java.lang.String portletId,
                            BaseModel<?> baseModel,
                            BaseModel<?> workflowedBaseModel)
                                 throws SystemException

Throws:

SystemException

getClassName

protected java.lang.String getClassName(SearchContext searchContext)

getLocalizedCountryNames

protected java.util.Set<java.lang.String> getLocalizedCountryNames(Country country)

getParentGroupId

protected long getParentGroupId(long groupId)

Deprecated. As of 6.2.0 renamed to getSiteGroupId(long)

getPortletId

protected abstract java.lang.String getPortletId(SearchContext searchContext)

getSiteGroupId

protected long getSiteGroupId(long groupId)

getSnippetLocale

protected java.util.Locale getSnippetLocale(Document document,
                                java.util.Locale locale)

isUseSearchResultPermissionFilter

protected boolean isUseSearchResultPermissionFilter(SearchContext searchContext)

isVisible

protected boolean isVisible(int entryStatus,
                int queryStatus)

newDocument

protected Document newDocument()

populateAddresses

protected void populateAddresses(Document document,
                     java.util.List<Address> addresses,
                     long regionId,
                     long countryId)
                          throws PortalException,
                                 SystemException

Throws:

PortalException

SystemException

populateMap

protected java.util.Map<java.util.Locale,java.lang.String> populateMap(AssetEntry assetEntry,
                                                           java.util.Map<java.util.Locale,java.lang.String> map)

postProcessFullQuery

protected void postProcessFullQuery(BooleanQuery fullQuery,
                        SearchContext searchContext)
                             throws java.lang.Exception

Throws:

java.lang.Exception

processHits

protected void processHits(SearchContext searchContext,
               Hits hits)
                    throws SearchException

Throws:

SearchException

setFilterSearch

protected void setFilterSearch(boolean filterSearch)

setIndexerEnabled

protected void setIndexerEnabled(boolean indexerEnabled)

setPermissionAware

protected void setPermissionAware(boolean permissionAware)

setSortableTextFields

protected void setSortableTextFields(java.lang.String[] sortableTextFields)

setStagingAware

protected void setStagingAware(boolean stagingAware)