IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

com.ibm.btt.base.types
Interface Conversion

All Known Implementing Classes:
AbstractConverter, BaseConverter, BooleanConverter, ByteArrayConverter, CurrencyConverter, DateConverter, DateConverter, DurationConverter, FloatConverter, ICollConverter, IntegerConverter, KCollConverter, NumberConverter, NumericStringConverter, StringConverter, StringConverter, TimeConverter, XMLGregorianCalendarConverter

@ATTR(value={"convTypes#String#REQUIRED","implClass#String#REQUIRED"})
public interface Conversion


Method Summary
 java.lang.Object convertFrom(java.lang.Object obj, PropertyDescription pd)
          Converts an input object into a proper object handled by the invoker, which can then set the output object into the data element.
 java.lang.Object convertFrom(java.lang.Object obj, PropertyDescription pd, boolean byReference)
          Converts an input object into a proper object handled by the invoker, which can then set the output object into the data element.
 java.lang.Object convertFrom(java.lang.Object obj, java.lang.String convType, PropertyDescription pd, boolean byReference)
          Converts an input object into a proper object handled by the invoker, which can then set the output object into the data element.
 java.lang.Object convertFrom(java.lang.Object obj, java.lang.String convType, PropertyDescription pd, boolean byReference, java.util.Locale locale)
          Converts an input object into a proper object handled by the invoker, which can then set the output object into the data element.
 java.lang.Object convertFrom(java.lang.Object obj, java.lang.String convType, PropertyDescription pd, boolean byReference, java.util.Locale locale, Hashtable parameters)
          Converts an input object into a proper object handled by the invoker, which can then set the output object into the data element.
 java.lang.Object convertTo(java.lang.Object obj, PropertyDescription pd)
          Converts an input object into a proper object handled by the invoker.
 java.lang.Object convertTo(java.lang.Object obj, PropertyDescription pd, boolean byReference)
          Converts an input object into a proper object handled by the invoker.
 java.lang.Object convertTo(java.lang.Object obj, java.lang.String convType, PropertyDescription pd, boolean byReference)
          Converts an input object into a proper object handled by the invoker.
 java.lang.Object convertTo(java.lang.Object obj, java.lang.String convType, PropertyDescription pd, boolean byReference, java.util.Locale locale)
          Converts an input object into a proper object handled by the invoker.
 java.lang.Object convertTo(java.lang.Object obj, java.lang.String convType, PropertyDescription pd, boolean byReference, java.util.Locale locale, Hashtable parameters)
          Converts an input object into a proper object handled by the invoker.
 void formatToWriter(java.lang.Object value, java.lang.String conversionType, java.io.Writer writer, PropertyDescription descriptor)
          Formats the object using the specified conversion type and writer pssed as arguments.
 void formatToWriter(java.lang.Object value, java.lang.String conversionType, java.io.Writer writer, PropertyDescription descriptor, java.util.Locale locale)
          Formats the object using the specified conversion type, locale, and writer passed as arguments.
 void formatToWriter(java.lang.Object value, java.lang.String conversionType, java.io.Writer writer, PropertyDescription descriptor, java.util.Locale locale, Hashtable parameters)
          Formats the object using the specified conversion type, locale, and writer passed as arguments.
 java.lang.String[] getSupportedConversionTypes()
          Returns an array of conversion types supported by this Converter.
 boolean supportsConversionType(java.lang.String conversionType)
          Returns a flag indicating whether the conversion type passed as argument is supported.
 java.lang.Object unformatFromReader(java.io.Reader reader, java.lang.String conversionType, PropertyDescription descriptor)
          Uses the reader passed to construct an Object of the correct Type using the appropriate conversion type.
 java.lang.Object unformatFromReader(java.io.Reader reader, java.lang.String conversionType, PropertyDescription descriptor, java.util.Locale locale)
          Uses the reader passed to construct an Object of the correct Type using the appropriate conversion type and the given locale.
 java.lang.Object unformatFromReader(java.io.Reader reader, java.lang.String conversionType, PropertyDescription descriptor, java.util.Locale locale, Hashtable parameters)
          Uses the reader passed to construct an Object of the correct Type using the appropriate conversion type and the given locale.
 void validateParams(PropertyDescription pd)
          Validates the parameters externaly defined for this converter.
 

Method Detail

convertFrom

java.lang.Object convertFrom(java.lang.Object obj,
                             PropertyDescription pd)
                             throws DSETypeException
Converts an input object into a proper object handled by the invoker, which can then set the output object into the data element.

Parameters:
obj - java.lang.Object
pd - com.ibm.btt.base.types.PropertyDescription
Returns:
java.lang.Object
Throws:
DSETypeException

