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

Class FieldReportTransformer

java.lang.Object

com.norconex.importer.handler.transformer.impl.FieldReportTransformer

All Implemented Interfaces:

Configurable<FieldReportTransformerConfig>, ConfigurableDocHandler<FieldReportTransformerConfig>, DocHandler

public class FieldReportTransformer
extends Object
implements ConfigurableDocHandler<FieldReportTransformerConfig>

A utility tagger that reports in a CSV file the fields discovered in a crawl session, captured at the point of your choice in the importing process. If you use this class to report on all fields discovered, make sure you use it as a post-parse handler, before you are limiting which fields you want to keep.

The report will list one field per row, along with a few sample values (3 by default). The samples will be the first ones encountered.

This handler does not impact the data being imported at all (it only reads it). It also do not store the "content" as a field.

When not specified with FieldReportTransformerConfig.setFile(Path), a file called "field-report.csv" will be created in the working directory.

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

See Also:

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

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
FieldReportTransformerConfig	getConfiguration()
Map<String,com.norconex.importer.handler.transformer.impl.FieldReportTransformer.FieldData>	getFields()
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

FieldReportTransformer

public FieldReportTransformer()

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

Specified by:

getConfiguration in interface Configurable<FieldReportTransformerConfig>

getFields

public Map<String,com.norconex.importer.handler.transformer.impl.FieldReportTransformer.FieldData> getFields()

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