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

Class FieldReportTransformerConfig

java.lang.Object

com.norconex.importer.handler.BaseLabelableConfig

com.norconex.importer.handler.BaseDocHandlerConfig

com.norconex.importer.handler.transformer.impl.FieldReportTransformerConfig

All Implemented Interfaces:

Labelable

public class FieldReportTransformerConfig
extends BaseDocHandlerConfig

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 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

Modifier and Type	Field	Description
static final Path	DEFAULT_FILE
static final int	DEFAULT_MAX_SAMPLES

Constructor Summary

Constructors

Constructor	Description
FieldReportTransformerConfig()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Path	getFile()
int	getMaxSamples()
int	getTruncateSamplesAt()
int	hashCode()
boolean	isWithHeaders()
boolean	isWithOccurences()
FieldReportTransformerConfig	setFile(Path file)
FieldReportTransformerConfig	setMaxSamples(int maxSamples)
FieldReportTransformerConfig	setTruncateSamplesAt(int truncateSamplesAt)
FieldReportTransformerConfig	setWithHeaders(boolean withHeaders)
FieldReportTransformerConfig	setWithOccurences(boolean withOccurences)
String	toString()

Methods inherited from class com.norconex.importer.handler.BaseLabelableConfig

getLabel, setLabel

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

DEFAULT_MAX_SAMPLES

public static final int DEFAULT_MAX_SAMPLES

See Also:

• Constant Field Values

DEFAULT_FILE

public static final Path DEFAULT_FILE

Constructor Details

FieldReportTransformerConfig

public FieldReportTransformerConfig()

Method Details

getMaxSamples

public int getMaxSamples()

getFile

public Path getFile()

isWithHeaders

public boolean isWithHeaders()

isWithOccurences

public boolean isWithOccurences()

getTruncateSamplesAt

public int getTruncateSamplesAt()

setMaxSamples

public FieldReportTransformerConfig setMaxSamples(int maxSamples)

Returns:

this.

setFile

public FieldReportTransformerConfig setFile(Path file)

Returns:

this.

setWithHeaders

public FieldReportTransformerConfig setWithHeaders(boolean withHeaders)

Returns:

this.

setWithOccurences

public FieldReportTransformerConfig setWithOccurences(boolean withOccurences)

Returns:

this.

setTruncateSamplesAt

public FieldReportTransformerConfig setTruncateSamplesAt(int truncateSamplesAt)

Returns:

this.

equals

public boolean equals(Object o)

Overrides:

equals in class BaseLabelableConfig

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class BaseLabelableConfig

hashCode

public int hashCode()

Overrides:

hashCode in class BaseLabelableConfig

toString

public String toString()

Overrides:

toString in class BaseLabelableConfig