com.liferay.portal.search.lucene

Interface LuceneHelper

All Known Implementing Classes:

LuceneHelperImpl

public interface LuceneHelper

Author:

Bruno Farache, Shuyang Zhou, Andrea Di Giorgi

Method Summary

Methods

Modifier and Type	Method and Description
void	addDocument(long companyId, org.apache.lucene.document.Document document)
void	addExactTerm(org.apache.lucene.search.BooleanQuery booleanQuery, java.lang.String field, java.lang.String value)
void	addNumericRangeTerm(org.apache.lucene.search.BooleanQuery booleanQuery, java.lang.String field, java.lang.Integer startValue, java.lang.Integer endValue)
void	addNumericRangeTerm(org.apache.lucene.search.BooleanQuery booleanQuery, java.lang.String field, java.lang.Long startValue, java.lang.Long endValue)
void	addNumericRangeTerm(org.apache.lucene.search.BooleanQuery booleanQuery, java.lang.String field, java.lang.String startValue, java.lang.String endValue) Deprecated. As of 6.2.0, replaced by addNumericRangeTerm(BooleanQuery, String, Long, Long)
void	addRangeTerm(org.apache.lucene.search.BooleanQuery booleanQuery, java.lang.String field, java.lang.String startValue, java.lang.String endValue)
void	addRequiredTerm(org.apache.lucene.search.BooleanQuery booleanQuery, java.lang.String field, java.lang.String[] values, boolean like)
void	addRequiredTerm(org.apache.lucene.search.BooleanQuery booleanQuery, java.lang.String field, java.lang.String value, boolean like)
void	addTerm(org.apache.lucene.search.BooleanQuery booleanQuery, java.lang.String field, java.lang.String[] values, boolean like)
void	addTerm(org.apache.lucene.search.BooleanQuery booleanQuery, java.lang.String field, java.lang.String value, boolean like)
void	addTerm(org.apache.lucene.search.BooleanQuery booleanQuery, java.lang.String field, java.lang.String value, boolean like, com.liferay.portal.kernel.search.BooleanClauseOccur booleanClauseOccur)
void	cleanUp(org.apache.lucene.search.IndexSearcher indexSearcher) Deprecated. As of 7.0.0, replaced by releaseIndexSearcher(long, IndexSearcher)
int	countScoredFieldNames(org.apache.lucene.search.Query query, java.lang.String[] fieldNames)
void	delete(long companyId)
void	deleteDocuments(long companyId, org.apache.lucene.index.Term term)
void	dumpIndex(long companyId, java.io.OutputStream outputStream)
org.apache.lucene.analysis.Analyzer	getAnalyzer()
IndexAccessor	getIndexAccessor(long companyId)
org.apache.lucene.search.IndexSearcher	getIndexSearcher(long companyId)
long	getLastGeneration(long companyId)
java.io.InputStream	getLoadIndexesInputStreamFromCluster(long companyId, com.liferay.portal.kernel.cluster.Address bootupAddress)
java.util.Set<java.lang.String>	getQueryTerms(org.apache.lucene.search.Query query)
org.apache.lucene.search.IndexSearcher	getSearcher(long companyId, boolean readOnly) Deprecated. As of 7.0.0, replaced by getIndexSearcher(long)
java.lang.String	getSnippet(org.apache.lucene.search.Query query, java.lang.String field, java.lang.String s, int maxNumFragments, int fragmentLength, java.lang.String fragmentSuffix, org.apache.lucene.search.highlight.Formatter formatter)
org.apache.lucene.util.Version	getVersion()
boolean	isLoadIndexFromClusterEnabled()
void	loadIndex(long companyId, java.io.InputStream inputStream)
void	loadIndexesFromCluster(long companyId)
void	releaseIndexSearcher(long companyId, org.apache.lucene.search.IndexSearcher indexSearcher)
void	shutdown()
void	shutdown(long companyId)
void	startup(long companyId)
void	updateDocument(long companyId, org.apache.lucene.index.Term term, org.apache.lucene.document.Document document)

Method Detail

addDocument

void addDocument(long companyId,
               org.apache.lucene.document.Document document)
                 throws java.io.IOException

Throws:

java.io.IOException

addExactTerm

void addExactTerm(org.apache.lucene.search.BooleanQuery booleanQuery,
                java.lang.String field,
                java.lang.String value)

addNumericRangeTerm

void addNumericRangeTerm(org.apache.lucene.search.BooleanQuery booleanQuery,
                       java.lang.String field,
                       java.lang.Integer startValue,
                       java.lang.Integer endValue)

addNumericRangeTerm

