|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface FunctionInterface
This is the interface implemented by Function objects.
Method Summary | |
---|---|
void |
debug(String aMsg)
If debug is turned on, logs a message to the currently used log. |
BaseConfiguration |
getConfiguration()
Gets the configuration attribute of the FunctionInterface object |
Object |
getContext()
Retrieves used defined context. |
Log |
getLog()
Returns the logger object in use by this FC |
Object |
getParam(String param)
Gets a named parameter in the configuration. |
RSInterface |
getRSInterface()
Returns the current RSInterface object in use by this Function. |
Component |
getUI()
Deprecated. |
void |
initialize(Object obj)
Called once to initialize the function |
void |
logmsg(String msg)
Logs a message to the currently used log |
Object |
perform(Object obj)
This is the main method of a Function Component. |
Object |
querySchema(Object source)
This method translates to whatever means a function component has to discover schema for a connection. |
void |
setConfiguration(BaseConfiguration config)
Sets the configuration attribute of the FunctionInterface object |
void |
setContext(Object aContext)
Sets the user defined context. |
void |
setLog(Log logger)
Sets the logger object to use in this FC |
void |
setParam(String param,
Object value)
Sets a named parameter in the configuration. |
void |
setRSInterface(RSInterface rsi)
Sets the RSInterface object for this Function. |
void |
terminate()
The implementation of this method must take care to cleanup any resources which the Function Component has allocated during its operation. |
boolean |
updateSchema(FunctionConfig config)
This method modifies the schema in the provided configuration. |
Method Detail |
---|
void initialize(Object obj) throws Exception
obj
- this object provides information to the Function Component
needed on initialization
Exception
- An exception is thrown if the initialization fails.Object perform(Object obj) throws Exception
obj
- the input to the function
Exception
- An exception is thrown if this method fails.void terminate() throws Exception
Exception
- An exception is thrown if this method fails.Component getUI()
BaseConfiguration getConfiguration()
void setConfiguration(BaseConfiguration config)
config
- The new configuration valueboolean updateSchema(FunctionConfig config) throws Exception
config
- FunctionConfig
Exception
Object getParam(String param)
param
- the name of the parameter whose value this method returns
void setParam(String param, Object value)
param
- The new parameter's namevalue
- The new parameter valuevoid logmsg(String msg)
msg
- The message appearing in the logvoid setLog(Log logger)
logger
- The log objectLog getLog()
void debug(String aMsg)
aMsg
- The debug message appearing in the logObject getContext()
void setContext(Object aContext)
aContext
- StringObject querySchema(Object source) throws Exception
Each Entry in the Vector returned should contain the following attributes:
Name | Value |
---|---|
name | The name of the column/attribute/field .... |
syntax | The syntax or expected value type |
size | If specified this will give the user a hint as to how long the field may be |
source
- The object on which to discover schema. This may be an Entry
or a string value. Boolean value will tell which schema to
discover: true - InputMapSchema, false - OutputMapSchema. If
not specified the default will be true. Might be a
FunctionConfig object which will be set as the configuration
of this object. Could be an array of objects (i.e. Object[]).
Only the first object of a specific type will be considered,
the rest (if any) will be ignored.
Exception
Entry
,
Vector
void setRSInterface(RSInterface rsi)
RSInterface getRSInterface()
com.ibm.di.server.RS.getServer()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |