org.icij.extract.document

Class AbstractIdentifier

java.lang.Object

org.icij.extract.document.AbstractIdentifier

All Implemented Interfaces:

Identifier

Direct Known Subclasses:

DigestIdentifier, PathDigestIdentifier, PathIdentifier

public abstract class AbstractIdentifier
extends Object
implements Identifier

Constructor Summary

Constructors

Constructor and Description
AbstractIdentifier()
AbstractIdentifier(String algorithm, Charset charset)

Method Summary

Modifier and Type	Method and Description
String	hash(TikaDocument tikaDocument) Generate or retrieve (from metadata) a hash digest of the tikaDocument's underlying file data.
String	retrieveHash(org.apache.tika.metadata.Metadata metadata) Retrieve a hash digest of the document's underlying file data.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.icij.extract.document.Identifier

generate, generateForEmbed

Constructor Detail

AbstractIdentifier

public AbstractIdentifier(String algorithm,
                          Charset charset)

AbstractIdentifier

public AbstractIdentifier()

Method Detail

hash

public String hash(TikaDocument tikaDocument)

Description copied from interface: Identifier

Generate or retrieve (from metadata) a hash digest of the tikaDocument's underlying file data. Even if the Identifier.generate(TikaDocument) methods of the implementation generate hash digests, those are semantically different as they represent a hash of the tikaDocument, rather than the file. The former might comprise the the relationship of the tikaDocument with its parent, or its position in the path hierarchy, whereas the latter must not.

Specified by:

hash in interface Identifier

Parameters:

tikaDocument - the tikaDocument for which to return a file hash digest

Returns:

the hash

retrieveHash

public String retrieveHash(org.apache.tika.metadata.Metadata metadata)

Description copied from interface: Identifier

Retrieve a hash digest of the document's underlying file data.

Specified by:

retrieveHash in interface Identifier

Parameters:

metadata - the document's metadata

Returns:

the hash