com.ibm.di.config.xml
Class HookFactory

java.lang.Object
  com.ibm.di.config.xml.Factories
      com.ibm.di.config.xml.HookFactory

public class HookFactory
extends Factories

Read/Write HookConfig elements in XML format

Field Summary

static java.lang.String	HOOK_ITEM_DEBUG
static java.lang.String	HOOK_ITEM_ENABLED
static java.lang.String	HOOK_ITEM_NAME
static java.lang.String	HOOK_ITEM_SCRIPT
static java.lang.String	HOOK_ITEM_TAG
static java.lang.String	HOOK_TAG

Fields inherited from class com.ibm.di.config.xml.Factories

classMap, implMap, INHERIT_TAG, logger, NAME_ATTRIBUTE, NAME_TAG, NULLBEHAVIOR, NULLBEHAVIORVALUE, NULLDEFINITION, NULLDEFINITIONVALUE, PARAMETER_TAG, parent, USER_COMMENT_ATTRIBUTE, VALUE_ATTRIBUTE

Constructor Summary

HookFactory()

Method Summary

void	build(BaseConfiguration config, org.w3c.dom.Element elem) Generate a XML element from a configuration object.
void	getHookItem(org.w3c.dom.Element elem, HooksConfig config)
void	parse(BaseConfiguration config, org.w3c.dom.Element elem) Parse a XML element into a configuration object.
void	setHookItem(org.w3c.dom.Element elem, HookConfig config)

Methods inherited from class com.ibm.di.config.xml.Factories

debug, dump, getBaseName, getClassTag, getFactory, getImpl, getInheritsFrom, getNodeText, getNodeTextByName, getParameter, getParameters, getSingleElement, isDebugMode, logmsg, setBaseName, setInheritsFrom, setParameter, setParameters, setSingleElement, setSingleElement

Methods inherited from class java.lang.Object

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

Field Detail

HOOK_TAG

public static final java.lang.String HOOK_TAG

See Also:

Constant Field Values

HOOK_ITEM_TAG

public static final java.lang.String HOOK_ITEM_TAG

See Also:

Constant Field Values

HOOK_ITEM_NAME

public static final java.lang.String HOOK_ITEM_NAME

See Also:

Constant Field Values

HOOK_ITEM_SCRIPT

public static final java.lang.String HOOK_ITEM_SCRIPT

See Also:

Constant Field Values

HOOK_ITEM_ENABLED

public static final java.lang.String HOOK_ITEM_ENABLED

See Also:

Constant Field Values

HOOK_ITEM_DEBUG

public static final java.lang.String HOOK_ITEM_DEBUG

See Also:

Constant Field Values

Constructor Detail

HookFactory

public HookFactory()

Method Detail

parse

public void parse(BaseConfiguration config,
                  org.w3c.dom.Element elem)
           throws java.lang.Exception

Parse a XML element into a configuration object.

Overrides:

parse in class Factories

Parameters:

config - an instance of the BaseConfiguration class which internal parameters will get set based on the information from the provided XML Element.

elem - this is a part of the XML tree that represents the BaseConfiguration object.

Throws:

java.lang.Exception - in case the configuration object the provided XML element represents is not recognized.

getHookItem

public void getHookItem(org.w3c.dom.Element elem,
                        HooksConfig config)
                 throws java.lang.Exception

Throws:

java.lang.Exception

build

public void build(BaseConfiguration config,
                  org.w3c.dom.Element elem)
           throws java.lang.Exception

Generate a XML element from a configuration object.

Overrides:

build in class Factories

Parameters:

config - an instance of the BaseConfiguration class which internal parameters will be represented as a XML sub-tree.

elem - this is the part of the XML tree where the config object's XML representation will be attached to.

Throws:

java.lang.Exception - in case the tag name of the provided XML element is not recognized as a valid name which is used for configuration object representation as a XML.

setHookItem

public void setHookItem(org.w3c.dom.Element elem,
                        HookConfig config)
                 throws java.lang.Exception

Throws:

java.lang.Exception