com.liferay.portal.kernel.search.dummy

Class DummyIndexer

java.lang.Object

com.liferay.portal.kernel.search.dummy.DummyIndexer

All Implemented Interfaces:

Indexer<java.lang.Object>

public class DummyIndexer
extends java.lang.Object
implements Indexer<java.lang.Object>

Author:

Brian Wing Shun Chan

Field Summary

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

DEFAULT_INTERVAL

Constructor Summary

Constructors

Constructor and Description
DummyIndexer()

Method Summary

Modifier and Type	Method and Description
void	delete(long companyId, java.lang.String uid)
void	delete(java.lang.Object object)
java.lang.String	getClassName()
Document	getDocument(java.lang.Object object)
BooleanFilter	getFacetBooleanFilter(java.lang.String className, SearchContext searchContext)
BooleanQuery	getFullQuery(SearchContext searchContext)
IndexerPostProcessor[]	getIndexerPostProcessors()
java.lang.String[]	getSearchClassNames()
java.lang.String	getSearchEngineId()
java.lang.String	getSortField(java.lang.String orderByCol)
java.lang.String	getSortField(java.lang.String orderByCol, int sortType)
Summary	getSummary(Document document, java.lang.String snippet, javax.portlet.PortletRequest portletRequest, javax.portlet.PortletResponse portletResponse)
boolean	hasPermission(PermissionChecker permissionChecker, java.lang.String entryClassName, long entryClassPK, java.lang.String actionId)
boolean	isCommitImmediately()
boolean	isFilterSearch() Return true if the indexer participates in post-search result filtering.
boolean	isIndexerEnabled()
boolean	isPermissionAware() Returns true if the indexer adds permission related filters to the search query prior to execution
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 Wilberforce (7.0.x), replaced by postProcessContextBooleanFilter(BooleanFilter, SearchContext)
void	postProcessSearchQuery(BooleanQuery searchQuery, BooleanFilter fullQueryBooleanFilter, SearchContext searchContext)
void	postProcessSearchQuery(BooleanQuery searchQuery, SearchContext searchContext) Deprecated. As of Wilberforce (7.0.x), replaced by postProcessSearchQuery(BooleanQuery, BooleanFilter, SearchContext)
void	registerIndexerPostProcessor(IndexerPostProcessor indexerPostProcessor)
void	reindex(java.util.Collection<java.lang.Object> objects)
void	reindex(java.lang.Object obj)
void	reindex(java.lang.String[] ids)
void	reindex(java.lang.String className, long classPK)
Hits	search(SearchContext searchContext)
Hits	search(SearchContext searchContext, java.lang.String... selectedFieldNames)
long	searchCount(SearchContext searchContext)
void	setIndexerEnabled(boolean indexerEnabled)
void	unregisterIndexerPostProcessor(IndexerPostProcessor indexerPostProcessor)

Methods inherited from class java.lang.Object

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

Constructor Detail

DummyIndexer

public DummyIndexer()

Method Detail

delete

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

Specified by:

delete in interface Indexer<java.lang.Object>

delete

public void delete(java.lang.Object object)

Specified by:

delete in interface Indexer<java.lang.Object>

getClassName

public java.lang.String getClassName()

Specified by:

getClassName in interface Indexer<java.lang.Object>

getDocument

public Document getDocument(java.lang.Object object)

Specified by:

getDocument in interface Indexer<java.lang.Object>

getFacetBooleanFilter

public BooleanFilter getFacetBooleanFilter(java.lang.String className,
                                           SearchContext searchContext)

Specified by:

getFacetBooleanFilter in interface Indexer<java.lang.Object>

getFullQuery

public BooleanQuery getFullQuery(SearchContext searchContext)

Specified by:

getFullQuery in interface Indexer<java.lang.Object>

getIndexerPostProcessors

public IndexerPostProcessor[] getIndexerPostProcessors()

Specified by:

getIndexerPostProcessors in interface Indexer<java.lang.Object>

getSearchClassNames

public java.lang.String[] getSearchClassNames()

Specified by:

getSearchClassNames in interface Indexer<java.lang.Object>

getSearchEngineId

public java.lang.String getSearchEngineId()

Specified by:

getSearchEngineId in interface Indexer<java.lang.Object>

getSortField

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

Specified by:

getSortField in interface Indexer<java.lang.Object>

getSortField

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

Specified by:

getSortField in interface Indexer<java.lang.Object>

getSummary

