maiolum.xml.search
Interface VerseDocumentObserver

All Known Implementing Classes:

BibleModuleIndexer

public interface VerseDocumentObserver

Serves as observer typically observing (and waiting) BibleContentHandler for parsed Lucene Document objects.

This should resemble Observer design pattern, where this class instances are observers and BibleContentHandler is observed object.

Typical use is to associate object implementing VerseDocumentObserver to BibleContentHandler (the SAX ContentHandler). When the BibleContentHandler gathers enough data to spawn new Lucene Document object, retrieveVerse() method is called, so that VerseDocumentObserver can handle the Lucene Document on its own.

Standard use of VerseDocumentObserver is to put parsed Lucene document into Lucene index.

Method Summary

void	retrieveVerse(org.apache.lucene.document.Document doc)

Method Detail

retrieveVerse

public void retrieveVerse(org.apache.lucene.document.Document doc)