org.dlese.dpc.index.reader
Class SimpleFileIndexingServiceDocReader

java.lang.Object
  org.dlese.dpc.index.reader.DocReader
      org.dlese.dpc.index.reader.FileIndexingServiceDocReader
          org.dlese.dpc.index.reader.SimpleFileIndexingServiceDocReader

All Implemented Interfaces:

Serializable

public class SimpleFileIndexingServiceDocReader

extends FileIndexingServiceDocReader

implements Serializable

Provides getter methods to read data from a Lucene Document that was created by a FileIndexingServiceWriter. The getter methods can then be accessed from (Struts) beans that need the data.

Author:

John Weatherley

See Also:

FileIndexingServiceWriter, Serialized Form

Field Summary

Fields inherited from class org.dlese.dpc.index.reader.DocReader

conf, doc, score

Constructor Summary

SimpleFileIndexingServiceDocReader(Document doc)
Constructor that may be used programatically to wrap a reader around a Lucene Document that was created by a FileIndexingServiceWriter.

SimpleFileIndexingServiceDocReader(Document doc, float score, ResultDocConfig conf)
Constructor that is used by ResultDoc at search time to create a new instance of a DocReader.

Method Summary

String

getReaderType() Gets the String 'ItemDocReader,' which is the key that describes this reader type.

Methods inherited from class org.dlese.dpc.index.reader.FileIndexingServiceDocReader

fileExists, getDateStamp, getDeleted, getDocDir, getDocsource, getDocsourceEncoded, getDoctype, getFileExists, getFileName, getFullContent, getLastModified, getLastModifiedString, getSourceFile, isDeleted, prtln, prtlnErr, setDebug

Methods inherited from class org.dlese.dpc.index.reader.DocReader

getDocument, getIndex, getQuery, getScore, setDoc

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SimpleFileIndexingServiceDocReader

public SimpleFileIndexingServiceDocReader(Document doc,
                                          float score,
                                          ResultDocConfig conf)

Constructor that is used by ResultDoc at search time to create a new instance of a DocReader.

Parameters:

doc - The Lucene Document that is read.

score - The rank of the Document in a set of results.

See Also:

ResultDoc, DocReader

SimpleFileIndexingServiceDocReader

public SimpleFileIndexingServiceDocReader(Document doc)

Constructor that may be used programatically to wrap a reader around a Lucene Document that was created by a FileIndexingServiceWriter.

Parameters:

doc - A Lucene Document.

See Also:

FileIndexingServiceWriter

Method Detail

getReaderType

public String getReaderType()

Gets the String 'ItemDocReader,' which is the key that describes this reader type. This may be used in (Struts) beans to determine which type of reader is available for a given search result and thus what data is available for display in the UI. The reader type determines which getter methods are available.

Specified by:

getReaderType in class DocReader

Returns:

The String 'ItemDocReader'.