org.dlese.dpc.index.writer

Interface DocWriter

All Known Implementing Classes:

ADNFileIndexingWriter, DleseAnnoFileIndexingServiceWriter, DleseCollectionFileIndexingWriter, DleseIMSFileIndexingWriter, ErrorFileIndexingWriter, FileIndexingServiceWriter, HarvestLogWriter, ItemFileIndexingWriter, NCSCollectionFileIndexingWriter, NewsOppsFileIndexingWriter, SimpleXMLFileIndexingWriter, WebLogEntryWriter, WebLogWriter, XMLFileIndexingWriter

public interface DocWriter

Abstract class for creating a typed Lucene Document. A DocReader should be implemented to read Documents of this type.

Author:

John Weatherley

See Also:

DocReader, ResultDoc

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDocType() Returns a unique document type key for this kind of document, corresponding to the format type.
java.lang.String	getReaderClass() Gets the name of the concrete DocReader class that is used to read this type of Document, for example "org.dlese.dpc.index.reader.ItemDocReader".

Method Detail

getDocType

java.lang.String getDocType()
                     throws java.lang.Exception

Returns a unique document type key for this kind of document, corresponding to the format type. For example "dleseims". The string is parsed using the Lucene StandardAnalyzer so it must be lowercase and should not contain any stop words.

Returns:

The docType String

Throws:

java.lang.Exception - This method should throw and Exception with appropriate error message if an error occurs.

getReaderClass

java.lang.String getReaderClass()

Gets the name of the concrete DocReader class that is used to read this type of Document, for example "org.dlese.dpc.index.reader.ItemDocReader". The class name is used by the ResultDoc factory to return the appropriate DocReader.

Returns:

The name of the DocReader