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

Class SaveDocumentTransformer

java.lang.Object

com.norconex.importer.handler.transformer.impl.SaveDocumentTransformer

All Implemented Interfaces:

Configurable<SaveDocumentTransformerConfig>, ConfigurableDocHandler<SaveDocumentTransformerConfig>, DocHandler

public class SaveDocumentTransformer
extends Object
implements ConfigurableDocHandler<SaveDocumentTransformerConfig>

Saves a copy of the document at its current processing state in the specified directory. If no directory is specified, the default is "./savedDocuments". It is recommended to use this tagger as a pre-parse handler if you want to save the original file.

Any maximum file path length value below 10 is considered unlimited (the default).

See Also:

• SaveDocumentTransformer 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
SaveDocumentTransformer()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
SaveDocumentTransformerConfig	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

SaveDocumentTransformer

public SaveDocumentTransformer()

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 SaveDocumentTransformerConfig getConfiguration()

Specified by:

getConfiguration in interface Configurable<SaveDocumentTransformerConfig>

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