Package com.norconex.crawler.core.doc.operations.checksum

Class AbstractDocumentChecksummer<T extends BaseChecksummerConfig>

java.lang.Object

com.norconex.crawler.core.doc.operations.checksum.AbstractDocumentChecksummer<T>

Type Parameters:

T - configurable type

All Implemented Interfaces:

Configurable<T>, DocumentChecksummer

Direct Known Subclasses:

Md5DocumentChecksummer

public abstract class AbstractDocumentChecksummer<T extends BaseChecksummerConfig>
extends Object
implements DocumentChecksummer, Configurable<T>

Abstract implementation of DocumentChecksummer 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 CrawlerDocMetaConstants.CHECKSUM_DOC.

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

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

Field Summary

Fields inherited from interface com.norconex.commons.lang.config.Configurable

PROPERTY

Constructor Summary

Constructors

Constructor	Description
AbstractDocumentChecksummer()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
final String	createDocumentChecksum(Doc document)	Creates a document checksum.
protected abstract String	doCreateDocumentChecksum(Doc document)
boolean	equals(Object o)
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.norconex.commons.lang.config.Configurable

getConfiguration

Constructor Details

AbstractDocumentChecksummer

public AbstractDocumentChecksummer()

Method Details

createDocumentChecksum

public final String createDocumentChecksum(Doc document)

Description copied from interface: DocumentChecksummer

Creates a document checksum.

Specified by:

createDocumentChecksum in interface DocumentChecksummer

Parameters:

document - an HTTP document

Returns:

a checksum value

doCreateDocumentChecksum

protected abstract String doCreateDocumentChecksum(Doc document)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object