IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

com.ibm.btt.base
Class DataMapperConverterFormat

java.lang.Object
  extended by com.ibm.btt.base.FormatElement
      extended by com.ibm.btt.base.KeyedCollectionFormat
          extended by com.ibm.btt.base.RecordFormat
              extended by com.ibm.btt.base.DataMapperFormat
                  extended by com.ibm.btt.base.DataMapperConverterFormat
All Implemented Interfaces:
Cacheable, java.io.Externalizable, java.io.Serializable
Direct Known Subclasses:
DataMapperExpressionConverterFormat, WSMapperConverter

public class DataMapperConverterFormat
extends DataMapperFormat

The DataExternalizer class reads data elements. The definition file must be specified in btt.xml, in the path settings.files.data. The tags must be in settings.tags.data.

See Also:
Serialized Form

Field Summary
protected static int APPEND_FALSE
          The false value for the append attribute.
protected static int APPEND_IGNORE
          The ignore value for the append attribute.
protected static int APPEND_TRUE
          The true value for the append attribute.
static java.lang.String ByReference
          The String byReference
static java.lang.String ConversioType
          The String convType
static java.lang.String From
          The String from
 
Fields inherited from class com.ibm.btt.base.KeyedCollectionFormat
dataElementEmpty, elements
 
Fields inherited from class com.ibm.btt.base.FormatElement
dataElementName, externalizer, name
 
Constructor Summary
DataMapperConverterFormat()
          DataMapperConverterFormat constructor.
DataMapperConverterFormat(java.lang.String aName)
          DataMapperConverterFormat constructor.
 
Method Summary
protected  void deepMapSingleIndexedCollectionElements(DataElement fromDataElement, DataElement toDataElement, java.lang.String converType, boolean byReference, int append)
           
protected  void deepMapSingleKeyedCollectionElements(DataElement fromDataElement, DataElement toDataElement, java.lang.String converType, boolean byReference, int append)
           
 java.lang.Object initializeFrom(Tag aTag)
          Initializes a RecordFormat from the Tag attributes.
 void mapContents(Context inputContext, Context outputContext)
          Maps the contents of a context into another context.
protected  void mapSingleElement(DataElement fromDataElement, DataElement toDataElement, java.lang.String converType, boolean byReference, int append)
          Maps the contexts of one operation into the context of another operation.
protected  void mapSingleElements(DataElement fromDataElement, DataElement toDataElement, java.lang.String converType, boolean byReference, int append)
           
protected  void mapSingleTag(Context inputContext, Context outputContext, java.lang.String fromDataField, java.lang.String toDataField, boolean byReference, java.lang.String converType, int append)
          Process mapping according to desired parameters.
protected  void mapSingleTag(Context inputContext, Context outputContext, Tag element)
          Process mapping described in single tag descriptions.
 
Methods inherited from class com.ibm.btt.base.DataMapperFormat
toStrings
 
Methods inherited from class com.ibm.btt.base.RecordFormat
extract, formatContext, formatKeyedCollection, obtainDataElement, obtainDataElement, toString, unformat, unformat, unformatContext, unformatKeyedCollection
 
Methods inherited from class com.ibm.btt.base.KeyedCollectionFormat
add, addElementAt, addFirst, at, checkIndexes, format, format, getDataElementEmpty, getElements, getEnumeration, reinitialize, removeAll, removeAt, setElements, size, unformat, unformat
 
Methods inherited from class com.ibm.btt.base.FormatElement
exceptionInfo, externalizer, getDataElementName, getExternalizer, getName, getTagName, isCacheable, isConstant, isItConstant, isNull, readExternal, readExternal, readObject, removeExternal, rootDecorated, setDataElementName, setExternalizer, setName, setSize, toTags, writeExternal, writeExternal
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

APPEND_IGNORE

protected static final int APPEND_IGNORE
The ignore value for the append attribute.

See Also:
Constant Field Values

APPEND_TRUE

protected static final int APPEND_TRUE
The true value for the append attribute.

See Also:
Constant Field Values

APPEND_FALSE

protected static final int APPEND_FALSE
The false value for the append attribute.

See Also:
Constant Field Values

From

public static final java.lang.String From
The String from

