Package 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:

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDocType()
    Returns a unique document type key for this kind of document, corresponding to the format type.
    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 Details

    • getDocType

      String getDocType() throws 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:
      Exception - This method should throw and Exception with appropriate error message if an error occurs.

    • getReaderClass

      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