com.liferay.portal.search.lucene

Class LuceneHelperUtil

java.lang.Object

com.liferay.portal.search.lucene.LuceneHelperUtil

public class LuceneHelperUtil
extends java.lang.Object

Author:

Brian Wing Shun Chan, Harry Mark, Bruno Farache, Shuyang Zhou, Andrea Di Giorgi

Constructor Summary

Constructors

Constructor and Description
LuceneHelperUtil()

Method Summary

Methods

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

Methods inherited from class java.lang.Object

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

Constructor Detail

LuceneHelperUtil

public LuceneHelperUtil()

Method Detail

addDate

public static void addDate(org.apache.lucene.document.Document doc,
           java.lang.String field,
           java.util.Date value)

addDocument

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

Throws:

java.io.IOException

addExactTerm

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

addExactTerm

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

addExactTerm

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

addExactTerm

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

addExactTerm

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

addExactTerm

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

addNumericRangeTerm

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

addNumericRangeTerm

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

addNumericRangeTerm

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

addNumericRangeTerm

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

addNumericRangeTerm

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

addNumericRangeTerm

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

addRangeTerm

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

addRangeTerm

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

addRangeTerm

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

addRangeTerm

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

addRangeTerm

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

addRangeTerm

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

addRangeTerm

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

addRequiredTerm

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

addRequiredTerm

public static void addRequiredTerm(org.apache.lucene.search.BooleanQuery booleanQuery,
                   java.lang.String field,
                   double value)

addRequiredTerm

public static void addRequiredTerm(org.apache.lucene.search.BooleanQuery booleanQuery,
                   java.lang.String field,
                   int value)

addRequiredTerm

public static void addRequiredTerm(org.apache.lucene.search.BooleanQuery booleanQuery,
                   java.lang.String field,
                   long value)

addRequiredTerm

public static void addRequiredTerm(org.apache.lucene.search.BooleanQuery booleanQuery,
                   java.lang.String field,
                   short value)

addRequiredTerm

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

addRequiredTerm

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

addRequiredTerm

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

addTerm

public static void addTerm(org.apache.lucene.search.BooleanQuery booleanQuery,
           java.lang.String field,
           long value)

addTerm

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

addTerm

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

addTerm

public static 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

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

cleanUp

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

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

countScoredFieldNames

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

delete

public static void delete(long companyId)

deleteDocuments

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

Throws:

java.io.IOException

dumpIndex

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

Throws:

java.io.IOException

getAnalyzer

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

getIndexAccessor

public static IndexAccessor getIndexAccessor(long companyId)

getIndexSearcher

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

Throws:

java.io.IOException

getLastGeneration

public static long getLastGeneration(long companyId)

getLoadIndexesInputStreamFromCluster

public static 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

getLuceneHelper

public static LuceneHelper getLuceneHelper()

getQueryTerms

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

getSearcher

@Deprecated
public static 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

public static java.lang.String getSnippet(org.apache.lucene.search.Query query,
                          java.lang.String field,
                          java.lang.String s)
                                   throws java.io.IOException

Throws:

java.io.IOException

getSnippet

public static java.lang.String getSnippet(org.apache.lucene.search.Query query,
                          java.lang.String field,
                          java.lang.String s,
                          org.apache.lucene.search.highlight.Formatter formatter)
                                   throws java.io.IOException

Throws:

java.io.IOException

getSnippet

public static 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

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

isLoadIndexFromClusterEnabled

public static boolean isLoadIndexFromClusterEnabled()

loadIndex

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

Throws:

java.io.IOException

loadIndexesFromCluster

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

Throws:

com.liferay.portal.kernel.exception.SystemException

releaseIndexSearcher

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

Throws:

java.io.IOException

shutdown

public static void shutdown()

shutdown

public static void shutdown(long companyId)

startup

public static void startup(long companyId)

updateDocument

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

Throws:

java.io.IOException

setLuceneHelper

public void setLuceneHelper(LuceneHelper luceneHelper)