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

Class CharsetTransformerConfig

java.lang.Object

com.norconex.importer.handler.BaseLabelableConfig

com.norconex.importer.handler.BaseDocHandlerConfig

com.norconex.importer.handler.transformer.impl.CharsetTransformerConfig

All Implemented Interfaces:

Labelable

public class CharsetTransformerConfig
extends BaseDocHandlerConfig

Transforms a document content (if needed) from a source character encoding (charset) to a target one. Both the source and target character encodings are optional. If no source character encoding is explicitly provided, it first tries to detect the encoding of the document content before converting it to the target encoding. If the source character encoding cannot be established, the content encoding will remain unchanged. When no target character encoding is specified, UTF-8 is assumed.

Should I use this transformer?

Before using this transformer, you need to know the parsing of documents by the importer using default document parser factory will try to convert and return content as UTF-8 (for most, if not all content-types). If UTF-8 is your desired target, it only make sense to use this transformer as a pre-parsing handler (for text content-types only) when it is important to work with a specific character encoding before parsing. If on the other hand you wish to convert to a character encoding to a target different than UTF-8, you can use this transformer as a post-parsing handler to do so.

Conversion is not flawless

Because character encoding detection is not always accurate and because documents sometime mix different encoding, there is no guarantee this class will handle ALL character encoding conversions properly.

See Also:

• CharsetTransformer configuration reference

Field Summary

Fields

Modifier and Type	Field	Description
static final Charset	DEFAULT_TARGET_CHARSET

Constructor Summary

Constructors

Constructor	Description
CharsetTransformerConfig()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
TextMatcher	getFieldMatcher()	Optional matcher of fields to convert the character set of their values.
Charset	getSourceCharset()
Charset	getTargetCharset()
int	hashCode()
void	setFieldMatcher(TextMatcher fieldMatcher)	Set field matcher.
CharsetTransformerConfig	setSourceCharset(Charset sourceCharset)
CharsetTransformerConfig	setTargetCharset(Charset targetCharset)
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_TARGET_CHARSET

public static final Charset DEFAULT_TARGET_CHARSET

Constructor Details

CharsetTransformerConfig

public CharsetTransformerConfig()

Method Details

setFieldMatcher

public void setFieldMatcher(TextMatcher fieldMatcher)

Set field matcher.

Parameters:

fieldMatcher - field matcher

getTargetCharset

public Charset getTargetCharset()

getSourceCharset

public Charset getSourceCharset()

getFieldMatcher

public TextMatcher getFieldMatcher()

Optional matcher of fields to convert the character set of their values. When not specified, transformation is on the document content.

Returns:

field matcher

setTargetCharset

public CharsetTransformerConfig setTargetCharset(Charset targetCharset)

Returns:

this.

setSourceCharset

public CharsetTransformerConfig setSourceCharset(Charset sourceCharset)

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