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

Class DocumentLengthTransformer

java.lang.Object

com.norconex.importer.handler.transformer.impl.DocumentLengthTransformer

All Implemented Interfaces:

Configurable<DocumentLengthTransformerConfig>, ConfigurableDocHandler<DocumentLengthTransformerConfig>, DocHandler

public class DocumentLengthTransformer
extends Object
implements ConfigurableDocHandler<DocumentLengthTransformerConfig>

Adds the document length (i.e., number of bytes) to the specified field. The length is the document content length as it is in its current processing stage. If for instance you set this tagger after a transformer that modifies the content, the obtained length will be for the modified content, and not the original length. To obtain a document's length before any modification was made to it, use this tagger as one of the first handler in your pre-parse handlers.

Storing values in an existing field

If a target field with the same name already exists for a document, values will be added to the end of the existing value list. It is possible to change this default behavior by supplying a PropertySetter.

Can be used both as a pre-parse or post-parse handler.

The following stores the document lenght into a "docSize" field.

See Also:

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

Method Summary

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

DocumentLengthTransformer

public DocumentLengthTransformer()

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

Specified by:

getConfiguration in interface Configurable<DocumentLengthTransformerConfig>

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