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

Class CharacterCaseTransformerConfig

java.lang.Object

com.norconex.importer.handler.BaseLabelableConfig

com.norconex.importer.handler.BaseDocHandlerConfig

com.norconex.importer.handler.transformer.impl.CharacterCaseTransformerConfig

All Implemented Interfaces:

Labelable

public class CharacterCaseTransformerConfig
extends BaseDocHandlerConfig

Changes the character case of matching fields and values according to one of the following methods:

• upper: Changes all characters to upper case.
• lower: Changes all characters values to lower case.
• words: Converts the first letter of each words to upper case, and leaves the character case of other characters unchanged.
• wordsFully: Converts the first letter of each words to upper case, and the rest to lower case.
• sentences: Converts the first letter of each sentence to upper case, and leaves the character case of other characters unchanged.
• sentencesFully: Converts the first letter of each sentence to upper case, and converts other characters to lower case.
• string: Converts the first letter of a string to upper case, and leaves the character case of other characters unchanged.
• stringFully: Converts the first letter of a string to upper case, and converts other characters to lower case.
• swap: Converts all upper case characters to lower case, and all lower case to upper case.

The change of character case can be applied to one of the following (defaults to "value" when unspecified):

• value: Applies to the field values.
• field: Applies to the field name.
• both: Applies to both the field name and its values.

Field names are referenced in a case insensitive manner.

See Also:

• CharacterCaseTransformer configuration reference

Field Summary

Fields

Modifier and Type	Field	Description
static final String	APPLY_BOTH
static final String	APPLY_FIELD
static final String	APPLY_VALUE
static final String	CASE_LOWER
static final String	CASE_SENTENCES
static final String	CASE_SENTENCES_FULLY
static final String	CASE_STRING
static final String	CASE_STRING_FULLY
static final String	CASE_SWAP
static final String	CASE_UPPER
static final String	CASE_WORDS
static final String	CASE_WORDS_FULLY

Constructor Summary

Constructors

Constructor	Description
CharacterCaseTransformerConfig()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
String	getApplyTo()	Whether to apply the case transformation to fields, values, or both.
String	getCaseType()	The type of character case transformation.
TextMatcher	getFieldMatcher()	Optional matcher of fields to apply transformation to.
int	hashCode()
CharacterCaseTransformerConfig	setApplyTo(String applyTo)	Whether to apply the case transformation to fields, values, or both.
CharacterCaseTransformerConfig	setCaseType(String caseType)	The type of character case transformation.
CharacterCaseTransformerConfig	setFieldMatcher(TextMatcher fieldMatcher)	Optional matcher of fields to apply transformation to.
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

CASE_WORDS

public static final String CASE_WORDS

See Also:

• Constant Field Values

CASE_WORDS_FULLY

public static final String CASE_WORDS_FULLY

See Also:

• Constant Field Values

CASE_UPPER

public static final String CASE_UPPER

See Also:

• Constant Field Values

CASE_LOWER

public static final String CASE_LOWER

See Also:

• Constant Field Values

CASE_SWAP

public static final String CASE_SWAP

See Also:

• Constant Field Values

CASE_SENTENCES

public static final String CASE_SENTENCES

See Also:

• Constant Field Values

CASE_SENTENCES_FULLY

public static final String CASE_SENTENCES_FULLY

See Also:

• Constant Field Values

CASE_STRING

public static final String CASE_STRING

See Also:

• Constant Field Values

CASE_STRING_FULLY

public static final String CASE_STRING_FULLY

See Also:

• Constant Field Values

APPLY_VALUE

public static final String APPLY_VALUE

See Also:

• Constant Field Values

APPLY_FIELD

public static final String APPLY_FIELD

See Also:

• Constant Field Values

APPLY_BOTH

public static final String APPLY_BOTH

See Also:

• Constant Field Values

Constructor Details

CharacterCaseTransformerConfig

public CharacterCaseTransformerConfig()

Method Details

getFieldMatcher

public TextMatcher getFieldMatcher()

Optional matcher of fields to apply transformation to. When not specified, transformation is on the document content.

Returns:

field matcher

setFieldMatcher

public CharacterCaseTransformerConfig setFieldMatcher(TextMatcher fieldMatcher)

Optional matcher of fields to apply transformation to. When not specified, transformation is on the document content.

Parameters:

fieldMatcher - field matcher

getCaseType

public String getCaseType()

The type of character case transformation.

Returns:

type of case transformation

getApplyTo

public String getApplyTo()

Whether to apply the case transformation to fields, values, or both. Does not apply when using this transformer on document content.

Returns:

one of "field", "value", or "both"

setCaseType

public CharacterCaseTransformerConfig setCaseType(String caseType)

The type of character case transformation.

Parameters:

caseType - type of case transformation

Returns:

this.

setApplyTo

public CharacterCaseTransformerConfig setApplyTo(String applyTo)

Whether to apply the case transformation to fields, values, or both. Does not apply when using this transformer on document content.

Parameters:

applyTo - one of "field", "value", or "both"

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