public Summary getSummary(Document document,
                          java.lang.String snippet,
                          javax.portlet.PortletRequest portletRequest,
                          javax.portlet.PortletResponse portletResponse)

Specified by:

getSummary in interface Indexer<java.lang.Object>

hasPermission

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

Specified by:

hasPermission in interface Indexer<java.lang.Object>

isCommitImmediately

public boolean isCommitImmediately()

Specified by:

isCommitImmediately in interface Indexer<java.lang.Object>

isFilterSearch

public boolean isFilterSearch()

Description copied from interface: Indexer

Return true if the indexer participates in post-search result filtering.

Specified by:

isFilterSearch in interface Indexer<java.lang.Object>

Returns:

true if the indexer participates in post-search result filtering; false otherwise

See Also:

SearchResultPermissionFilter

isIndexerEnabled

public boolean isIndexerEnabled()

Specified by:

isIndexerEnabled in interface Indexer<java.lang.Object>

isPermissionAware

public boolean isPermissionAware()

Description copied from interface: Indexer

Returns true if the indexer adds permission related filters to the search query prior to execution

Specified by:

isPermissionAware in interface Indexer<java.lang.Object>

Returns:

true if the indexer adds permission related filters to the search query prior to execution; false otherwise

See Also:

SearchPermissionChecker

isStagingAware

public boolean isStagingAware()

Specified by:

isStagingAware in interface Indexer<java.lang.Object>

isVisible

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

Specified by:

isVisible in interface Indexer<java.lang.Object>

Throws:

java.lang.Exception

isVisibleRelatedEntry

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

Specified by:

isVisibleRelatedEntry in interface Indexer<java.lang.Object>

Returns:

Throws:

java.lang.Exception

postProcessContextBooleanFilter

public void postProcessContextBooleanFilter(BooleanFilter contextBooleanFilter,
                                            SearchContext searchContext)
                                     throws java.lang.Exception

Specified by:

postProcessContextBooleanFilter in interface Indexer<java.lang.Object>

Throws:

java.lang.Exception

postProcessContextQuery

@Deprecated
public void postProcessContextQuery(BooleanQuery contextQuery,
                                                SearchContext searchContext)

Deprecated. As of Wilberforce (7.0.x), replaced by postProcessContextBooleanFilter(BooleanFilter, SearchContext)

Specified by:

postProcessContextQuery in interface Indexer<java.lang.Object>

postProcessSearchQuery

public void postProcessSearchQuery(BooleanQuery searchQuery,
                                   BooleanFilter fullQueryBooleanFilter,
                                   SearchContext searchContext)

Specified by:

postProcessSearchQuery in interface Indexer<java.lang.Object>

postProcessSearchQuery

@Deprecated
public void postProcessSearchQuery(BooleanQuery searchQuery,
                                               SearchContext searchContext)

Deprecated. As of Wilberforce (7.0.x), replaced by postProcessSearchQuery(BooleanQuery, BooleanFilter, SearchContext)

Specified by:

postProcessSearchQuery in interface Indexer<java.lang.Object>

registerIndexerPostProcessor

public void registerIndexerPostProcessor(IndexerPostProcessor indexerPostProcessor)

Specified by:

registerIndexerPostProcessor in interface Indexer<java.lang.Object>

reindex

public void reindex(java.util.Collection<java.lang.Object> objects)

Specified by:

reindex in interface Indexer<java.lang.Object>

reindex

public void reindex(java.lang.Object obj)

Specified by:

reindex in interface Indexer<java.lang.Object>

reindex

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

Specified by:

reindex in interface Indexer<java.lang.Object>

reindex

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

Specified by:

reindex in interface Indexer<java.lang.Object>

search

public Hits search(SearchContext searchContext)

Specified by:

search in interface Indexer<java.lang.Object>

search

public Hits search(SearchContext searchContext,
                   java.lang.String... selectedFieldNames)

Specified by:

search in interface Indexer<java.lang.Object>

searchCount

public long searchCount(SearchContext searchContext)

Specified by:

searchCount in interface Indexer<java.lang.Object>

setIndexerEnabled

public void setIndexerEnabled(boolean indexerEnabled)

Specified by:

setIndexerEnabled in interface Indexer<java.lang.Object>

unregisterIndexerPostProcessor

public void unregisterIndexerPostProcessor(IndexerPostProcessor indexerPostProcessor)

Specified by:

unregisterIndexerPostProcessor in interface Indexer<java.lang.Object>