public abstract class BaseIndexer<T> extends java.lang.Object implements Indexer<T>
DEFAULT_INTERVAL| Constructor and Description |
|---|
BaseIndexer() |
| Modifier and Type | Method and Description |
|---|---|
protected void |
addAssetFields(Document document,
java.lang.String className,
long classPK) |
protected void |
addDefaultHighlightFieldNames(QueryConfig queryConfig) |
protected void |
addDefaultSelectedFieldNames(SearchContext searchContext) |
protected void |
addFacetClause(SearchContext searchContext,
BooleanFilter facetBooleanFilter,
java.util.Collection<Facet> facets)
Deprecated.
As of 7.0.0
|
protected void |
addFacetSelectedFieldNames(SearchContext searchContext,
QueryConfig queryConfig) |
protected void |
addSearchAssetCategoryIds(BooleanFilter queryBooleanFilter,
SearchContext searchContext) |
protected void |
addSearchAssetCategoryTitles(Document document,
java.lang.String field,
java.util.List<AssetCategory> assetCategories) |
protected void |
addSearchAssetTagNames(BooleanFilter queryBooleanFilter,
SearchContext searchContext) |
protected Filter |
addSearchClassTypeIds(BooleanFilter contextBooleanFilter,
SearchContext searchContext) |
protected void |
addSearchEntryClassNames(BooleanFilter queryBooleanFilter,
SearchContext searchContext) |
protected java.util.Map<java.lang.String,Query> |
addSearchExpando(BooleanQuery searchQuery,
SearchContext searchContext,
java.lang.String keywords) |
protected void |
addSearchFolderId(BooleanFilter queryBooleanFilter,
SearchContext searchContext) |
protected void |
addSearchGroupId(BooleanFilter queryBooleanFilter,
SearchContext searchContext) |
protected java.util.Map<java.lang.String,Query> |
addSearchKeywords(BooleanQuery searchQuery,
SearchContext searchContext) |
protected void |
addSearchLayout(BooleanFilter queryBooleanFilter,
SearchContext searchContext) |
protected java.util.Map<java.lang.String,Query> |
addSearchLocalizedTerm(BooleanQuery searchQuery,
SearchContext searchContext,
java.lang.String field,
boolean like) |
protected Query |
addSearchTerm(BooleanQuery searchQuery,
SearchContext searchContext,
java.lang.String field,
boolean like) |
protected void |
addSearchUserId(BooleanFilter queryBooleanFilter,
SearchContext searchContext) |
protected void |
addSelectedLocalizedFieldNames(java.util.Set<java.lang.String> selectedFieldNames,
java.lang.String... languageIds) |
protected void |
addStagingGroupKeyword(Document document,
long groupId) |
protected void |
addStatus(BooleanFilter contextBooleanFilter,
SearchContext searchContext) |
protected void |
addTrashFields(Document document,
TrashedModel trashedModel) |
protected BooleanQuery |
createFullQuery(BooleanFilter fullQueryBooleanFilter,
SearchContext searchContext) |
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(T object) |
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(T object) |
protected abstract Document |
doGetDocument(T object) |
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.PortletRequest portletRequest,
javax.portlet.PortletResponse portletResponse) |
protected void |
doPostProcessSearchQuery(Indexer<?> indexer,
BooleanQuery searchQuery,
SearchContext searchContext)
Deprecated.
As of 7.0.0, added strictly to support backwards
compatibility of
Indexer.postProcessSearchQuery(BooleanQuery, SearchContext) |
protected abstract void |
doReindex(java.lang.String[] ids) |
protected abstract void |
doReindex(java.lang.String className,
long classPK) |
protected abstract void |
doReindex(T object) |
protected Hits |
doSearch(SearchContext searchContext) |
boolean |
equals(java.lang.Object object) |
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) |
java.lang.String[] |
getClassNames()
Deprecated.
As of 7.0.0, replaced by
getSearchClassNames() |
protected java.lang.String[] |
getDefaultSelectedFieldNames() |
protected java.lang.String[] |
getDefaultSelectedLocalizedFieldNames() |
Document |
getDocument(T object) |
protected java.lang.String |
getExpandoFieldName(SearchContext searchContext,
ExpandoBridge expandoBridge,
java.lang.String attributeName) |
BooleanFilter |
getFacetBooleanFilter(java.lang.String className,
SearchContext searchContext) |
BooleanQuery |
getFullQuery(SearchContext searchContext) |
IndexerPostProcessor[] |
getIndexerPostProcessors() |
protected java.util.Locale |
getLocale(javax.portlet.PortletRequest portletRequest) |
protected java.util.Set<java.lang.String> |
getLocalizedCountryNames(Country country) |
java.lang.String |
getPortletId()
Deprecated.
As of 7.0.0, replaced by
getClassName(com.liferay.portal.kernel.search.SearchContext) |
protected java.lang.String |
getPortletId(SearchContext searchContext)
Deprecated.
As of 7.0.0 replaced by
getClassName(com.liferay.portal.kernel.search.SearchContext) |
java.lang.String[] |
getSearchClassNames() |
java.lang.String |
getSearchEngineId() |
protected Group |
getSiteGroup(long groupId) |
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)
Deprecated.
As of 7.0.0, replaced by
getSummary(Document, String,
PortletRequest, PortletResponse) |
Summary |
getSummary(Document document,
java.lang.String snippet,
javax.portlet.PortletRequest portletRequest,
javax.portlet.PortletResponse portletResponse) |
int |
hashCode() |
boolean |
hasPermission(PermissionChecker permissionChecker,
java.lang.String entryClassName,
long entryClassPK,
java.lang.String actionId) |
boolean |
isCommitImmediately() |
boolean |
isFilterSearch() |
boolean |
isIndexerEnabled() |
boolean |
isPermissionAware() |
boolean |
isSelectAllLocales() |
boolean |
isStagingAware() |
protected boolean |
isStagingGroup(long groupId) |
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 |
postProcessContextBooleanFilter(BooleanFilter contextBooleanFilter,
SearchContext searchContext) |
void |
postProcessContextQuery(BooleanQuery contextQuery,
SearchContext searchContext)
Deprecated.
As of 7.0.0, replaced by
postProcessContextBooleanFilter(BooleanFilter,
SearchContext) |
protected void |
postProcessFullQuery(BooleanQuery fullQuery,
SearchContext searchContext) |
void |
postProcessSearchQuery(BooleanQuery searchQuery,
BooleanFilter fullQueryBooleanFilter,
SearchContext searchContext) |
void |
postProcessSearchQuery(BooleanQuery searchQuery,
SearchContext searchContext)
Deprecated.
As of 7.0.0, replaced by
postProcessSearchQuery(BooleanQuery, BooleanFilter,
SearchContext) |
protected void |
processHits(SearchContext searchContext,
Hits hits) |
void |
registerIndexerPostProcessor(IndexerPostProcessor indexerPostProcessor) |
void |
reindex(java.util.Collection<T> collection) |
void |
reindex(java.lang.String[] ids) |
void |
reindex(java.lang.String className,
long classPK) |
void |
reindex(T object) |
protected void |
resetFullQuery(SearchContext searchContext) |
Hits |
search(SearchContext searchContext) |
Hits |
search(SearchContext searchContext,
java.lang.String... selectedFieldNames) |
long |
searchCount(SearchContext searchContext) |
void |
setCommitImmediately(boolean commitImmediately) |
protected void |
setDefaultSelectedFieldNames(java.lang.String... defaultLocalizedFieldNames) |
protected void |
setDefaultSelectedLocalizedFieldNames(java.lang.String... defaultLocalizedFieldNames) |
protected void |
setFilterSearch(boolean filterSearch) |
void |
setIndexerEnabled(boolean indexerEnabled) |
protected void |
setPermissionAware(boolean permissionAware) |
void |
setSelectAllLocales(boolean selectAllLocales) |
protected void |
setStagingAware(boolean stagingAware) |
void |
unregisterIndexerPostProcessor(IndexerPostProcessor indexerPostProcessor) |
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitgetClassNamepublic void delete(long companyId,
java.lang.String uid)
throws SearchException
delete in interface Indexer<T>SearchExceptionpublic void delete(T object) throws SearchException
delete in interface Indexer<T>SearchExceptionpublic boolean equals(java.lang.Object object)
equals in class java.lang.Object@Deprecated public java.lang.String[] getClassNames()
getSearchClassNames()getClassNames in interface Indexer<T>public Document getDocument(T object) throws SearchException
getDocument in interface Indexer<T>SearchExceptionpublic BooleanFilter getFacetBooleanFilter(java.lang.String className, SearchContext searchContext) throws java.lang.Exception
getFacetBooleanFilter in interface Indexer<T>java.lang.Exceptionpublic BooleanQuery getFullQuery(SearchContext searchContext) throws SearchException
getFullQuery in interface Indexer<T>SearchExceptionpublic IndexerPostProcessor[] getIndexerPostProcessors()
getIndexerPostProcessors in interface Indexer<T>@Deprecated public java.lang.String getPortletId()
getClassName(com.liferay.portal.kernel.search.SearchContext)getPortletId in interface Indexer<T>public java.lang.String[] getSearchClassNames()
getSearchClassNames in interface Indexer<T>public java.lang.String getSearchEngineId()
getSearchEngineId in interface Indexer<T>public java.lang.String getSortField(java.lang.String orderByCol)
getSortField in interface Indexer<T>public java.lang.String getSortField(java.lang.String orderByCol,
int sortType)
getSortField in interface Indexer<T>@Deprecated public Summary getSummary(Document document, java.util.Locale locale, java.lang.String snippet) throws SearchException
getSummary(Document, String,
PortletRequest, PortletResponse)getSummary in interface Indexer<T>SearchExceptionpublic Summary getSummary(Document document, java.lang.String snippet, javax.portlet.PortletRequest portletRequest, javax.portlet.PortletResponse portletResponse) throws SearchException
getSummary in interface Indexer<T>SearchExceptionpublic int hashCode()
hashCode in class java.lang.Objectpublic boolean hasPermission(PermissionChecker permissionChecker, java.lang.String entryClassName, long entryClassPK, java.lang.String actionId) throws java.lang.Exception
hasPermission in interface Indexer<T>java.lang.Exceptionpublic boolean isCommitImmediately()
isCommitImmediately in interface Indexer<T>public boolean isFilterSearch()
isFilterSearch in interface Indexer<T>public boolean isIndexerEnabled()
isIndexerEnabled in interface Indexer<T>public boolean isPermissionAware()
isPermissionAware in interface Indexer<T>public boolean isSelectAllLocales()
public boolean isStagingAware()
isStagingAware in interface Indexer<T>public boolean isVisible(long classPK,
int status)
throws java.lang.Exception
public boolean isVisibleRelatedEntry(long classPK,
int status)
throws java.lang.Exception
isVisibleRelatedEntry in interface Indexer<T>java.lang.Exceptionpublic void postProcessContextBooleanFilter(BooleanFilter contextBooleanFilter, SearchContext searchContext) throws java.lang.Exception
postProcessContextBooleanFilter in interface Indexer<T>java.lang.Exception@Deprecated public void postProcessContextQuery(BooleanQuery contextQuery, SearchContext searchContext) throws java.lang.Exception
postProcessContextBooleanFilter(BooleanFilter,
SearchContext)postProcessContextQuery in interface Indexer<T>java.lang.Exceptionpublic void postProcessSearchQuery(BooleanQuery searchQuery, BooleanFilter fullQueryBooleanFilter, SearchContext searchContext) throws java.lang.Exception
postProcessSearchQuery in interface Indexer<T>java.lang.Exception@Deprecated public void postProcessSearchQuery(BooleanQuery searchQuery, SearchContext searchContext) throws java.lang.Exception
postProcessSearchQuery(BooleanQuery, BooleanFilter,
SearchContext)postProcessSearchQuery in interface Indexer<T>java.lang.Exceptionpublic void registerIndexerPostProcessor(IndexerPostProcessor indexerPostProcessor)
registerIndexerPostProcessor in interface Indexer<T>public void reindex(java.util.Collection<T> collection)
public void reindex(java.lang.String className,
long classPK)
throws SearchException
reindex in interface Indexer<T>SearchExceptionpublic void reindex(java.lang.String[] ids)
throws SearchException
reindex in interface Indexer<T>SearchExceptionpublic void reindex(T object) throws SearchException
reindex in interface Indexer<T>SearchExceptionpublic Hits search(SearchContext searchContext) throws SearchException
search in interface Indexer<T>SearchExceptionpublic Hits search(SearchContext searchContext, java.lang.String... selectedFieldNames) throws SearchException
search in interface Indexer<T>SearchExceptionpublic long searchCount(SearchContext searchContext) throws SearchException
searchCount in interface Indexer<T>SearchExceptionpublic void setCommitImmediately(boolean commitImmediately)
public void setIndexerEnabled(boolean indexerEnabled)
setIndexerEnabled in interface Indexer<T>public void setSelectAllLocales(boolean selectAllLocales)
public void unregisterIndexerPostProcessor(IndexerPostProcessor indexerPostProcessor)
unregisterIndexerPostProcessor in interface Indexer<T>protected void addAssetFields(Document document, java.lang.String className, long classPK)
protected void addDefaultHighlightFieldNames(QueryConfig queryConfig)
protected void addDefaultSelectedFieldNames(SearchContext searchContext)
@Deprecated protected void addFacetClause(SearchContext searchContext, BooleanFilter facetBooleanFilter, java.util.Collection<Facet> facets) throws ParseException
ParseExceptionprotected void addFacetSelectedFieldNames(SearchContext searchContext, QueryConfig queryConfig)
protected void addSearchAssetCategoryIds(BooleanFilter queryBooleanFilter, SearchContext searchContext) throws java.lang.Exception
java.lang.Exceptionprotected void addSearchAssetCategoryTitles(Document document, java.lang.String field, java.util.List<AssetCategory> assetCategories)
protected void addSearchAssetTagNames(BooleanFilter queryBooleanFilter, SearchContext searchContext) throws java.lang.Exception
java.lang.Exceptionprotected Filter addSearchClassTypeIds(BooleanFilter contextBooleanFilter, SearchContext searchContext) throws java.lang.Exception
java.lang.Exceptionprotected void addSearchEntryClassNames(BooleanFilter queryBooleanFilter, SearchContext searchContext) throws java.lang.Exception
java.lang.Exceptionprotected java.util.Map<java.lang.String,Query> addSearchExpando(BooleanQuery searchQuery, SearchContext searchContext, java.lang.String keywords) throws java.lang.Exception
java.lang.Exceptionprotected void addSearchFolderId(BooleanFilter queryBooleanFilter, SearchContext searchContext) throws java.lang.Exception
java.lang.Exceptionprotected void addSearchGroupId(BooleanFilter queryBooleanFilter, SearchContext searchContext) throws java.lang.Exception
java.lang.Exceptionprotected java.util.Map<java.lang.String,Query> addSearchKeywords(BooleanQuery searchQuery, SearchContext searchContext) throws java.lang.Exception
java.lang.Exceptionprotected void addSearchLayout(BooleanFilter queryBooleanFilter, SearchContext searchContext) throws java.lang.Exception
java.lang.Exceptionprotected java.util.Map<java.lang.String,Query> addSearchLocalizedTerm(BooleanQuery searchQuery, SearchContext searchContext, java.lang.String field, boolean like) throws java.lang.Exception
java.lang.Exceptionprotected Query addSearchTerm(BooleanQuery searchQuery, SearchContext searchContext, java.lang.String field, boolean like) throws java.lang.Exception
java.lang.Exceptionprotected void addSearchUserId(BooleanFilter queryBooleanFilter, SearchContext searchContext) throws java.lang.Exception
java.lang.Exceptionprotected void addSelectedLocalizedFieldNames(java.util.Set<java.lang.String> selectedFieldNames,
java.lang.String... languageIds)
protected void addStagingGroupKeyword(Document document, long groupId)
protected void addStatus(BooleanFilter contextBooleanFilter, SearchContext searchContext) throws java.lang.Exception
java.lang.Exceptionprotected void addTrashFields(Document document, TrashedModel trashedModel)
protected BooleanQuery createFullQuery(BooleanFilter fullQueryBooleanFilter, SearchContext searchContext) throws java.lang.Exception
java.lang.Exceptionprotected Summary createSummary(Document document, java.lang.String titleField, java.lang.String contentField)
protected void deleteDocument(long companyId,
long field1)
throws java.lang.Exception
java.lang.Exceptionprotected void deleteDocument(long companyId,
long field1,
java.lang.String field2)
throws java.lang.Exception
java.lang.Exceptionprotected void deleteDocument(long companyId,
java.lang.String field1)
throws java.lang.Exception
java.lang.Exceptionprotected void deleteDocument(long companyId,
java.lang.String field1,
java.lang.String field2)
throws java.lang.Exception
java.lang.Exceptionprotected abstract void doDelete(T object) throws java.lang.Exception
java.lang.Exceptionprotected abstract Document doGetDocument(T object) throws java.lang.Exception
java.lang.Exceptionprotected java.lang.String doGetSortField(java.lang.String orderByCol)
protected abstract Summary doGetSummary(Document document, java.util.Locale locale, java.lang.String snippet, javax.portlet.PortletRequest portletRequest, javax.portlet.PortletResponse portletResponse) throws java.lang.Exception
java.lang.Exception@Deprecated protected void doPostProcessSearchQuery(Indexer<?> indexer, BooleanQuery searchQuery, SearchContext searchContext) throws java.lang.Exception
Indexer.postProcessSearchQuery(BooleanQuery, SearchContext)java.lang.Exceptionprotected abstract void doReindex(java.lang.String className,
long classPK)
throws java.lang.Exception
java.lang.Exceptionprotected abstract void doReindex(java.lang.String[] ids)
throws java.lang.Exception
java.lang.Exceptionprotected abstract void doReindex(T object) throws java.lang.Exception
java.lang.Exceptionprotected Hits doSearch(SearchContext searchContext) throws SearchException
SearchExceptionprotected 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)
protected java.lang.String[] getDefaultSelectedFieldNames()
protected java.lang.String[] getDefaultSelectedLocalizedFieldNames()
protected java.lang.String getExpandoFieldName(SearchContext searchContext, ExpandoBridge expandoBridge, java.lang.String attributeName)
protected java.util.Locale getLocale(javax.portlet.PortletRequest portletRequest)
protected java.util.Set<java.lang.String> getLocalizedCountryNames(Country country)
@Deprecated protected java.lang.String getPortletId(SearchContext searchContext)
getClassName(com.liferay.portal.kernel.search.SearchContext)protected Group getSiteGroup(long groupId)
protected long getSiteGroupId(long groupId)
protected java.util.Locale getSnippetLocale(Document document, java.util.Locale locale)
protected boolean isStagingGroup(long groupId)
protected boolean isUseSearchResultPermissionFilter(SearchContext searchContext)
protected boolean isVisible(int entryStatus,
int queryStatus)
protected Document newDocument()
protected void populateAddresses(Document document, java.util.List<Address> addresses, long regionId, long countryId) throws PortalException
PortalExceptionprotected java.util.Map<java.util.Locale,java.lang.String> populateMap(AssetEntry assetEntry, java.util.Map<java.util.Locale,java.lang.String> map)
protected void postProcessFullQuery(BooleanQuery fullQuery, SearchContext searchContext) throws java.lang.Exception
java.lang.Exceptionprotected void processHits(SearchContext searchContext, Hits hits) throws SearchException
SearchExceptionprotected void resetFullQuery(SearchContext searchContext)
protected void setDefaultSelectedFieldNames(java.lang.String... defaultLocalizedFieldNames)
protected void setDefaultSelectedLocalizedFieldNames(java.lang.String... defaultLocalizedFieldNames)
protected void setFilterSearch(boolean filterSearch)
protected void setPermissionAware(boolean permissionAware)
protected void setStagingAware(boolean stagingAware)