com.ibm.di.fc.dcs
Class DataCleanserFC

java.lang.Object
  com.ibm.di.fc.Function
      com.ibm.di.fc.dcs.DataCleanserFC

All Implemented Interfaces:

FunctionInterface, VersionInfoInterface

public class DataCleanserFC
extends Function

This class initializes Data Cleanser Service and takes a string and gives a standard CDM String corresponding to the inout string.

Field Summary

static java.lang.String	CDM_ATTR_TYPE This output map attribute is used to override the CDM Attribute name set in the Components configuration panel.
static java.lang.String	CLEANSED_STRING This input map attribute is the cleansed string of the given input string.
static java.lang.String	INPUT_STRING This output map attribute is for input string which need to be cleansed.

Fields inherited from class com.ibm.di.fc.Function

logger

Constructor Summary

DataCleanserFC()

Method Summary

java.util.Map<java.lang.String,java.lang.Object>	getAttributeTypes() Retrieves the Attribute Types which can be cleansed.
java.lang.String	getVersion() Version information.
void	initialize(java.lang.Object obj) Called once to initialize the Function Component.
java.lang.Object	perform(java.lang.Object obj) The FC takes the string which needs to be cleansed and a CDM Attribute.

Methods inherited from class com.ibm.di.fc.Function

debug, getConfiguration, getContext, getDebug, getLog, getParam, getRSInterface, getUI, initialize, logmsg, querySchema, setConfiguration, setContext, setDebug, setLog, setParam, setRSInterface, terminate, updateSchema, verifyInitialized

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CDM_ATTR_TYPE

public static final java.lang.String CDM_ATTR_TYPE

This output map attribute is used to override the CDM Attribute name set in the Components configuration panel.

See Also:

Constant Field Values

INPUT_STRING

public static final java.lang.String INPUT_STRING

This output map attribute is for input string which need to be cleansed.

See Also:

Constant Field Values

CLEANSED_STRING

public static final java.lang.String CLEANSED_STRING

This input map attribute is the cleansed string of the given input string.

See Also:

Constant Field Values

Constructor Detail

DataCleanserFC

public DataCleanserFC()

Method Detail

initialize

public void initialize(java.lang.Object obj)
                throws java.lang.Exception

Called once to initialize the Function Component.

Specified by:

initialize in interface FunctionInterface

Overrides:

initialize in class Function

Parameters:

obj - - ignored

Throws:

java.lang.Exception - if an error occurs.

perform

public java.lang.Object perform(java.lang.Object obj)
                         throws java.lang.Exception

The FC takes the string which needs to be cleansed and a CDM Attribute. If the string has a corresponding CDM standard name it gives the standard name of the string otherwise gives the same string which was passed.

Parameters:

obj - the work entry passed to the FC.

Returns:

an empty Entry object.

Throws:

java.lang.Exception - if a problem occurs.

getAttributeTypes

public java.util.Map<java.lang.String,java.lang.Object> getAttributeTypes()
                                                                   throws java.lang.Exception

Retrieves the Attribute Types which can be cleansed.

Returns:

the Attribute Type which can be cleansed.

Throws:

java.lang.Exception - if error occurred.

getVersion

public java.lang.String getVersion()

Version information.

Returns:

version information.