Liferay 6.2.0

com.liferay.portal.search.lucene
Interface LuceneHelper

All Known Implementing Classes:
LuceneHelperImpl

public interface LuceneHelper


Method Summary
abstract  void addDocument(long companyId, org.apache.lucene.document.Document document)
           
abstract  void addExactTerm(org.apache.lucene.search.BooleanQuery booleanQuery, String field, String value)
           
abstract  void addNumericRangeTerm(org.apache.lucene.search.BooleanQuery booleanQuery, String field, Integer startValue, Integer endValue)
           
abstract  void addNumericRangeTerm(org.apache.lucene.search.BooleanQuery booleanQuery, String field, Long startValue, Long endValue)
           
abstract  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)
abstract  void addRangeTerm(org.apache.lucene.search.BooleanQuery booleanQuery, String field, String startValue, String endValue)
           
abstract  void addRequiredTerm(org.apache.lucene.search.BooleanQuery booleanQuery, String field, String[] values, boolean like)
           
abstract  void addRequiredTerm(org.apache.lucene.search.BooleanQuery booleanQuery, String field, String value, boolean like)
           
abstract  void addTerm(org.apache.lucene.search.BooleanQuery booleanQuery, String field, String[] values, boolean like)
           
abstract  void addTerm(org.apache.lucene.search.BooleanQuery booleanQuery, String field, String value, boolean like)
           
abstract  void addTerm(org.apache.lucene.search.BooleanQuery booleanQuery, String field, String value, boolean like, BooleanClauseOccur booleanClauseOccur)
           
abstract  void cleanUp(org.apache.lucene.search.IndexSearcher indexSearcher)
          Deprecated. As of 7.0.0, replaced by releaseIndexSearcher(long, IndexSearcher)
abstract  int countScoredFieldNames(org.apache.lucene.search.Query query, String[] fieldNames)
           
abstract  void delete(long companyId)
           
abstract  void deleteDocuments(long companyId, org.apache.lucene.index.Term term)
           
abstract  void dumpIndex(long companyId, OutputStream outputStream)
           
abstract  org.apache.lucene.analysis.Analyzer getAnalyzer()
           
abstract  IndexAccessor getIndexAccessor(long companyId)
           
abstract  org.apache.lucene.search.IndexSearcher getIndexSearcher(long companyId)
           
abstract  long getLastGeneration(long companyId)
           
abstract  InputStream getLoadIndexesInputStreamFromCluster(long companyId, Address bootupAddress)
           
abstract  Set<String> getQueryTerms(org.apache.lucene.search.Query query)
           
abstract  org.apache.lucene.search.IndexSearcher getSearcher(long companyId, boolean readOnly)
          Deprecated. As of 7.0.0, replaced by getIndexSearcher(long)
abstract  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)
           
abstract  org.apache.lucene.util.Version getVersion()
           
abstract  boolean isLoadIndexFromClusterEnabled()
           
abstract  void loadIndex(long companyId, InputStream inputStream)
           
abstract  void loadIndexesFromCluster(long companyId)
           
abstract  void releaseIndexSearcher(long companyId, org.apache.lucene.search.IndexSearcher indexSearcher)
           
abstract  void shutdown()
           
abstract  void shutdown(long companyId)
           
abstract  void startup(long companyId)
           
abstract  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.0