com.ibm.di.config.xml
Class FormFactory

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

public class FormFactory
extends Factories

Read/write FormConfig elements in XML format.

Field Summary

static String	FORM_ITEM_LOCAL_VALUES
static String	FORM_ITEM_NAMES
static String	FORM_ITEM_TAG
static String	FORM_ITEM_VALUES
static String	FORM_SECTION
static String	FORM_SECTION_NAMES
static String	FORM_TAG
static String	ITEM
static String	KEY
static String	LIST_ITEM
static String	TRANSLATION
static String	VALUE

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

FormFactory()

Method Summary

void	build(BaseConfiguration config, Element elem) Generate a XML element from a configuration object.
void	getList(Element p, List<String> list, String tag)
Map<String,String>	getMap(Element p, String tag)
FormSection	getSection(Element elem)
void	parse(BaseConfiguration config, Element elem) Parse a XML element into a configuration object.
void	setList(Element p, List<String> list, String tag)
void	setMap(Element p, Map<String,String> map, String tag)
void	setSection(Element p, FormSection section)

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

FORM_TAG

public static final String FORM_TAG

See Also:

Constant Field Values

FORM_ITEM_NAMES

public static final String FORM_ITEM_NAMES

See Also:

Constant Field Values

FORM_ITEM_TAG

public static final String FORM_ITEM_TAG

See Also:

Constant Field Values

FORM_ITEM_VALUES

public static final String FORM_ITEM_VALUES

See Also:

Constant Field Values

FORM_ITEM_LOCAL_VALUES

public static final String FORM_ITEM_LOCAL_VALUES

See Also:

Constant Field Values

FORM_SECTION_NAMES

public static final String FORM_SECTION_NAMES

See Also:

Constant Field Values

FORM_SECTION

public static final String FORM_SECTION

See Also:

Constant Field Values

LIST_ITEM

public static final String LIST_ITEM

See Also:

Constant Field Values

ITEM

public static final String ITEM

See Also:

Constant Field Values

KEY

public static final String KEY

See Also:

Constant Field Values

VALUE

public static final String VALUE

See Also:

Constant Field Values

TRANSLATION

public static final String TRANSLATION

See Also:

Constant Field Values

Constructor Detail

FormFactory

public FormFactory()

Method Detail

parse

public void parse(BaseConfiguration config,
                  Element elem)
           throws 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:

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

build

public void build(BaseConfiguration config,
                  Element elem)
           throws 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:

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.

getList

public void getList(Element p,
                    List<String> list,
                    String tag)
             throws Exception

Throws:

Exception

setList

public void setList(Element p,
                    List<String> list,
                    String tag)
             throws Exception

Throws:

Exception

getMap

public Map<String,String> getMap(Element p,
                                 String tag)
                          throws Exception

Throws:

Exception

setMap

public void setMap(Element p,
                   Map<String,String> map,
                   String tag)
            throws Exception

Throws:

Exception

getSection

public FormSection getSection(Element elem)
                       throws Exception

Throws:

Exception

setSection

public void setSection(Element p,
                       FormSection section)
                throws Exception

Throws:

Exception