com.liferay.portal.search.lucene
Interface LuceneHelper

All Known Implementing Classes:

LuceneHelperImpl

public interface LuceneHelper

Author:

Bruno Farache, Shuyang Zhou

Method Summary

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.String startValue, java.lang.String endValue)
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)
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()
long	getLastGeneration(long companyId)
java.io.InputStream	getLoadIndexesInputStreamFromCluster(long companyId, com.liferay.portal.kernel.cluster.Address bootupAddress)
java.lang.String[]	getQueryTerms(org.apache.lucene.search.Query query)
org.apache.lucene.search.IndexSearcher	getSearcher(long companyId, boolean readOnly)
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, java.lang.String preTag, java.lang.String postTag)
org.apache.lucene.util.Version	getVersion()
boolean	isLoadIndexFromClusterEnabled()
void	loadIndex(long companyId, java.io.InputStream inputStream)
com.liferay.portal.kernel.cluster.Address	selectBootupClusterAddress(long companyId, long localLastGeneration)
void	shutdown()
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.String startValue,
                         java.lang.String endValue)

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)

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()

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.lang.String[] getQueryTerms(org.apache.lucene.search.Query query)

getSearcher

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

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,
                            java.lang.String preTag,
                            java.lang.String postTag)
                            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

selectBootupClusterAddress

com.liferay.portal.kernel.cluster.Address selectBootupClusterAddress(long companyId,
                                                                     long localLastGeneration)
                                                                     throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

shutdown

void shutdown()

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