HarvestLogReader (jOAI Java Documentation v3.3)

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

```
public class HarvestLogReader
extends DocReader
```
A bean for accessing the data stored in a Lucene Document that logs a single OAI harvest. The index writer that is responsible for creating this type of Lucene Document is a HarvestLogWriter.

Author:

John Weatherley

See Also:

ResultDoc, HarvestLogWriter

Field Summary
- Fields inherited from class org.dlese.dpc.index.reader.DocReader
  conf, doc, resultDoc, score

Constructor Summary

Constructors
Constructor and Description
`HarvestLogReader()` Constructor for the HarvestLogReader object
`HarvestLogReader(org.apache.lucene.document.Document doc)` Constructor that may be used programatically to wrap a reader around a Lucene `Document` created by a `DocWriter`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getBaseUrl()` Gets the baseUrl attribute of the HarvestLogReader object
`protected static java.lang.String`	`getDateStamp()` Return a string for the current time and date, sutiable for display in log files and output to standout:
`java.lang.String`	`getDeletedRecordSupport()` Gets the level of support for deleted records of the data provider, or null if not available.
`java.util.Date`	`getEndDate()` Gets the end time as a Date, or null.
`java.lang.String`	`getEndTime()` Gets the endTime attribute of the HarvestLogReader object
`long`	`getEndTimeLong()` Gets the end time as a long, or -1 if not available.
`java.lang.String`	`getEntryType()` Gets the entryType attribute of the HarvestLogReader object
`java.util.Date`	`getFromDate()` Gets the from Date used for this harvest, or null if none was used.
`java.lang.String`	`getFromDatestamp()` Gets the from datestamp of the form yyyy-MM-ddTHH:mm:ssZ used for this harvest, or null if none was used.
`java.lang.String`	`getHarvestDir()` Gets the harvestDir attribute of the HarvestLogReader object
`java.lang.String`	`getHarvestDuration()` Gets the harvest duration for display, or null if not available.
`long`	`getHarvestDurationLong()` Gets the harvest duration as a long, or -1 if not avialble.
`java.lang.String`	`getHarvestUid()` The UID of an individual harvest that was performed.
`long`	`getHarvestUidLong()` Gets the harvestUidLong attribute of the HarvestLogReader object
`java.lang.String`	`getLogDate()` Gets the logDate attribute of the HarvestLogReader object
`java.lang.String`	`getLogMessage()` Gets the logMessage attribute of the HarvestLogReader object
`java.lang.String`	`getNumHarvestedRecords()` Gets the numHarvestedRecords attribute of the HarvestLogReader object
`int`	`getNumHarvestedRecordsInt()` Gets the numHarvestedRecordsInt attribute of the HarvestLogReader object
`java.lang.String`	`getNumResumptionTokens()` Gets the numResumptionTokens attribute of the HarvestLogReader object
`int`	`getNumResumptionTokensInt()` Gets the numResumptionTokensInt attribute of the HarvestLogReader object
`java.lang.String`	`getOaiErrorCode()` Gets the OAI error code that was returned by the data provider, for example 'noRecordsMatch', or null if not applicable.
`java.lang.String`	`getReaderType()` Gets a String describing the reader type.
`java.lang.String`	`getRepositoryName()` Gets the repositoryName attribute of the HarvestLogReader object
`java.lang.String`	`getSet()` Gets the set if one was specified, or empty String.
`java.util.Date`	`getStartDate()` Gets the start time as a Date, or null.
`java.lang.String`	`getStartTime()` Gets the startTime attribute of the HarvestLogReader object
`long`	`getStartTimeLong()` Gets the start time as a long, or -1 if not available.
`java.lang.String`	`getSupportedGranularity()` Gets the date granularity supported by the data provider, or null if not available.
`java.lang.String`	`getUid()` The UID of the scheduled harvest.
`long`	`getUidLong()` Gets the uidLong attribute of the HarvestLogReader object
`java.util.Date`	`getUntilDate()` Gets the until Date used for this harvest, or null if none was used.
`java.lang.String`	`getUntilDatestamp()` Gets the until datestamp of the form yyyy-MM-ddTHH:mm:ssZ used for this harvest, or null if none was used.
`java.lang.String`	`getZipFilePath()` Gets the path to the zip file for this harvest, or null if none was saved.
`void`	`init()` Init method does nothing.

Methods inherited from class org.dlese.dpc.index.reader.DocReader
doInit, getAttribute, getDocMap, getDocument, getIndex, getLazyDocMap, getQuery, getRepositoryManager, 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()
```
    Constructor for the HarvestLogReader object
  - HarvestLogReader
