com.liferay.portal.search.lucene
Interface LuceneHelper

All Known Implementing Classes:
LuceneHelperImpl

public interface LuceneHelper

View Source

Author:
Bruno Farache

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 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 value, boolean like)
           
 void delete(long companyId)
           
 void deleteDocuments(long companyId, org.apache.lucene.index.Term term)
           
 org.apache.lucene.analysis.Analyzer getAnalyzer()
           
 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()
           
 void shutdown()
           
 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)

addRequiredTerm

void addRequiredTerm(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)
             throws org.apache.lucene.queryParser.ParseException
Throws:
org.apache.lucene.queryParser.ParseException

delete

void delete(long companyId)

deleteDocuments

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

getAnalyzer

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

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

shutdown

void shutdown()

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