com.liferay.portal.kernel.search
Interface Indexer
- All Known Implementing Classes:
- AssetCategoryIndexer, AssetIndexer, AssetSearcher, AssetVocabularyIndexer, BaseIndexer, BaseSearcher, BlogsIndexer, CalIndexer, ContactIndexer, DLFileEntryIndexer, DLFolderIndexer, DLSearcher, DummyIndexer, ExportImportConfigurationIndexer, FacetedSearcher, FolderSearcher, MBMessageIndexer, MBThreadIndexer, OrganizationIndexer, PluginPackageIndexer, PortletDataContextIndexer, SCIndexer, TrashIndexer, UserGroupIndexer, UserIndexer
public interface Indexer
|
Method Summary |
void |
delete(long companyId,
String uid)
|
void |
delete(Object obj)
|
String |
getClassName()
|
String[] |
getClassNames()
Deprecated. As of 7.0.0, replaced by getSearchClassNames() |
Document |
getDocument(Object obj)
|
BooleanFilter |
getFacetBooleanFilter(String className,
SearchContext searchContext)
|
BooleanQuery |
getFullQuery(SearchContext searchContext)
|
IndexerPostProcessor[] |
getIndexerPostProcessors()
|
String |
getPortletId()
Deprecated. As of 7.0.0, replaced by getClassName() |
String[] |
getSearchClassNames()
|
String |
getSearchEngineId()
|
String |
getSortField(String orderByCol)
|
String |
getSortField(String orderByCol,
int sortType)
|
Summary |
getSummary(Document document,
Locale locale,
String snippet)
Deprecated. As of 7.0.0, replaced by getSummary(Document, String,
PortletRequest, PortletResponse) |
Summary |
getSummary(Document document,
String snippet,
PortletRequest portletRequest,
PortletResponse portletResponse)
|
boolean |
hasPermission(PermissionChecker permissionChecker,
String entryClassName,
long entryClassPK,
String actionId)
|
boolean |
isCommitImmediately()
|
boolean |
isFilterSearch()
|
boolean |
isPermissionAware()
|
boolean |
isStagingAware()
|
boolean |
isVisible(long classPK,
int status)
|
boolean |
isVisibleRelatedEntry(long classPK,
int status)
|
void |
postProcessContextBooleanFilter(BooleanFilter contextBooleanFilter,
SearchContext searchContext)
|
void |
postProcessContextQuery(BooleanQuery contextQuery,
SearchContext searchContext)
Deprecated. As of 7.0.0, replaced by postProcessContextBooleanFilter(
BooleanFilter, 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) |
void |
registerIndexerPostProcessor(IndexerPostProcessor indexerPostProcessor)
|
void |
reindex(Object obj)
|
void |
reindex(String[] ids)
|
void |
reindex(String className,
long classPK)
|
Hits |
search(SearchContext searchContext)
|
Hits |
search(SearchContext searchContext,
String... selectedFieldNames)
|
long |
searchCount(SearchContext searchContext)
|
void |
unregisterIndexerPostProcessor(IndexerPostProcessor indexerPostProcessor)
|
DEFAULT_INTERVAL
static final int DEFAULT_INTERVAL
- See Also:
- Constant Field Values
delete
void delete(long companyId,
String uid)
throws SearchException
- Throws:
SearchException
delete
void delete(Object obj)
throws SearchException
- Throws:
SearchException
getClassName
String getClassName()
getClassNames
@Deprecated
String[] getClassNames()
- Deprecated. As of 7.0.0, replaced by
getSearchClassNames()
getDocument
Document getDocument(Object obj)
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()
getPortletId
@Deprecated
String getPortletId()
- Deprecated. As of 7.0.0, replaced by
getClassName()
getSearchClassNames
String[] getSearchClassNames()
getSearchEngineId
String getSearchEngineId()
getSortField
String getSortField(String orderByCol)
getSortField
String getSortField(String orderByCol,
int sortType)
getSummary
@Deprecated
Summary getSummary(Document document,
Locale locale,
String snippet)
throws SearchException
- Deprecated. As of 7.0.0, replaced by
getSummary(Document, String,
PortletRequest, PortletResponse)
- Throws:
SearchException
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()
isPermissionAware
boolean isPermissionAware()
isStagingAware
boolean isStagingAware()
isVisible
boolean isVisible(long classPK,
int status)
throws Exception
- Throws:
Exception
isVisibleRelatedEntry
boolean isVisibleRelatedEntry(long classPK,
int status)
throws Exception
- 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 7.0.0, 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 7.0.0, replaced by
postProcessSearchQuery(
BooleanQuery, BooleanFilter, SearchContext)
- Throws:
Exception
registerIndexerPostProcessor
void registerIndexerPostProcessor(IndexerPostProcessor indexerPostProcessor)
reindex
void reindex(Object obj)
throws SearchException
- Throws:
SearchException
reindex
void reindex(String className,
long classPK)
throws SearchException
- Throws:
SearchException
reindex
void reindex(String[] ids)
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
unregisterIndexerPostProcessor
void unregisterIndexerPostProcessor(IndexerPostProcessor indexerPostProcessor)