Package com.norconex.importer.handler.transformer.impl

Class BinaryContentTransformer

java.lang.Object

com.norconex.importer.handler.transformer.impl.BinaryContentTransformer

All Implemented Interfaces:

Configurable<BinaryContentTransformerConfig>, ConfigurableDocHandler<BinaryContentTransformerConfig>, DocHandler

public class BinaryContentTransformer
extends Object
implements ConfigurableDocHandler<BinaryContentTransformerConfig>

Captures the document's original, unparsed content and stores it, Base64-encoded, in a metadata field. This is meant for consumers that need access to the raw document bytes after parsing has taken place (parsing normally discards the original content), such as a committer uploading the original file content rather than the extracted text.

Must be used as a pre-parse handler: the document is still in its original format at that point. Using it post-parse raises an error since the original content is no longer available by then.

See Also:

• BinaryContentTransformer configuration reference

Field Summary

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

PROPERTY

Fields inherited from interface com.norconex.importer.handler.DocHandler

NAME

Constructor Summary

Constructors

Constructor	Description
BinaryContentTransformer()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
BinaryContentTransformerConfig	getConfiguration()
boolean	handle(DocHandlerContext docCtx)	Perform any operations on a document.
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.importer.handler.DocHandler

close, init

Constructor Details

BinaryContentTransformer

public BinaryContentTransformer()

Method Details

handle

public boolean handle(DocHandlerContext docCtx)
               throws IOException

Description copied from interface: DocHandler

Perform any operations on a document.

Specified by:

handle in interface DocHandler

Parameters:

docCtx - the document handling context

Returns:

false to stop processing and reject a document or true to proceed to the next configured handler.

Throws:

IOException - An I/O exception of some sort has occurred

getConfiguration

public BinaryContentTransformerConfig getConfiguration()

Specified by:

getConfiguration in interface Configurable<BinaryContentTransformerConfig>

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