Liferay 6.2-ce-ga5

com.liferay.portal.search.lucene
Interface LuceneHelper

All Known Implementing Classes:
LuceneHelperImpl

public interface LuceneHelper


Method Summary
 void addDocument(long companyId, org.apache.lucene.document.Document document)
           
 void addExactTerm(org.apache.lucene.search.BooleanQuery booleanQuery, String field, String value)
           
 void addNumericRangeTerm(org.apache.lucene.search.BooleanQuery booleanQuery, String field, Integer startValue, Integer endValue)
           
 void addNumericRangeTerm(org.apache.lucene.search.BooleanQuery booleanQuery, String field, Long startValue, Long endValue)
           
 void addNumericRangeTerm(org.apache.lucene.search.BooleanQuery booleanQuery, String field, String startValue, String endValue)
          Deprecated. As of 6.2.0, replaced by addNumericRangeTerm(BooleanQuery, String, Long, Long)
 void addRangeTerm(org.apache.lucene.search.BooleanQuery booleanQuery, String field, String startValue, String endValue)
           
 void addRequiredTerm(org.apache.lucene.search.BooleanQuery booleanQuery, String field, String[] values, boolean like)
           
 void addRequiredTerm(org.apache.lucene.search.BooleanQuery booleanQuery, String field, String value, boolean like)
           
 void addTerm(org.apache.lucene.search.BooleanQuery booleanQuery, String field, String[] values, boolean like)
           
 void addTerm(org.apache.lucene.search.BooleanQuery booleanQuery, String field, String value, boolean like)
           
 void addTerm(org.apache.lucene.search.BooleanQuery booleanQuery, String field, String value, boolean like, 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, String[] fieldNames)
           
 void delete(long companyId)
           
 void deleteDocuments(long companyId, org.apache.lucene.index.Term term)
           
 void dumpIndex(long companyId, OutputStream outputStream)
           
 org.apache.lucene.analysis.Analyzer getAnalyzer()
           
 IndexAccessor getIndexAccessor(long companyId)
           
 org.apache.lucene.search.IndexSearcher getIndexSearcher(long companyId)
           
 long getLastGeneration(long companyId)
           
 InputStream getLoadIndexesInputStreamFromCluster(long companyId, Address bootupAddress)
           
 Set<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)
 String getSnippet(org.apache.lucene.search.Query query, String field, String s, int maxNumFragments, int fragmentLength, String fragmentSuffix, org.apache.lucene.search.highlight.Formatter formatter)
           
 org.apache.lucene.util.Version getVersion()
           
 boolean isLoadIndexFromClusterEnabled()
           
 void loadIndex(long companyId, 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 IOException
Throws:
IOException

addExactTerm

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

addNumericRangeTerm

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

addNumericRangeTerm

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

addNumericRangeTerm

void addNumericRangeTerm(org.apache.lucene.search.BooleanQuery booleanQuery,
                         String field,
                         String startValue,
                         String endValue)
Deprecated. As of 6.2.0, replaced by addNumericRangeTerm(BooleanQuery, String, Long, Long)


addRangeTerm

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

addRequiredTerm

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

addRequiredTerm

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

addTerm

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

addTerm

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

addTerm

void addTerm(org.apache.lucene.search.BooleanQuery booleanQuery,
             String field,
             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,
                          String[] fieldNames)

delete

void delete(long companyId)

deleteDocuments

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

dumpIndex

void dumpIndex(long companyId,
               OutputStream outputStream)
               throws IOException
Throws:
IOException

getAnalyzer

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

getIndexAccessor

IndexAccessor getIndexAccessor(long companyId)

getIndexSearcher

org.apache.lucene.search.IndexSearcher getIndexSearcher(long companyId)
                                                        throws IOException
Throws:
IOException

getLastGeneration

long getLastGeneration(long companyId)

getLoadIndexesInputStreamFromCluster

InputStream getLoadIndexesInputStreamFromCluster(long companyId,
                                                 Address bootupAddress)
                                                 throws SystemException
Throws:
SystemException

getQueryTerms

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

getSearcher

@Deprecated
org.apache.lucene.search.IndexSearcher getSearcher(long companyId,
                                                              boolean readOnly)
                                                   throws IOException
Deprecated. As of 7.0.0, replaced by getIndexSearcher(long)

Throws:
IOException

getSnippet

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

getVersion

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

isLoadIndexFromClusterEnabled

boolean isLoadIndexFromClusterEnabled()

loadIndex

void loadIndex(long companyId,
               InputStream inputStream)
               throws IOException
Throws:
IOException

loadIndexesFromCluster

void loadIndexesFromCluster(long companyId)
                            throws SystemException
Throws:
SystemException

releaseIndexSearcher

void releaseIndexSearcher(long companyId,
                          org.apache.lucene.search.IndexSearcher indexSearcher)
                          throws IOException
Throws:
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 IOException
Throws:
IOException

Liferay 6.2-ce-ga5