com.ibm.di.fc.idml
Class OpenIdMLFC

java.lang.Object
  com.ibm.di.fc.Function
      com.ibm.di.fc.idml.OpenIdMLFC

All Implemented Interfaces:

FunctionInterface, VersionInfoInterface

public class OpenIdMLFC
extends Function

This IdML Component creates an IdML book and opens it for writing. It supports both in-memory books (kept in memory, while new data is accumulated to them) and ones that are directly stored to a file. The created IdML can be either delta or refresh one.

Field Summary

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

logger

Constructor Summary

OpenIdMLFC()

Method Summary

String	checkDbConnection() Checks if with the currently configured IT registry properties, a connection to the IT registry can be established.
String	getCdmVersion() Returns the version of the CDM that this Connector is using.
String	getDbUsername() This method returns the username for connecting to the IT registry used by the Connector.
String	getJdbcDriver() This method returns the JDBC Driver used by the Connector.
String	getJdbcUrl() This method returns the JDBC Url used by the Connector.
String	getVersion() Version information.
void	initialize(Object object) This method is/should be called once after the object has been given its configuration
Object	perform(Object obj) The FC check if the book it is configured to use is not existent or not opened yet.
Object	querySchema(Object input) This method displays the attributes belonging to the MSS class.
void	terminate() This method frees any resources allocated by the Component.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenIdMLFC

public OpenIdMLFC()

Method Detail

initialize

public void initialize(Object object)
                throws Exception

This method is/should be called once after the object has been given its configuration

Specified by:

initialize in interface FunctionInterface

Overrides:

initialize in class Function

Parameters:

object - this object provides information to the Function Component needed on initialization

Throws:

Exception - An exception is thrown if the initialization fails.

perform

public Object perform(Object obj)
               throws Exception

The FC check if the book it is configured to use is not existent or not opened yet. In this case the FC prepares the book and opens it for writing. Otherwise it just logs a message that the book is already prepared for use.

Parameters:

obj - the work entry passed to the FC.

Returns:

an empty Entry object.

Throws:

Exception - if a problem occurs.

terminate

public void terminate()
               throws Exception

This method frees any resources allocated by the Component.

Specified by:

terminate in interface FunctionInterface

Overrides:

terminate in class Function

Throws:

Exception - an exception is thrown if this method fails

getVersion

public String getVersion()

Version information.

Returns:

version information

getJdbcUrl

public String getJdbcUrl()

This method returns the JDBC Url used by the Connector.

Returns:

a JDBC Url.

getJdbcDriver

public String getJdbcDriver()

This method returns the JDBC Driver used by the Connector.

Returns:

a JDBC Driver.

getDbUsername

public String getDbUsername()

This method returns the username for connecting to the IT registry used by the Connector.

Returns:

a database username.

querySchema

public Object querySchema(Object input)
                   throws Exception

This method displays the attributes belonging to the MSS class. For a source of this meta-data it uses either a local jar file or meta-data calls to an IT registry (depending on its configuration).

Specified by:

querySchema in interface FunctionInterface

Overrides:

querySchema in class Function

Parameters:

input - entry object

Returns:

null, since this Components has itself populated the Schemas.

Throws:

Exception - if a problem occurs.

See Also:

Entry, Vector

checkDbConnection

public String checkDbConnection()

Checks if with the currently configured IT registry properties, a connection to the IT registry can be established.

Returns:

if the connection was established successfully null is returned, otherwise the method returns a String containing the exception's text.

getCdmVersion

public String getCdmVersion()
                     throws Exception

Returns the version of the CDM that this Connector is using. depending on its configuration this can be either the version of CDM that IT registry is using or the version of the CDM meta-data stored in the locally used jar file.

Returns:

the CDM version, with format '<version>.<release>.<modifier>'.

Throws:

Exception - if a problem occurs.