convertFrom

java.lang.Object convertFrom(java.lang.Object obj,
                             PropertyDescription pd,
                             boolean byReference)
                             throws DSETypeException
Converts an input object into a proper object handled by the invoker, which can then set the output object into the data element. If byReference is true, the conversion, if accepted by the converter, is performed by reference.

Parameters:
obj - java.lang.Object
pd - com.ibm.btt.base.types.PropertyDescription
byReference - boolean
Returns:
java.lang.Object
Throws:
DSETypeException

convertFrom

java.lang.Object convertFrom(java.lang.Object obj,
                             java.lang.String convType,
                             PropertyDescription pd,
                             boolean byReference)
                             throws DSETypeException
Converts an input object into a proper object handled by the invoker, which can then set the output object into the data element. If byReference is true, the conversion, if accepted by the converter, is performed by reference.

Parameters:
obj - java.lang.Object
convType - java.lang.String
pd - com.ibm.btt.base.types.PropertyDescription
byReference - boolean
Returns:
java.lang.Object
Throws:
DSETypeException

convertFrom

java.lang.Object convertFrom(java.lang.Object obj,
                             java.lang.String convType,
                             PropertyDescription pd,
                             boolean byReference,
                             java.util.Locale locale)
                             throws DSETypeException
Converts an input object into a proper object handled by the invoker, which can then set the output object into the data element. If byReference is true, the conversion, if accepted by the converter, is performed by reference.

Parameters:
obj - java.lang.Object
convType - java.lang.String
pd - com.ibm.btt.base.types.PropertyDescription
byReference - boolean
locale - Locale
Returns:
java.lang.Object
Throws:
DSETypeException

convertFrom

java.lang.Object convertFrom(java.lang.Object obj,
                             java.lang.String convType,
                             PropertyDescription pd,
                             boolean byReference,
                             java.util.Locale locale,
                             Hashtable parameters)
                             throws DSETypeException
Converts an input object into a proper object handled by the invoker, which can then set the output object into the data element. If byReference is true, the conversion, if accepted by the converter, is performed by reference.

Parameters:
obj - java.lang.Object
convType - java.lang.String
pd - com.ibm.btt.base.types.PropertyDescription
byReference - boolean
locale - Locale
parameters - com.ibm.btt.base.Hashtable
Returns:
java.lang.Object
Throws:
DSETypeException

convertTo

java.lang.Object convertTo(java.lang.Object obj,
                           PropertyDescription pd)
                           throws DSETypeException
Converts an input object into a proper object handled by the invoker. The output object can be used by the invoker for different purposes and its type is converter dependent.

Parameters:
obj - java.lang.Object
pd - com.ibm.btt.base.types.PropertyDescription
Returns:
java.lang.Object
Throws:
DSETypeException

convertTo

java.lang.Object convertTo(java.lang.Object obj,
                           PropertyDescription pd,
                           boolean byReference)
                           throws DSETypeException
Converts an input object into a proper object handled by the invoker. The output object can be used by the invoker for different purposes and its type is converter dependent. If byReference is true, the conversion, if accepted by the converter, is performed by reference.

Parameters:
obj - java.lang.Object
pd - com.ibm.btt.base.types.PropertyDescription
byReference - boolean
Returns:
java.lang.Object
Throws:
DSETypeException

convertTo

java.lang.Object convertTo(java.lang.Object obj,
                           java.lang.String convType,
                           PropertyDescription pd,
                           boolean byReference)
                           throws DSETypeException
Converts an input object into a proper object handled by the invoker. The output object can be used by the invoker for different purposes and its type is converter dependent. If byReference is true, the conversion, if accepted by the converter, is performed by reference.

Parameters:
obj - java.lang.Object
convType - java.lang.String
pd - com.ibm.btt.base.types.PropertyDescription
byReference - boolean
Returns:
java.lang.Object
Throws:
DSETypeException

convertTo

java.lang.Object convertTo(java.lang.Object obj,
                           java.lang.String convType,
                           PropertyDescription pd,
                           boolean byReference,
                           java.util.Locale locale)
                           throws DSETypeException
Converts an input object into a proper object handled by the invoker. The output object can be used by the invoker for different purposes and its type is converter dependent. If byReference is true, the conversion, if accepted by the converter, is performed by reference.

Parameters:
obj - java.lang.Object
convType - java.lang.String
pd - com.ibm.btt.base.types.PropertyDescription
byReference - boolean
locale - Locale
Returns:
java.lang.Object
Throws:
DSETypeException

convertTo

java.lang.Object convertTo(java.lang.Object obj,
                           java.lang.String convType,
                           PropertyDescription pd,
                           boolean byReference,
                           java.util.Locale locale,
                           Hashtable parameters)
                           throws DSETypeException
