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

Class KeepOnlyTransformer

java.lang.Object

com.norconex.importer.handler.transformer.impl.KeepOnlyTransformer

All Implemented Interfaces:

Configurable<KeepOnlyTransformerConfig>, ConfigurableDocHandler<KeepOnlyTransformerConfig>, DocHandler

public class KeepOnlyTransformer
extends Object
implements ConfigurableDocHandler<KeepOnlyTransformerConfig>

Keep only the metadata fields provided, delete all other ones. Exact field names (case-insensitive) to keep can be provided as well as a regular expression that matches one or many fields (since 2.1.0).

Note: Unless you have good reasons for doing otherwise, it is recommended to use this handler as one of the last ones to be executed. This is a good practice to ensure all metadata fields are available to other handlers that may require them even if they are not otherwise required.

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

See Also:

• Pattern
• KeepOnlyTransformer 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
KeepOnlyTransformer()

Method Summary

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

KeepOnlyTransformer

public KeepOnlyTransformer()

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

Specified by:

getConfiguration in interface Configurable<KeepOnlyTransformerConfig>

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