com.norconex.importer.handler.tagger.impl

Class CharacterCaseTagger

java.lang.Object

com.norconex.importer.handler.AbstractImporterHandler

com.norconex.importer.handler.tagger.AbstractDocumentTagger

com.norconex.importer.handler.tagger.impl.CharacterCaseTagger

All Implemented Interfaces:

IXMLConfigurable, IImporterHandler, IDocumentTagger

public class CharacterCaseTagger
extends AbstractDocumentTagger

Changes the character case of field values according to one of the following methods:

• uppper: 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 the rest to lower case.
• string: Converts the first letter of a string if not numeric, and leaves the character case of other characters unchanged (since 2.7.0).
• swap: Converts all upper case characters to lower case, and all lower case to upper case (since 2.7.0).

Since 2.3.0, 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.

XML configuration usage:

  <tagger class="com.norconex.importer.handler.tagger.impl.CharacterCaseTagger">
      
      <restrictTo caseSensitive="[false|true]"
              field="(name of header/metadata field name to match)">
          (regular expression of value to match)
      </restrictTo>
      <!-- multiple "restrictTo" tags allowed (only one needs to match) -->
      
      <characterCase fieldName="(field to change)"
                     type="[upper|lower|words|string|swap]" 
                     applyTo="[value|field|both]" />
      <!-- multiple characterCase tags allowed -->
      
  </tagger>
 

Usage example:

Documents can use different character case for their title field names. This example makes them all lower case. We also make sure the value starts with an upper case.

  <tagger class="com.norconex.importer.handler.tagger.impl.CharacterCaseTagger">
      <characterCase fieldName="title" type="lower" applyTo="field" />
      <characterCase fieldName="title" type="string" applyTo="value" />
  </tagger>
 

Since:

2.0.0

Author:

Pascal Essiembre

Field Summary

Fields

Modifier and Type	Field and Description
static String	APPLY_BOTH
static String	APPLY_FIELD
static String	APPLY_VALUE
static String	CASE_LOWER
static String	CASE_STRING
static String	CASE_SWAP
static String	CASE_UPPER
static String	CASE_WORDS

Constructor Summary

Constructors

Constructor and Description
CharacterCaseTagger()

Method Summary

Modifier and Type	Method and Description
void	addFieldCase(String field, String caseType)
void	addFieldCase(String field, String caseType, String applyTo) Adds field case changing instructions.
boolean	equals(Object other)
String	getApplyTo(String fieldName) Gets what the case changing instructions apply to.
String	getCaseType(String fieldName)
Set<String>	getFieldNames()
int	hashCode()
protected void	loadHandlerFromXML(org.apache.commons.configuration.XMLConfiguration xml) Loads configuration settings specific to the implementing class.
protected void	saveHandlerToXML(EnhancedXMLStreamWriter writer) Saves configuration settings specific to the implementing class.
void	tagApplicableDocument(String reference, InputStream document, ImporterMetadata metadata, boolean parsed)
String	toString()

Methods inherited from class com.norconex.importer.handler.tagger.AbstractDocumentTagger

tagDocument

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

addRestriction, addRestriction, addRestrictions, clearRestrictions, detectCharsetIfBlank, getRestrictions, isApplicable, loadFromXML, removeRestriction, removeRestriction, saveToXML

Methods inherited from class java.lang.Object

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

Field Detail

CASE_WORDS

public static final String CASE_WORDS

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_STRING

public static final String CASE_STRING

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 Detail

CharacterCaseTagger

public CharacterCaseTagger()

Method Detail

tagApplicableDocument

public void tagApplicableDocument(String reference,
                                  InputStream document,
                                  ImporterMetadata metadata,
                                  boolean parsed)
                           throws ImporterHandlerException

Specified by:

tagApplicableDocument in class AbstractDocumentTagger

Throws:

ImporterHandlerException

addFieldCase

public void addFieldCase(String field,
                         String caseType)

addFieldCase

public void addFieldCase(String field,
                         String caseType,
                         String applyTo)

Adds field case changing instructions.

Parameters:

field - the field to apply the case changing

caseType - the type of case change to apply

applyTo - what to apply the case change to

Since:

2.4.0

getFieldNames

public Set<String> getFieldNames()

getCaseType

public String getCaseType(String fieldName)

getApplyTo

public String getApplyTo(String fieldName)

Gets what the case changing instructions apply to.

Parameters:

fieldName - the field name

Returns:

what the case changing instructions apply to

Since:

2.4.0

loadHandlerFromXML

protected void loadHandlerFromXML(org.apache.commons.configuration.XMLConfiguration xml)

Description copied from class: AbstractImporterHandler

Loads configuration settings specific to the implementing class.

Specified by:

loadHandlerFromXML in class AbstractImporterHandler

Parameters:

xml - xml configuration

saveHandlerToXML

protected void saveHandlerToXML(EnhancedXMLStreamWriter writer)
                         throws XMLStreamException

Description copied from class: AbstractImporterHandler

Saves configuration settings specific to the implementing class. The parent tag along with the "class" attribute are already written. Implementors must not close the writer.

Specified by:

saveHandlerToXML in class AbstractImporterHandler

Parameters:

writer - the xml writer

Throws:

XMLStreamException - could not save to XML

equals

public boolean equals(Object other)

Overrides:

equals in class AbstractImporterHandler

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractImporterHandler

toString

public String toString()

Overrides:

toString in class AbstractImporterHandler