See Also:
Constant Field Values

ConversioType

public static final java.lang.String ConversioType
The String convType

See Also:
Constant Field Values

ByReference

public static final java.lang.String ByReference
The String byReference

See Also:
Constant Field Values
Constructor Detail

DataMapperConverterFormat

public DataMapperConverterFormat()
DataMapperConverterFormat constructor.


DataMapperConverterFormat

public DataMapperConverterFormat(java.lang.String aName)
                          throws java.io.IOException
DataMapperConverterFormat constructor.

Parameters:
aName - java.lang.String
Throws:
java.io.IOException - - The exception description
Method Detail

initializeFrom

public java.lang.Object initializeFrom(Tag aTag)
                                throws java.io.IOException
Initializes a RecordFormat from the Tag attributes.

Overrides:
initializeFrom in class RecordFormat
Parameters:
aTag - com.ibm.btt.base.Tag
Returns:
java.lang.Object
Throws:
java.io.IOException

mapContents

public void mapContents(Context inputContext,
                        Context outputContext)
                 throws DSEInvalidArgumentException,
                        DSEInvalidClassException,
                        DSEInvalidRequestException
Maps the contents of a context into another context.

Overrides:
mapContents in class DataMapperFormat
Parameters:
inputContext - com.ibm.btt.base.Context
outputContext - com.ibm.btt.base.Context
Throws:
DSEInvalidArgumentException
DSEInvalidClassException
DSEInvalidRequestException

mapSingleTag

protected void mapSingleTag(Context inputContext,
                            Context outputContext,
                            Tag element)
                     throws DSEInvalidArgumentException,
                            DSEInvalidRequestException
Process mapping described in single tag descriptions. Such as <map from="fromField" to="toField"/>.

Parameters:
inputContext - input context
outputContext - output context
element - tag element read from XML snippet
Throws:
DSEInvalidArgumentException
DSEInvalidRequestException

mapSingleTag

protected void mapSingleTag(Context inputContext,
                            Context outputContext,
                            java.lang.String fromDataField,
                            java.lang.String toDataField,
                            boolean byReference,
                            java.lang.String converType,
                            int append)
                     throws DSEInvalidArgumentException,
                            DSEInvalidRequestException
Process mapping according to desired parameters.

Parameters:
inputContext - input context
outputContext - output context
fromDataField - from attribute value
toDataField - to attribute value
byReference - if mapping by reference
converType - convert type
append - append type
Throws:
DSEInvalidArgumentException
DSEInvalidRequestException

mapSingleElements

protected void mapSingleElements(DataElement fromDataElement,
                                 DataElement toDataElement,
                                 java.lang.String converType,
                                 boolean byReference,
                                 int append)
                          throws DSEInvalidArgumentException,
                                 DSEInvalidRequestException
Throws:
DSEInvalidArgumentException
DSEInvalidRequestException

deepMapSingleKeyedCollectionElements

protected void deepMapSingleKeyedCollectionElements(DataElement fromDataElement,
                                                    DataElement toDataElement,
                                                    java.lang.String converType,
                                                    boolean byReference,
                                                    int append)
                                             throws DSEInvalidArgumentException,
                                                    DSEInvalidRequestException
Throws:
DSEInvalidArgumentException
DSEInvalidRequestException

deepMapSingleIndexedCollectionElements

protected void deepMapSingleIndexedCollectionElements(DataElement fromDataElement,
                                                      DataElement toDataElement,
                                                      java.lang.String converType,
                                                      boolean byReference,
                                                      int append)
                                               throws DSEInvalidRequestException,
                                                      DSEInvalidArgumentException
Throws:
DSEInvalidRequestException
DSEInvalidArgumentException

mapSingleElement

protected void mapSingleElement(DataElement fromDataElement,
                                DataElement toDataElement,
                                java.lang.String converType,
                                boolean byReference,
                                int append)
                         throws DSEInvalidArgumentException,
                                DSEInvalidRequestException
Maps the contexts of one operation into the context of another operation.

Parameters:
inputOperation - com.ibm.btt.base.Operation
outputOperation - com.ibm.btt.base.Operation
Throws:
DSEInvalidArgumentException
DSEInvalidRequestException

IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2011