com.ibm.di.fc
Class JavaClassFC

java.lang.Object
  com.ibm.di.fc.Function
      com.ibm.di.fc.JavaClassFC

All Implemented Interfaces:

FunctionInterface, VersionInfoInterface

public class JavaClassFC
extends Function

Field Summary

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

logger

Constructor Summary

JavaClassFC()

Method Summary

Object	getInstance()
Vector	getMethods()
String	getVersion() Return version information
void	initialize(Object obj) Called once to initialize the function
Object	perform(Object obj) This is the main method of a Function Component.
void	setInstance(Object obj)
boolean	updateSchema(FunctionConfig config) This method modifies the schema in the provided configuration.

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

debug, getConfiguration, getContext, getLog, getParam, getUI, initialize, logmsg, setConfiguration, setContext, setLog, setParam, terminate, verifyInitialized

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaClassFC

public JavaClassFC()

Method Detail

initialize

public void initialize(Object obj)
                throws Exception

Called once to initialize the function

Specified by:

initialize in interface FunctionInterface

Overrides:

initialize in class Function

Parameters:

obj - Additional information

Throws:

Exception - If the configuration is not complete, or the class or method cannot be found

setInstance

public void setInstance(Object obj)

getInstance

public Object getInstance()

perform

public Object perform(Object obj)
               throws Exception

Description copied from interface: FunctionInterface

This is the main method of a Function Component. This method is called for the Function Component to actually do its job. The implementation of this methods performs the function which the Function Component was created to do.

Parameters:

obj - An Entry containing the values of the parameters

Returns:

The result of calling the method

Throws:

Exception - If no method is found. If parameters are needed, and obj is not an Entry.

getVersion

public String getVersion()

Return version information

Returns:

The version value

getMethods

public Vector getMethods()

updateSchema

public boolean updateSchema(FunctionConfig config)
                     throws Exception

This method modifies the schema in the provided configuration. The intent is to allow the FC to provide a schema definition dynamically based on a given configuration. Note: changes the configuration of this component

Specified by:

updateSchema in interface FunctionInterface

Overrides:

updateSchema in class Function

Parameters:

config - - The new FunctionConfig to use

Returns:

- true if the schema was successfully updated

Throws:

Exception