com.norconex.collector.core.checksum

Class AbstractDocumentChecksummer

java.lang.Object

com.norconex.collector.core.checksum.AbstractDocumentChecksummer

All Implemented Interfaces:

IDocumentChecksummer, IXMLConfigurable

Direct Known Subclasses:

MD5DocumentChecksummer

public abstract class AbstractDocumentChecksummer
extends Object
implements IDocumentChecksummer, IXMLConfigurable

Abstract implementation of IDocumentChecksummer giving the option to keep the generated checksum in a metadata field. The checksum can be stored in a target field name specified. If no target field name is specified, it stores it under the metadata field name CollectorMetadata.COLLECTOR_CHECKSUM_DOC.

Implementors do not need to store the checksum themselves, this abstract class does it.

Implementors should offer this XML configuration usage:

  <documentChecksummer 
      class="(subclass)"
      keep="[false|true]"
      targetField="(optional metadata field to store the checksum)" />
 

targetField is ignored unless the keep attribute is set to true.

Author:

Pascal Essiembre

Constructor Summary

Constructors

Constructor and Description
AbstractDocumentChecksummer()

Method Summary

Modifier and Type	Method and Description
String	createDocumentChecksum(ImporterDocument document) Creates a document checksum.
protected abstract String	doCreateDocumentChecksum(ImporterDocument document)
boolean	equals(Object other)
String	getTargetField() Gets the metadata field to use to store the checksum value.
int	hashCode()
boolean	isKeep() Whether to keep the document checksum value as a new field in the document metadata.
protected abstract void	loadChecksummerFromXML(XMLConfiguration xml)
void	loadFromXML(Reader in)
protected abstract void	saveChecksummerToXML(EnhancedXMLStreamWriter writer)
void	saveToXML(Writer out)
void	setKeep(boolean keep) Sets whether to keep the document checksum value as a new field in the document metadata.
void	setTargetField(String targetField) Sets the metadata field name to use to store the checksum value.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AbstractDocumentChecksummer

public AbstractDocumentChecksummer()

Method Detail

createDocumentChecksum

public final String createDocumentChecksum(ImporterDocument document)

Description copied from interface: IDocumentChecksummer

Creates a document checksum.

Specified by:

createDocumentChecksum in interface IDocumentChecksummer

Parameters:

document - an HTTP document

Returns:

a checksum value

doCreateDocumentChecksum

protected abstract String doCreateDocumentChecksum(ImporterDocument document)

isKeep

public boolean isKeep()

Whether to keep the document checksum value as a new field in the document metadata.

Returns:

true to keep the checksum

setKeep

public void setKeep(boolean keep)

Sets whether to keep the document checksum value as a new field in the document metadata.

Parameters:

keep - true to keep the checksum

getTargetField

public String getTargetField()

Gets the metadata field to use to store the checksum value. Defaults to CollectorMetadata.COLLECTOR_CHECKSUM_DOC. Only applicable if isKeep() returns true

Returns:

metadata field name

setTargetField

public void setTargetField(String targetField)

Sets the metadata field name to use to store the checksum value.

Parameters:

targetField - the metadata field name

loadFromXML

public final void loadFromXML(Reader in)

Specified by:

loadFromXML in interface IXMLConfigurable

loadChecksummerFromXML

protected abstract void loadChecksummerFromXML(XMLConfiguration xml)

saveToXML

public final void saveToXML(Writer out)
                     throws IOException

Specified by:

saveToXML in interface IXMLConfigurable

Throws:

IOException

saveChecksummerToXML

protected abstract void saveChecksummerToXML(EnhancedXMLStreamWriter writer)
                                      throws XMLStreamException

Throws:

XMLStreamException

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object