IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

com.ibm.btt.base
Class DataMapperBeansConverterFormat

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
                      extended by com.ibm.btt.base.DataMapperBeansConverterFormat
All Implemented Interfaces:
Cacheable, java.io.Externalizable, java.io.Serializable
Direct Known Subclasses:
WSMapperConverter

@ATTR(value={"isPrimitive#String#IMPLIED","javaClass#String#IMPLIED"})
public class DataMapperBeansConverterFormat
extends DataMapperConverterFormat

See Also:
Serialized Form

Nested Class Summary
 class DataMapperBeansConverterFormat.DummyArray
           
 
Field Summary
static java.lang.String APPEND
           
static java.lang.String ASTERISK
           
static java.lang.String FROM
           
static java.lang.String IS_PRIMITIVE
           
static java.lang.String JAVA_CLASS
           
static java.lang.String TO
           
 
Fields inherited from class com.ibm.btt.base.DataMapperConverterFormat
APPEND_FALSE, APPEND_IGNORE, APPEND_TRUE, ByReference, ConversioType, From, myTag
 
Fields inherited from class com.ibm.btt.base.KeyedCollectionFormat
dataElementEmpty, elements
 
Fields inherited from class com.ibm.btt.base.FormatElement
dataElementName, externalizer, name, xmlSupport
 
Constructor Summary
DataMapperBeansConverterFormat()
           
 
Method Summary
protected  SimpleElementManager getConvertManager()
           
 java.lang.String getJavaClass()
           
 java.lang.String getSubAppend()
           
protected  java.lang.String getSubConversioType()
           
protected  java.lang.String getSubFrom()
           
protected  java.lang.String getSubTo()
           
 java.lang.Object initializeFrom(Tag aTag)
          Initializes an WSMapperConverter object with the aTag attributes.
protected  void initializeFromSubTag(Tag subTag)
           
 boolean isPrimitive()
           
 void mapContents(Context inputContext, Context outputContext)
          Maps the contents of a context into another context.
 java.lang.Object mapContextToObject(Context ctx)
          Transform the data from Context to Object.
 void mapObjectToContext(java.lang.Object obj, Context ctx)
          Transform the data from Object to Context.
protected  void mapSingleTag(Context inputContext, Context outputContext, Tag element)
          Process mapping described in single tag descriptions.
 void setJavaClass(java.lang.String javaClass)
           
 void setPrimitive(boolean isPrimitive)
           
 
Methods inherited from class com.ibm.btt.base.DataMapperConverterFormat
deepMapSingleIndexedCollectionElements, deepMapSingleKeyedCollectionElements, mapSingleElement, mapSingleElements, mapSingleTag
 
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, getAttributeValueForXMLFormat, 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

IS_PRIMITIVE

public static final java.lang.String IS_PRIMITIVE
See Also:
Constant Field Values

JAVA_CLASS

public static final java.lang.String JAVA_CLASS
See Also:
Constant Field Values

FROM

public static final java.lang.String FROM
See Also:
Constant Field Values

TO

public static final java.lang.String TO
See Also:
Constant Field Values

APPEND

public static final java.lang.String APPEND
See Also:
Constant Field Values

ASTERISK

public static final java.lang.String ASTERISK
See Also:
Constant Field Values
Constructor Detail

DataMapperBeansConverterFormat

public DataMapperBeansConverterFormat()
Method Detail

getSubAppend

public java.lang.String getSubAppend()

isPrimitive

public boolean isPrimitive()

setPrimitive

public void setPrimitive(boolean isPrimitive)

getJavaClass

public java.lang.String getJavaClass()

setJavaClass

public void setJavaClass(java.lang.String javaClass)

getSubFrom

protected java.lang.String getSubFrom()

getSubTo

protected java.lang.String getSubTo()

getSubConversioType

protected java.lang.String getSubConversioType()

getConvertManager

protected SimpleElementManager getConvertManager()

initializeFrom

public java.lang.Object initializeFrom(Tag aTag)
                                throws java.io.IOException
Initializes an WSMapperConverter object with the aTag attributes. The tag contains the attributes for the primitive and java class.

Overrides:
initializeFrom in class DataMapperConverterFormat
Parameters:
aTag - A Tag that contains the name and attributes of the object to be created
Returns:
Object - An instance of WSMapperConverter
Throws:
java.io.IOException
DSEException

initializeFromSubTag

protected void initializeFromSubTag(Tag subTag)

mapContextToObject

public java.lang.Object mapContextToObject(Context ctx)
                                    throws DSEInvalidRequestException,
                                           DSEInvalidArgumentException,
                                           DSEInvalidClassException
Transform the data from Context to Object.

The objects are stored in the context, and the format defines the rules of how to transform the data from context to object.

Parameters:
ctx - The context from where the data is stored
Returns:
The Object instance which contains the value mapped from context
Throws:
DSEInvalidRequestException
DSEInvalidArgumentException
DSEInvalidClassException

mapObjectToContext

public void mapObjectToContext(java.lang.Object obj,
                               Context ctx)
                        throws DSEInvalidRequestException,
                               DSEInvalidArgumentException,
                               DSEInvalidClassException
Transform the data from Object to Context.

The objects are stored in the object, and the format defines the rules of how to transform the data from object to context.

Parameters:
obj - The Object instance which contains the value received from web service
ctx - The context from where the data will be stored
Throws:
DSEInvalidRequestException
DSEInvalidArgumentException
DSEInvalidClassException

mapContents

public void mapContents(Context inputContext,
                        Context outputContext)
                 throws DSEInvalidArgumentException,
                        DSEInvalidClassException,
                        DSEInvalidRequestException
Description copied from class: DataMapperConverterFormat
Maps the contents of a context into another context.

Overrides:
mapContents in class DataMapperConverterFormat
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
Description copied from class: DataMapperConverterFormat
Process mapping described in single tag descriptions. Such as <map from="fromField" to="toField"/>.

Overrides:
mapSingleTag in class DataMapperConverterFormat
Parameters:
inputContext - input context
outputContext - output context
element - tag element read from XML snippet
Throws:
DSEInvalidArgumentException
DSEInvalidRequestException

IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2011