com.ibm.di.config.xml
Class BranchingFactory

java.lang.Object
  extended by com.ibm.di.config.xml.Factories
      extended by com.ibm.di.config.xml.BranchingFactory

public class BranchingFactory
extends Factories

Read/write BranchingConfig and BranchCondition elements in XML format.


Field Summary
static java.lang.String BRANCH_CONDITION_TAG
          Name of the component.
static java.lang.String BRANCH_TAG
          Name of the component.
static java.lang.String CASESENSITIVE_TAG
          Name of the case sensitive tag.
static java.lang.String CONDITION_TAG
          Name of the conditions tag.
static java.lang.String ENABLED_TAG
          Name of the enabled tag.
static java.lang.String LEFT_HAND_TAG
          Name of the left hand tag.
static java.lang.String MATCH_ANY_TAG
          Name of the match any tag.
static java.lang.String NEGATE_TAG
          Name of the negate tag.
static java.lang.String OPERATOR_TAG
          Name of the operator tag.
static java.lang.String RIGHT_HAND_TAG
          Name of the right hand tag.
static java.lang.String SCRIPT_DELETED
          Tag indicating the script is deleted, but kept to allow it to be revived
static java.lang.String SCRIPT_TAG
          Name of the script condition tag.
static java.lang.String TYPE_TAG
          Name of the type tag.
 
Fields inherited from class com.ibm.di.config.xml.Factories
classMap, implMap, INHERIT_TAG, logger, MOD_TS_TAG, NAME_ATTRIBUTE, NAME_TAG, NULLBEHAVIOR, NULLBEHAVIORVALUE, NULLDEFINITION, NULLDEFINITIONVALUE, PARAMETER_TAG, parent, USER_COMMENT_ATTRIBUTE, VALUE_ATTRIBUTE
 
Constructor Summary
BranchingFactory()
           
 
Method Summary
 void build(BaseConfiguration bconfig, org.w3c.dom.Element elem)
          Generate a XML element from a configuration object.
 void build(BranchCondition config, org.w3c.dom.Element elem)
          Generate a XML Branch element from a configuration object.
 void build(BranchingConfig config, org.w3c.dom.Element elem)
          Generate a XML Branch Condition element from a configuration object.
 void parse(BaseConfiguration bconfig, org.w3c.dom.Element elem)
          Parse a XML element into a configuration object.
 void parse(BranchCondition config, org.w3c.dom.Element elem)
          Parse a XML Branch Condition element into a configuration object.
 void parse(BranchingConfig config, org.w3c.dom.Element elem)
          Parse a XML Branch element into a configuration object.
 
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

BRANCH_TAG

public static final java.lang.String BRANCH_TAG
Name of the component.

See Also:
Constant Field Values

BRANCH_CONDITION_TAG

public static final java.lang.String BRANCH_CONDITION_TAG
Name of the component.

See Also:
Constant Field Values

ENABLED_TAG

public static final java.lang.String ENABLED_TAG
Name of the enabled tag.

See Also:
Constant Field Values

SCRIPT_TAG

public static final java.lang.String SCRIPT_TAG
Name of the script condition tag.

See Also:
Constant Field Values

CONDITION_TAG

public static final java.lang.String CONDITION_TAG
Name of the conditions tag.

See Also:
Constant Field Values

LEFT_HAND_TAG

public static final java.lang.String LEFT_HAND_TAG
Name of the left hand tag.

See Also:
Constant Field Values

RIGHT_HAND_TAG

public static final java.lang.String RIGHT_HAND_TAG
Name of the right hand tag.

See Also:
Constant Field Values

OPERATOR_TAG

public static final java.lang.String OPERATOR_TAG
Name of the operator tag.

See Also:
Constant Field Values

NEGATE_TAG

public static final java.lang.String NEGATE_TAG
Name of the negate tag.

See Also:
Constant Field Values

CASESENSITIVE_TAG

public static final java.lang.String CASESENSITIVE_TAG
Name of the case sensitive tag.

See Also:
Constant Field Values

MATCH_ANY_TAG

public static final java.lang.String MATCH_ANY_TAG
Name of the match any tag.

See Also:
Constant Field Values

TYPE_TAG

public static final java.lang.String TYPE_TAG
Name of the type tag.

See Also:
Constant Field Values

SCRIPT_DELETED

public static final java.lang.String SCRIPT_DELETED
Tag indicating the script is deleted, but kept to allow it to be revived

See Also:
Constant Field Values
Constructor Detail

BranchingFactory

public BranchingFactory()
Method Detail

parse

public void parse(BaseConfiguration bconfig,
                  org.w3c.dom.Element elem)
           throws java.lang.Exception
Parse a XML element into a configuration object.

Overrides:
parse in class Factories
Parameters:
bconfig - 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.

build

public void build(BaseConfiguration bconfig,
                  org.w3c.dom.Element elem)
           throws java.lang.Exception
Generate a XML element from a configuration object.

Overrides:
build in class Factories
Parameters:
bconfig - 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.

parse

public void parse(BranchingConfig config,
                  org.w3c.dom.Element elem)
           throws java.lang.Exception
Parse a XML Branch element into a configuration object.

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.

build

public void build(BranchingConfig config,
                  org.w3c.dom.Element elem)
           throws java.lang.Exception
Generate a XML Branch Condition element from a configuration object.

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.

build

public void build(BranchCondition config,
                  org.w3c.dom.Element elem)
           throws java.lang.Exception
Generate a XML Branch element from a configuration object.

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.

parse

public void parse(BranchCondition config,
                  org.w3c.dom.Element elem)
           throws java.lang.Exception
Parse a XML Branch Condition element into a configuration object.

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.