org.lexevs.dao.index.lucenesupport
Class BaseLuceneIndexTemplate

java.lang.Object
  extended by org.lexevs.dao.index.lucenesupport.BaseLuceneIndexTemplate
All Implemented Interfaces:
LuceneIndexTemplate, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean
Direct Known Subclasses:
MultiBaseLuceneIndexTemplate

public class BaseLuceneIndexTemplate
extends java.lang.Object
implements org.springframework.beans.factory.InitializingBean, org.springframework.beans.factory.DisposableBean, LuceneIndexTemplate


Nested Class Summary
static interface BaseLuceneIndexTemplate.IndexReaderCallback<T>
           
static interface BaseLuceneIndexTemplate.IndexSearcherCallback<T>
           
static interface BaseLuceneIndexTemplate.IndexWriterCallback<T>
           
 
Constructor Summary
BaseLuceneIndexTemplate()
           
BaseLuceneIndexTemplate(LuceneDirectoryFactory.NamedDirectory namedDirectory)
           
 
Method Summary
 void addDocuments(java.util.List<org.apache.lucene.document.Document> documents, org.apache.lucene.analysis.Analyzer analyzer)
           
 void afterPropertiesSet()
           
protected  org.apache.lucene.index.IndexWriter createIndexWriter(LuceneDirectoryFactory.NamedDirectory namedDirectory)
           
 void destroy()
           
protected  void doFinalize()
           
protected
<T> T
doInIndexReader(BaseLuceneIndexTemplate.IndexReaderCallback<T> callback)
           
protected
<T> T
doInIndexSearcher(BaseLuceneIndexTemplate.IndexSearcherCallback<T> callback)
           
protected
<T> T
doInIndexWriter(BaseLuceneIndexTemplate.IndexWriterCallback<T> callback)
           
<T> T
executeInIndexReader(BaseLuceneIndexTemplate.IndexReaderCallback<T> callback)
           
<T> T
executeInIndexSearcher(BaseLuceneIndexTemplate.IndexSearcherCallback<T> callback)
           
<T> T
executeInIndexWriter(BaseLuceneIndexTemplate.IndexWriterCallback<T> callback)
           
 void finalize()
           
 org.apache.lucene.analysis.Analyzer getAnalyzer()
           
 org.apache.lucene.search.DocIdSet getDocIdSet(org.apache.lucene.search.Filter filter)
           
 org.apache.lucene.document.Document getDocumentById(int id)
           
 java.lang.String getIndexName()
           
protected  org.apache.lucene.index.IndexReader getIndexReader()
           
protected  org.apache.lucene.search.Searcher getIndexSearcher()
           
 int getMaxDoc()
           
 LuceneDirectoryFactory.NamedDirectory getNamedDirectory()
           
 void optimize()
           
 void removeDocuments(org.apache.lucene.search.Query query)
           
 void removeDocuments(org.apache.lucene.index.Term term)
           
 java.util.List<org.apache.lucene.search.ScoreDoc> search(org.apache.lucene.search.Query query, org.apache.lucene.search.Filter filter)
           
 void search(org.apache.lucene.search.Query query, org.apache.lucene.search.Filter filter, org.apache.lucene.search.HitCollector hitCollector)
           
 void setAnalyzer(org.apache.lucene.analysis.Analyzer analyzer)
           
protected  void setIndexReader(org.apache.lucene.index.IndexReader indexReader)
           
protected  void setIndexSearcher(org.apache.lucene.search.Searcher indexSearcher)
           
 void setNamedDirectory(LuceneDirectoryFactory.NamedDirectory namedDirectory)
           
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BaseLuceneIndexTemplate

public BaseLuceneIndexTemplate()

BaseLuceneIndexTemplate

public BaseLuceneIndexTemplate(LuceneDirectoryFactory.NamedDirectory namedDirectory)
Method Detail

afterPropertiesSet

public void afterPropertiesSet()
                        throws java.lang.Exception
Specified by:
afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean
Throws:
java.lang.Exception

getIndexName

public java.lang.String getIndexName()
Specified by:
getIndexName in interface LuceneIndexTemplate

addDocuments

