org.dlese.dpc.index.reader
Class HarvestLogReader

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

public class HarvestLogReader

extends DocReader

A Lucene DocReader that reads harvest log entries.

Author:

John Weatherley

See Also:

ResultDoc, HarvestLogWriter

Field Summary

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

conf, doc, score

Constructor Summary

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

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

Method Summary

String	getBaseUrl()
String	getEndTime()
long	getEndTimeLong()
String	getEntryType()
String	getHarvestDir()
String	getHarvestUid() The UID of an individual harvest that was performed.
long	getHarvestUidLong()
String	getLogDate()
String	getLogMessage()
String	getNumHarvestedRecords()
int	getNumHarvestedRecordsInt()
String	getNumResumptionTokens()
int	getNumResumptionTokensInt()
String	getReaderType() Gets a String describing the reader type.
String	getRepositoryName()
String	getSet()
String	getStartTime()
long	getStartTimeLong()
String	getUid() The UID of the scheduled harvest.
long	getUidLong()

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

HarvestLogReader

public HarvestLogReader(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.

HarvestLogReader

public HarvestLogReader(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.

Method Detail

getLogDate

public String getLogDate()

getStartTime

public String getStartTime()

getStartTimeLong

public long getStartTimeLong()

getEndTime

public String getEndTime()

getEndTimeLong

public long getEndTimeLong()

getRepositoryName

public String getRepositoryName()

getBaseUrl

public String getBaseUrl()

getSet

public String getSet()

getUid

public String getUid()

The UID of the scheduled harvest.

getUidLong

public long getUidLong()

getHarvestUid

public String getHarvestUid()

The UID of an individual harvest that was performed.

getHarvestUidLong

public long getHarvestUidLong()

getNumHarvestedRecords

public String getNumHarvestedRecords()

getNumHarvestedRecordsInt

public int getNumHarvestedRecordsInt()

getNumResumptionTokens

public String getNumResumptionTokens()

getNumResumptionTokensInt

public int getNumResumptionTokensInt()

getLogMessage

public String getLogMessage()

getHarvestDir

public String getHarvestDir()

getEntryType

public String getEntryType()

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.