void addNumericRangeTerm(org.apache.lucene.search.BooleanQuery booleanQuery,
                       java.lang.String field,
                       java.lang.Long startValue,
                       java.lang.Long endValue)

addNumericRangeTerm

void addNumericRangeTerm(org.apache.lucene.search.BooleanQuery booleanQuery,
                       java.lang.String field,
                       java.lang.String startValue,
                       java.lang.String endValue)

Deprecated. As of 6.2.0, replaced by addNumericRangeTerm(BooleanQuery, String, Long, Long)

addRangeTerm

void addRangeTerm(org.apache.lucene.search.BooleanQuery booleanQuery,
                java.lang.String field,
                java.lang.String startValue,
                java.lang.String endValue)

addRequiredTerm

void addRequiredTerm(org.apache.lucene.search.BooleanQuery booleanQuery,
                   java.lang.String field,
                   java.lang.String value,
                   boolean like)

addRequiredTerm

void addRequiredTerm(org.apache.lucene.search.BooleanQuery booleanQuery,
                   java.lang.String field,
                   java.lang.String[] values,
                   boolean like)

addTerm

void addTerm(org.apache.lucene.search.BooleanQuery booleanQuery,
           java.lang.String field,
           java.lang.String value,
           boolean like)

addTerm

void addTerm(org.apache.lucene.search.BooleanQuery booleanQuery,
           java.lang.String field,
           java.lang.String value,
           boolean like,
           com.liferay.portal.kernel.search.BooleanClauseOccur booleanClauseOccur)

addTerm

void addTerm(org.apache.lucene.search.BooleanQuery booleanQuery,
           java.lang.String field,
           java.lang.String[] values,
           boolean like)

cleanUp

@Deprecated
void cleanUp(org.apache.lucene.search.IndexSearcher indexSearcher)

Deprecated. As of 7.0.0, replaced by releaseIndexSearcher(long, IndexSearcher)

countScoredFieldNames

int countScoredFieldNames(org.apache.lucene.search.Query query,
                        java.lang.String[] fieldNames)

delete

void delete(long companyId)

deleteDocuments

void deleteDocuments(long companyId,
                   org.apache.lucene.index.Term term)
                     throws java.io.IOException

Throws:

java.io.IOException

dumpIndex

void dumpIndex(long companyId,
             java.io.OutputStream outputStream)
               throws java.io.IOException

Throws:

java.io.IOException

getAnalyzer

org.apache.lucene.analysis.Analyzer getAnalyzer()

getIndexAccessor

IndexAccessor getIndexAccessor(long companyId)

getIndexSearcher

org.apache.lucene.search.IndexSearcher getIndexSearcher(long companyId)
                                                        throws java.io.IOException

Throws:

java.io.IOException

getLastGeneration

long getLastGeneration(long companyId)

getLoadIndexesInputStreamFromCluster

java.io.InputStream getLoadIndexesInputStreamFromCluster(long companyId,
                                                       com.liferay.portal.kernel.cluster.Address bootupAddress)
                                                         throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

getQueryTerms

java.util.Set<java.lang.String> getQueryTerms(org.apache.lucene.search.Query query)

getSearcher

@Deprecated
org.apache.lucene.search.IndexSearcher getSearcher(long companyId,
                                                            boolean readOnly)
                                                   throws java.io.IOException

Deprecated. As of 7.0.0, replaced by getIndexSearcher(long)

Throws:

java.io.IOException

getSnippet

java.lang.String getSnippet(org.apache.lucene.search.Query query,
                          java.lang.String field,
                          java.lang.String s,
                          int maxNumFragments,
                          int fragmentLength,
                          java.lang.String fragmentSuffix,
                          org.apache.lucene.search.highlight.Formatter formatter)
                            throws java.io.IOException

Throws:

java.io.IOException

getVersion

org.apache.lucene.util.Version getVersion()

isLoadIndexFromClusterEnabled

boolean isLoadIndexFromClusterEnabled()

loadIndex

void loadIndex(long companyId,
             java.io.InputStream inputStream)
               throws java.io.IOException

Throws:

java.io.IOException

loadIndexesFromCluster

void loadIndexesFromCluster(long companyId)
                            throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

releaseIndexSearcher

void releaseIndexSearcher(long companyId,
                        org.apache.lucene.search.IndexSearcher indexSearcher)
                          throws java.io.IOException

Throws:

java.io.IOException

shutdown

void shutdown()

shutdown

void shutdown(long companyId)

startup

void startup(long companyId)

updateDocument

void updateDocument(long companyId,
                  org.apache.lucene.index.Term term,
                  org.apache.lucene.document.Document document)
                    throws java.io.IOException

Throws:

java.io.IOException