public void addDocuments(java.util.List<org.apache.lucene.document.Document> documents,
                         org.apache.lucene.analysis.Analyzer analyzer)
Specified by:
addDocuments in interface LuceneIndexTemplate

optimize

public void optimize()
Specified by:
optimize in interface LuceneIndexTemplate

removeDocuments

public void removeDocuments(org.apache.lucene.index.Term term)
Specified by:
removeDocuments in interface LuceneIndexTemplate

removeDocuments

public void removeDocuments(org.apache.lucene.search.Query query)
Specified by:
removeDocuments in interface LuceneIndexTemplate

search

public void search(org.apache.lucene.search.Query query,
                   org.apache.lucene.search.Filter filter,
                   org.apache.lucene.search.HitCollector hitCollector)
Specified by:
search in interface LuceneIndexTemplate

search

public java.util.List<org.apache.lucene.search.ScoreDoc> search(org.apache.lucene.search.Query query,
                                                                org.apache.lucene.search.Filter filter)
Specified by:
search in interface LuceneIndexTemplate

getDocumentById

public org.apache.lucene.document.Document getDocumentById(int id)
Specified by:
getDocumentById in interface LuceneIndexTemplate

getDocIdSet

public org.apache.lucene.search.DocIdSet getDocIdSet(org.apache.lucene.search.Filter filter)
Specified by:
getDocIdSet in interface LuceneIndexTemplate

getMaxDoc

public int getMaxDoc()
Specified by:
getMaxDoc in interface LuceneIndexTemplate

doInIndexReader

protected <T> T doInIndexReader(BaseLuceneIndexTemplate.IndexReaderCallback<T> callback)

doInIndexSearcher

protected <T> T doInIndexSearcher(BaseLuceneIndexTemplate.IndexSearcherCallback<T> callback)

doInIndexWriter

protected <T> T doInIndexWriter(BaseLuceneIndexTemplate.IndexWriterCallback<T> callback)

createIndexWriter

protected org.apache.lucene.index.IndexWriter createIndexWriter(LuceneDirectoryFactory.NamedDirectory namedDirectory)
                                                         throws java.lang.Exception
Throws:
java.lang.Exception

executeInIndexReader

public <T> T executeInIndexReader(BaseLuceneIndexTemplate.IndexReaderCallback<T> callback)
Specified by:
executeInIndexReader in interface LuceneIndexTemplate

executeInIndexSearcher

public <T> T executeInIndexSearcher(BaseLuceneIndexTemplate.IndexSearcherCallback<T> callback)
Specified by:
executeInIndexSearcher in interface LuceneIndexTemplate

executeInIndexWriter

public <T> T executeInIndexWriter(BaseLuceneIndexTemplate.IndexWriterCallback<T> callback)
Specified by:
executeInIndexWriter in interface LuceneIndexTemplate

destroy

public void destroy()
             throws java.lang.Exception
Specified by:
destroy in interface org.springframework.beans.factory.DisposableBean
Throws:
java.lang.Exception

getNamedDirectory

public LuceneDirectoryFactory.NamedDirectory getNamedDirectory()

setNamedDirectory

public void setNamedDirectory(LuceneDirectoryFactory.NamedDirectory namedDirectory)

setAnalyzer

public void setAnalyzer(org.apache.lucene.analysis.Analyzer analyzer)

getAnalyzer

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

getIndexSearcher

protected org.apache.lucene.search.Searcher getIndexSearcher()

setIndexSearcher

protected void setIndexSearcher(org.apache.lucene.search.Searcher indexSearcher)

getIndexReader

protected org.apache.lucene.index.IndexReader getIndexReader()

setIndexReader

protected void setIndexReader(org.apache.lucene.index.IndexReader indexReader)

finalize

public void finalize()
              throws java.lang.Throwable
Overrides:
finalize in class java.lang.Object
Throws:
java.lang.Throwable

doFinalize

protected void doFinalize()
                   throws java.lang.Throwable
Throws:
java.lang.Throwable

Copyright: (c) 2004-2006 Mayo Foundation for Medical Education and Research (MFMER). All rights reserved. MAYO, MAYO CLINIC, and the triple-shield Mayo logo are trademarks and service marks of MFMER.