com.ibm.di.fc.cbe
Class CBEGeneratorFC

java.lang.Object
  com.ibm.di.fc.Function
      com.ibm.di.fc.cbe.CBEGeneratorFC

All Implemented Interfaces:

FunctionInterface, VersionInfoInterface

public class CBEGeneratorFC
extends Function

This class generates objects of type org.eclipse.hyades.logging.events.cbe.CommonBaseEvent from attributes mapped by user to Entry object.

Field Summary

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

logger

Constructor Summary

CBEGeneratorFC()

Method Summary

static String	convertCBEEventToXML(org.eclipse.hyades.logging.events.cbe.CommonBaseEvent event) returns the CBE event as a XMLDocString using org.eclipse.hyades.logging.events.cbe.util.EventFormatter
static String	getCBELogXml(org.eclipse.hyades.logging.events.cbe.CommonBaseEvent event, boolean isXMLComplete) Method uses org.eclipse.hyades.logging.java.CommonBaseEventLogRecord to generate log records
String	getVersion() Returns version information
void	initialize(Object obj) This method initialises the eventFactory object used to create the CommonBaseEvent and the LOGGERS_NAME
static void	mapCbeToEntry(org.eclipse.hyades.logging.events.cbe.CommonBaseEvent aCbe, Entry aEntry) Maps the fields of a Common Base Event object into the attributes of a TDI Entry.
Object	perform(Object obj) The attributes of the Entry object passed as parameter to this method is mapped to a CommonBaseEvent.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

CBEGeneratorFC

public CBEGeneratorFC()

Method Detail

perform

public Object perform(Object obj)
               throws Exception

The attributes of the Entry object passed as parameter to this method is mapped to a CommonBaseEvent.

Parameters:

obj - object of type Entry

Returns:

the output from the function

Throws:

if - the user has passed a null or non Entry type object as param

Exception - An exception is thrown if this method fails.

getVersion

public String getVersion()

Returns version information

initialize

public void initialize(Object obj)
                throws Exception

This method initialises the eventFactory object used to create the CommonBaseEvent and the LOGGERS_NAME

Specified by:

initialize in interface FunctionInterface

Overrides:

initialize in class Function

Parameters:

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

Throws:

Exception - An exception is thrown if the initialization fails.

convertCBEEventToXML

public static String convertCBEEventToXML(org.eclipse.hyades.logging.events.cbe.CommonBaseEvent event)
                                   throws Exception

returns the CBE event as a XMLDocString using org.eclipse.hyades.logging.events.cbe.util.EventFormatter

Parameters:

event - CommonBaseEvent

Returns:

String

Throws:

Exception

getCBELogXml

public static String getCBELogXml(org.eclipse.hyades.logging.events.cbe.CommonBaseEvent event,
                                  boolean isXMLComplete)
                           throws Exception

Method uses org.eclipse.hyades.logging.java.CommonBaseEventLogRecord to generate log records

Parameters:

event - CommomnBaseEvent

isXMLComplete - returns a complete xml string if true

Returns:

xmlDocString

Throws:

Exception

mapCbeToEntry

public static void mapCbeToEntry(org.eclipse.hyades.logging.events.cbe.CommonBaseEvent aCbe,
                                 Entry aEntry)

Maps the fields of a Common Base Event object into the attributes of a TDI Entry. This process is the reverse of what the CBE Generator FC's 'perform' method does. All attributes in the resulting Entry are of type java.lang.String.

Parameters:

aCbe - the Common Base Event to be mapped into the Entry

aEntry - the Entry, where will be mapped the fields of the Common Base Event

Since:

6.1.1