Liferay 6.2.0

com.liferay.portal.kernel.search
Interface Indexer

All Known Implementing Classes:
AssetCategoryIndexer, AssetIndexer, AssetSearcher, AssetVocabularyIndexer, BaseAlloyIndexer, BaseIndexer, BaseSearcher, BlogsIndexer, BookmarksEntryIndexer, BookmarksFolderIndexer, BookmarksSearcher, CalIndexer, ContactIndexer, DDLIndexer, DLFileEntryIndexer, DLFolderIndexer, DLSearcher, DummyIndexer, FacetedSearcher, FolderSearcher, IndexerWrapper, JournalArticleIndexer, JournalFolderIndexer, JournalSearcher, MBMessageIndexer, MBThreadIndexer, OrganizationIndexer, PluginPackageIndexer, SCIndexer, TrashIndexer, UserGroupIndexer, UserIndexer, WikiNodeIndexer, WikiPageIndexer

public interface Indexer


Field Summary
static int DEFAULT_INTERVAL
           
 
Method Summary
abstract  void addRelatedEntryFields(Document document, Object obj)
           
abstract  void delete(long companyId, String uid)
           
abstract  void delete(Object obj)
           
abstract  String[] getClassNames()
           
abstract  Document getDocument(Object obj)
           
abstract  BooleanQuery getFacetQuery(String className, SearchContext searchContext)
           
abstract  BooleanQuery getFullQuery(SearchContext searchContext)
           
abstract  IndexerPostProcessor[] getIndexerPostProcessors()
           
abstract  String getPortletId()
           
abstract  String getSearchEngineId()
           
abstract  String getSortField(String orderByCol)
           
abstract  String getSortField(String orderByCol, int sortType)
           
abstract  Summary getSummary(Document document, Locale locale, String snippet, PortletURL portletURL)
          Deprecated. As of 7.0.0, replaced by getSummary(Document, Locale, String, PortletURL, PortletRequest, PortletResponse)
abstract  Summary getSummary(Document document, Locale locale, String snippet, PortletURL portletURL, PortletRequest portletRequest, PortletResponse portletResponse)
           
abstract  boolean hasPermission(PermissionChecker permissionChecker, String entryClassName, long entryClassPK, String actionId)
           
abstract  boolean isFilterSearch()
           
abstract  boolean isPermissionAware()
           
abstract  boolean isStagingAware()
           
abstract  boolean isVisible(long classPK, int status)
           
abstract  boolean isVisibleRelatedEntry(long classPK, int status)
           
abstract  void postProcessContextQuery(BooleanQuery contextQuery, SearchContext searchContext)
           
abstract  void postProcessSearchQuery(BooleanQuery searchQuery, SearchContext searchContext)
           
abstract  void registerIndexerPostProcessor(IndexerPostProcessor indexerPostProcessor)
           
abstract  void reindex(Object obj)
           
abstract  void reindex(String[] ids)
           
abstract  void reindex(String className, long classPK)
           
abstract  void reindexDDMStructures(List<Long> ddmStructureIds)
           
abstract  Hits search(SearchContext searchContext)
           
abstract  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,
                           Object obj)
                           throws Exception
Throws:
Exception

delete

void delete(long companyId,
            String uid)
            throws SearchException
Throws:
SearchException

delete

void delete(Object obj)
            throws SearchException
Throws:
SearchException

getClassNames

String[] getClassNames()

getDocument

Document getDocument(Object obj)
                     throws SearchException
Throws:
SearchException

getFacetQuery

BooleanQuery getFacetQuery(String className,
                           SearchContext searchContext)
                           throws Exception
Throws:
Exception

getFullQuery

BooleanQuery getFullQuery(SearchContext searchContext)
                          throws SearchException
Throws:
SearchException

getIndexerPostProcessors

IndexerPostProcessor[] getIndexerPostProcessors()

getPortletId

String getPortletId()

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,
                              PortletURL portletURL)
                   throws SearchException
Deprecated. As of 7.0.0, replaced by getSummary(Document, Locale, String, PortletURL, PortletRequest, PortletResponse)

Throws:
SearchException

getSummary

Summary getSummary(Document document,
                   Locale locale,
                   String snippet,
                   PortletURL portletURL,
                   PortletRequest portletRequest,
                   PortletResponse portletResponse)
                   throws SearchException
Throws:
SearchException

hasPermission

boolean hasPermission(PermissionChecker permissionChecker,
                      String entryClassName,
                      long entryClassPK,
                      String actionId)
                      throws Exception
Throws:
Exception

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

postProcessContextQuery

void postProcessContextQuery(BooleanQuery contextQuery,
                             SearchContext searchContext)
                             throws Exception
Throws:
Exception

postProcessSearchQuery

void postProcessSearchQuery(BooleanQuery searchQuery,
                            SearchContext searchContext)
                            throws Exception
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

reindexDDMStructures

void reindexDDMStructures(List<Long> ddmStructureIds)
                          throws SearchException
Throws:
SearchException

search

Hits search(SearchContext searchContext)
            throws SearchException
Throws:
SearchException

unregisterIndexerPostProcessor

void unregisterIndexerPostProcessor(IndexerPostProcessor indexerPostProcessor)

Liferay 6.2.0