Converts an input object into a proper object handled by the invoker. The output object can be used by the invoker for different purposes and its type is converter dependent. If byReference is true, the conversion, if accepted by the converter, is performed by reference.

Parameters:
obj - java.lang.Object
convType - java.lang.String
pd - com.ibm.btt.base.types.PropertyDescription
byReference - boolean
locale - Locale
parameters - com.ibm.btt.base.Hashtable
Returns:
java.lang.Object
Throws:
DSETypeException

formatToWriter

void formatToWriter(java.lang.Object value,
                    java.lang.String conversionType,
                    java.io.Writer writer,
                    PropertyDescription descriptor)
                    throws DSETypeException
Formats the object using the specified conversion type and writer pssed as arguments. Parameters required by the specific type converter may be taken from the owner descriptor by using the descriptor passed as an argument.

Parameters:
value - Object
conversionType - String
writer - Writer
descriptor - PropertyDescription
Throws:
DSETypeException

formatToWriter

void formatToWriter(java.lang.Object value,
                    java.lang.String conversionType,
                    java.io.Writer writer,
                    PropertyDescription descriptor,
                    java.util.Locale locale)
                    throws DSETypeException
Formats the object using the specified conversion type, locale, and writer passed as arguments. Parameters required by the specific type converter may be taken from the owner descriptor by using the descriptor passed as argument.

Parameters:
value - Object
conversionType - String
writer - Writer
descriptor - PropertyDescription
locale - Locale
Throws:
DSETypeException

formatToWriter

void formatToWriter(java.lang.Object value,
                    java.lang.String conversionType,
                    java.io.Writer writer,
                    PropertyDescription descriptor,
                    java.util.Locale locale,
                    Hashtable parameters)
                    throws DSETypeException
Formats the object using the specified conversion type, locale, and writer passed as arguments. Parameters required by the specific type converter may be taken from the owner descriptor by using the descriptor passed as an argument.

Parameters:
value - Object
conversionType - String
writer - Writer
descriptor - PropertyDescription
locale - Locale
parameters - com.ibm.btt.base.Hashtable
Throws:
DSETypeException

getSupportedConversionTypes

java.lang.String[] getSupportedConversionTypes()
Returns an array of conversion types supported by this Converter.

Returns:
String[]

supportsConversionType

boolean supportsConversionType(java.lang.String conversionType)
Returns a flag indicating whether the conversion type passed as argument is supported.

Parameters:
conversionType - String
Returns:
boolean - True if the conversion type is supported

unformatFromReader

java.lang.Object unformatFromReader(java.io.Reader reader,
                                    java.lang.String conversionType,
                                    PropertyDescription descriptor)
                                    throws DSETypeException
Uses the reader passed to construct an Object of the correct Type using the appropriate conversion type. Parameters required by the specific type converter may be taken from the owner descriptor by using the descriptor passed as an argument.

Parameters:
reader - Reader
conversionType - String
descriptor - PropertyDescription
Returns:
Object
Throws:
DSETypeException - - Unformatting is unsuccessful

unformatFromReader

java.lang.Object unformatFromReader(java.io.Reader reader,
                                    java.lang.String conversionType,
                                    PropertyDescription descriptor,
                                    java.util.Locale locale)
                                    throws DSETypeException
Uses the reader passed to construct an Object of the correct Type using the appropriate conversion type and the given locale. Parameters required by the specific type converter may be taken from the owner descriptor by using the descriptor passed as an argument.

Parameters:
reader - Reader
conversionType - String
descriptor - PropertyDescription
locale - Locale
Returns:
Object
Throws:
DSETypeException - - Unformatting is unsuccessful

unformatFromReader

java.lang.Object unformatFromReader(java.io.Reader reader,
                                    java.lang.String conversionType,
                                    PropertyDescription descriptor,
                                    java.util.Locale locale,
                                    Hashtable parameters)
                                    throws DSETypeException
Uses the reader passed to construct an Object of the correct Type using the appropriate conversion type and the given locale. Parameters required by the specific type converter may be taken from the Hastable passed as an argument.

Parameters:
reader - Reader
conversionType - String
descriptor - PropertyDescription
locale - Locale
parameters - com.ibm.btt.base.Hashtable
Returns:
Object
Throws:
DSETypeException - - Unformatting is unsuccessful

validateParams

void validateParams(PropertyDescription pd)
                    throws DSETypeException
Validates the parameters externaly defined for this converter.

Parameters:
pd - com.ibm.btt.base.types.PropertyDescription
Throws:
DSETypeException - - If parameter validation fails

IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2011