com.ibm.di.fc.idml
Class RollingIdMLFC

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

All Implemented Interfaces:

FunctionInterface, VersionInfoInterface

public class RollingIdMLFC
extends Function

This Component is used to split IdML files based either on the count of artifacts (CIs or Relationships) added to the file or on its size. Thus it is not applicable for in-memory IdMLs.

Field Summary

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

logger

Constructor Summary

RollingIdMLFC()

Method Summary

java.lang.String	getVersion() Version information.
void	initialize(java.lang.Object object) This method is/should be called once after the object has been given its configuration
java.lang.Object	perform(java.lang.Object obj) The FC checks if either the IdML file size, or the count of the contained attributes exceeds the configured limit.

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

Constructor Detail

RollingIdMLFC

public RollingIdMLFC()

Method Detail

initialize

public void initialize(java.lang.Object object)
                throws java.lang.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:

java.lang.Exception - An exception is thrown if the initialization fails.

perform

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

The FC checks if either the IdML file size, or the count of the contained attributes exceeds the configured limit. If so it splits the IdML file (closes and reopens it) and returns the full path to the already closed IdML. If none of the splitting conditions are reached, the FC skips the splitting operation.

Parameters:

obj - the work entry passed to the FC.

Returns:

an entry object, containing the BOOK_PART_NAME_ATTR attribute.

Throws:

java.lang.Exception - if a problem occurs.

getVersion

public java.lang.String getVersion()

Version information.

Returns:

version information