org.dlese.dpc.index.reader
Class SimpleDocReader

java.lang.Object
  org.dlese.dpc.index.reader.DocReader
      org.dlese.dpc.index.reader.SimpleDocReader

public class SimpleDocReader

extends DocReader

A simple implementataion of the DocReader interface.

Author:

John Weatherley

See Also:

ResultDoc

Field Summary

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

conf, doc, score

Constructor Summary

SimpleDocReader()
Constructor that initializes an empty DocReader.

SimpleDocReader(Document doc)
Constructor that may be used programatically to wrap a reader around a Lucene Document created by a DocWriter.

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

Method Summary

String

getReaderType() Gets a String describing the reader type.

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

SimpleDocReader

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

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

Parameters:

doc - The Lucene Document that is read.

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

SimpleDocReader

public SimpleDocReader(Document doc)

Constructor that may be used programatically to wrap a reader around a Lucene Document created by a DocWriter. Sets the score to 0.

Parameters:

doc - A Lucene Document created by a DocWriter.

SimpleDocReader

public SimpleDocReader()

Constructor that initializes an empty DocReader.

Method Detail

getReaderType

public String getReaderType()

Gets a String describing the 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 implies which getter methods are available.

Specified by:

getReaderType in class DocReader

Returns:

The readerType value.