```
public HarvestLogReader(org.apache.lucene.document.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
  - init
```
public void init()
```
    Init method does nothing.
    
    Specified by:
    
    init in class DocReader
  - getLogDate
```
public java.lang.String getLogDate()
```
    Gets the logDate attribute of the HarvestLogReader object
    
    Returns:
    
    The logDate value
  - getStartDate
```
public java.util.Date getStartDate()
```
    Gets the start time as a Date, or null.
    
    Returns:
    
    The startTime value
  - getStartTime
```
public java.lang.String getStartTime()
```
    Gets the startTime attribute of the HarvestLogReader object
    
    Returns:
    
    The startTime value
  - getStartTimeLong
```
public long getStartTimeLong()
```
    Gets the start time as a long, or -1 if not available.
    
    Returns:
    
    The start time as a long
  - getEndDate
```
public java.util.Date getEndDate()
```
    Gets the end time as a Date, or null.
    
    Returns:
    
    The startTime value
  - getEndTime
```
public java.lang.String getEndTime()
```
    Gets the endTime attribute of the HarvestLogReader object
    
    Returns:
    
    The endTime value
  - getEndTimeLong
```
public long getEndTimeLong()
```
    Gets the end time as a long, or -1 if not available.
    
    Returns:
    
    The end time or -1
  - getHarvestDurationLong
```
public long getHarvestDurationLong()
```
    Gets the harvest duration as a long, or -1 if not avialble.
    
    Returns:
    
    The harvest duration
  - getHarvestDuration
```
public java.lang.String getHarvestDuration()
```
    Gets the harvest duration for display, or null if not available.
    
    Returns:
    
    The harvest duration
  - getRepositoryName
```
public java.lang.String getRepositoryName()
```
    Gets the repositoryName attribute of the HarvestLogReader object
    
    Returns:
    
    The repositoryName value
  - getBaseUrl
```
public java.lang.String getBaseUrl()
```
    Gets the baseUrl attribute of the HarvestLogReader object
    
    Returns:
    
    The baseUrl value
  - getSet
```
public java.lang.String getSet()
```
    Gets the set if one was specified, or empty String. Note that the index stores 'noset' for the set if none was specified.
    
    Returns:
    
    The setSpec or empty String
  - getFromDatestamp
```
public java.lang.String getFromDatestamp()
```
    Gets the from datestamp of the form yyyy-MM-ddTHH:mm:ssZ used for this harvest, or null if none was used.
    
    Returns:
    
    The from datestamp or null
  - getFromDate
```
public java.util.Date getFromDate()
```
    Gets the from Date used for this harvest, or null if none was used.
    
    Returns:
    
    The from Date or null
  - getUntilDatestamp
```
public java.lang.String getUntilDatestamp()
```
    Gets the until datestamp of the form yyyy-MM-ddTHH:mm:ssZ used for this harvest, or null if none was used.
    
    Returns:
    
    The until datestamp or null
  - getUntilDate
```
public java.util.Date getUntilDate()
```
    Gets the until Date used for this harvest, or null if none was used.
    
    Returns:
    
    The until Date or null
  - getUid
```
public java.lang.String getUid()
```
    The UID of the scheduled harvest.
    
    Returns:
    
    The uid value
  - getUidLong
```
public long getUidLong()
```
    Gets the uidLong attribute of the HarvestLogReader object
    
    Returns:
    
    The uidLong value
  - getHarvestUid
```
public java.lang.String getHarvestUid()
```
    The UID of an individual harvest that was performed.
    
    Returns:
    
    The harvestUid value
  - getHarvestUidLong
```
public long getHarvestUidLong()
```
    Gets the harvestUidLong attribute of the HarvestLogReader object
    
    Returns:
    
    The harvestUidLong value
  - getNumHarvestedRecords
```
public java.lang.String getNumHarvestedRecords()
```
    Gets the numHarvestedRecords attribute of the HarvestLogReader object
    
    Returns:
    
    The numHarvestedRecords value
  - getNumHarvestedRecordsInt
```
public int getNumHarvestedRecordsInt()
```
    Gets the numHarvestedRecordsInt attribute of the HarvestLogReader object
    
    Returns:
    
    The numHarvestedRecordsInt value
  - getNumResumptionTokens
```
public java.lang.String getNumResumptionTokens()
```
    Gets the numResumptionTokens attribute of the HarvestLogReader object
    
    Returns:
    
    The numResumptionTokens value
  - getNumResumptionTokensInt
```
public int getNumResumptionTokensInt()
```
    Gets the numResumptionTokensInt attribute of the HarvestLogReader object
    
    Returns:
    
    The numResumptionTokensInt value
  - getLogMessage
```
public java.lang.String getLogMessage()
```
    Gets the logMessage attribute of the HarvestLogReader object
    
    Returns:
    
    The logMessage value
  - getHarvestDir
```
public java.lang.String getHarvestDir()
```
    Gets the harvestDir attribute of the HarvestLogReader object
    
    Returns:
    
    The harvestDir value
  - getZipFilePath
```
public java.lang.String getZipFilePath()
```
    Gets the path to the zip file for this harvest, or null if none was saved.
    
    Returns:
    
    The zip file path or null
  - getDeletedRecordSupport
```
public java.lang.String getDeletedRecordSupport()
```
    Gets the level of support for deleted records of the data provider, or null if not available.
    
    Returns:
    
    One of 'no', 'persistent', 'transient' or null
  - getSupportedGranularity
```
public java.lang.String getSupportedGranularity()
```
    Gets the date granularity supported by the data provider, or null if not available.
    
    Returns:
    
    One of 'days', 'seconds'or null
  - getOaiErrorCode
```
public java.lang.String getOaiErrorCode()
```
    Gets the OAI error code that was returned by the data provider, for example 'noRecordsMatch', or null if not applicable. See OAI-PMH error codes .
    
    Returns:
    
    The OAI error code or null
  - getEntryType
```
public java.lang.String getEntryType()
```
    Gets the entryType attribute of the HarvestLogReader object
    
    Returns:
    
    The entryType value
  - getReaderType
```
public java.lang.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.
  - getDateStamp
```
protected static final java.lang.String getDateStamp()
```
    Return a string for the current time and date, sutiable for display in log files and output to standout:
    
    Returns:
    
    The dateStamp value

Class HarvestLogReader

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

HarvestLogReader

HarvestLogReader

Method Detail

init

getLogDate

getStartDate

getStartTime

getStartTimeLong

getEndDate

getEndTime

getEndTimeLong

getHarvestDurationLong

getHarvestDuration

getRepositoryName

getBaseUrl

getSet

getFromDatestamp

getFromDate

getUntilDatestamp

getUntilDate

getUid

getUidLong

getHarvestUid

getHarvestUidLong

getNumHarvestedRecords

getNumHarvestedRecordsInt

getNumResumptionTokens

getNumResumptionTokensInt

getLogMessage

getHarvestDir

getZipFilePath

getDeletedRecordSupport

getSupportedGranularity

getOaiErrorCode

getEntryType

getReaderType

getDateStamp