Liferay 6.2-ce-ga5

com.liferay.portal.kernel.search
Interface Indexer

All Known Implementing Classes:
BaseAlloyIndexer, BaseIndexer, BaseSearcher, DummyIndexer, FacetedSearcher, FolderSearcher, IndexerWrapper

public interface Indexer


Field Summary
static int DEFAULT_INTERVAL
           
 
Method Summary
 void addRelatedEntryFields(Document document, Object obj)
           
 void delete(long companyId, String uid)
           
 void delete(Object obj)
           
 String[] getClassNames()
           
 Document getDocument(Object obj)
           
 BooleanQuery getFacetQuery(String className, SearchContext searchContext)
           
 BooleanQuery getFullQuery(SearchContext searchContext)
           
 IndexerPostProcessor[] getIndexerPostProcessors()
           
 String getPortletId()
           
 String getSearchEngineId()
           
 String getSortField(String orderByCol)
           
 String getSortField(String orderByCol, int sortType)
           
 Summary getSummary(Document document, Locale locale, String snippet, PortletURL portletURL)
           
 boolean hasPermission(PermissionChecker permissionChecker, String entryClassName, long entryClassPK, 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(Object obj)
           
 void reindex(String[] ids)
           
 void reindex(String className, long classPK)
           
 void reindexDDMStructures(List<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,
                           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

Summary getSummary(Document document,
                   Locale locale,
                   String snippet,
                   PortletURL portletURL)
                   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-ce-ga5