org.dlese.dpc.index.writer
Class HarvestLogWriter

java.lang.Object
  org.dlese.dpc.index.writer.HarvestLogWriter

All Implemented Interfaces:

DocWriter

public class HarvestLogWriter

extends Object

implements DocWriter

Writes a Lucene Document that holds information about a harvest.
The Lucene Document fields that are created by this class are:

requestdate - The date of the client request. Stored.
requesturl - The URL and query the client requested. Stored.
remotehost - The requesting client's host name or IP address. Stored.
notes - Free text notes related to this log entry. Stored.
doctype - The document format type, which is 'weblog,' with '0' appended to support wildcard searching.
readerclass - The class which is used to read Documents created by this writer, which is 'WebLogReader'.
admindefaultfield - The default field that holds all content for searching. 'WebLogReader'.

Author:

John Weatherley

See Also:

HarvestLogReader

Field Summary

static int	COMPLETED_OAI_ERROR
static int	COMPLETED_SERIOUS_ERROR
static int	COMPLETED_SUCCESSFUL
static int	HARVEST_IN_PROGRESS

Constructor Summary

HarvestLogWriter(String repositoryName, String baseURL, String set, String shUid)
Constructor for the HarvestLogWriter object

Method Summary

protected void	addToAdminDefaultField(String value, StringBuffer adminDefaultBuffer) Adds the given String to a text field referenced in the index by the field name 'default'.
String	getDocType() Gets doctype, which is "harvestlog".
String	getReaderClass() Gets the name of the concrete DocReader class that is used to read this type of Document, which is "HarvestLogReader".
Document	logEntry(long harvestUid, long startTime, long endTime, int recordCount, int resumptionCount, int messageType, String harvestedRecordsDir, String message)

Methods inherited from class java.lang.Object

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

Field Detail

HARVEST_IN_PROGRESS

public static int HARVEST_IN_PROGRESS

COMPLETED_SUCCESSFUL

public static int COMPLETED_SUCCESSFUL

COMPLETED_OAI_ERROR

public static int COMPLETED_OAI_ERROR

COMPLETED_SERIOUS_ERROR

public static int COMPLETED_SERIOUS_ERROR

Constructor Detail

HarvestLogWriter

public HarvestLogWriter(String repositoryName,
                        String baseURL,
                        String set,
                        String shUid)

Constructor for the HarvestLogWriter object

Method Detail

getDocType

public String getDocType()

Gets doctype, which is "harvestlog".

Specified by:

getDocType in interface DocWriter

Returns:

The String "harvestlog".

getReaderClass

public String getReaderClass()

Gets the name of the concrete DocReader class that is used to read this type of Document, which is "HarvestLogReader".

Specified by:

getReaderClass in interface DocWriter

Returns:

The String "HarvestLogReader".

logEntry

public final Document logEntry(long harvestUid,
                               long startTime,
                               long endTime,
                               int recordCount,
                               int resumptionCount,
                               int messageType,
                               String harvestedRecordsDir,
                               String message)

addToAdminDefaultField

protected final void addToAdminDefaultField(String value,
                                            StringBuffer adminDefaultBuffer)

Adds the given String to a text field referenced in the index by the field name 'default'. The default field may be used in queries to quickly search for text across fields. This method should be called from the addCustomFields of implementing classes.

Parameters:

value - A text string to be added to the indexed field named 'default.'

adminDefaultBuffer - The feature to be added to the ToDefaultField attribute