org.dlese.dpc.index.writer

Class ErrorDocException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.dlese.dpc.index.writer.ErrorDocException

All Implemented Interfaces:

java.io.Serializable

public class ErrorDocException
extends java.lang.Exception

Exception that may be used to pass text and keywords to be written to the index by the ErrorFileIndexingWriter if an error occurs during indexing.

Author:

John Weatherley

See Also:

ErrorFileIndexingWriter, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ErrorDocException(java.lang.String message, java.lang.String errorDocType) Constructs an Exception with the specified detail message.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getErrorDocType()
java.lang.String[]	getKeywordFieldNames() Gets the names of the fields to be indexed as keywords.
java.lang.String	getKeywordFieldValue(java.lang.String fieldName) Gets the value of the field to be indexed as a keyword.
java.lang.String[]	getTextFieldNames() Gets the names of the fields to be indexed as text.
java.lang.String	getTextFieldValue(java.lang.String fieldName) Gets the value of the field to be indexed as text.
void	putKeywordField(java.lang.String fieldName, java.lang.String keyword) Adds a field to be indexed as a keyword.
void	putTextField(java.lang.String fieldName, java.lang.String text) Adds a field to be indexed as text.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ErrorDocException

public ErrorDocException(java.lang.String message,
                         java.lang.String errorDocType)

Constructs an Exception with the specified detail message.

Parameters:

message - the detailed message.

Method Detail

getErrorDocType

public java.lang.String getErrorDocType()

putKeywordField

public void putKeywordField(java.lang.String fieldName,
                            java.lang.String keyword)

Adds a field to be indexed as a keyword.

Parameters:

fieldName - The field name

keyword - The field content

getKeywordFieldNames

public java.lang.String[] getKeywordFieldNames()

Gets the names of the fields to be indexed as keywords.

Returns:

The keywordFieldNames value

getKeywordFieldValue

public java.lang.String getKeywordFieldValue(java.lang.String fieldName)

Gets the value of the field to be indexed as a keyword.

Parameters:

fieldName - The field name

Returns:

The value, or null

putTextField

public void putTextField(java.lang.String fieldName,
                         java.lang.String text)

Adds a field to be indexed as text.

Parameters:

fieldName - The field name

text - The field value

getTextFieldNames

public java.lang.String[] getTextFieldNames()

Gets the names of the fields to be indexed as text.

Returns:

The field names

getTextFieldValue

public java.lang.String getTextFieldValue(java.lang.String fieldName)

Gets the value of the field to be indexed as text.

Parameters:

fieldName - The field name

Returns:

The value