IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

com.ibm.btt.base.types.ext
Class IntegerConverter

java.lang.Object
  extended by com.ibm.btt.base.types.AbstractConverter
      extended by com.ibm.btt.base.types.ext.IntegerConverter
All Implemented Interfaces:
Conversion, TypeConstants, java.io.Externalizable, java.io.Serializable

public class IntegerConverter
extends AbstractConverter

This is the converter for business objects of the Integer or Long type. The size of its representation can be set from 1 to 8. The byteOrdering attribute determines whether the instance has big-endian (host) or little-endian (PC) byte ordering. The sign attribute determines whether the instance works with or without a sign.

See Also:
Serialized Form

Field Summary
protected  boolean binaryConversion
           
 
Fields inherited from class com.ibm.btt.base.types.AbstractConverter
keyValuePairs
 
Fields inherited from interface com.ibm.btt.base.types.TypeConstants
amended, CONV_TYPE_DEFAULT, CONV_TYPE_HOST, CONV_TYPE_OUTPUT, CONV_TYPE_SER, CONV_TYPE_XML, disabled, hidden, isAmended, isDisabled, isHidden, isMandatory, isOmitted, isReadOnly, mandatory, omitted, readOnly, TYPE_DEFAULT, TYPE_REGISTRY_INIT_SIZE
 
Constructor Summary
IntegerConverter()
          This constructor creates an IntegerConverter object.
IntegerConverter(java.lang.String[] supportedConversionTypes, java.util.Hashtable keyValuePairs)
          Creates an IntegerConverter object.
 
Method Summary
protected  void formatToWriter(long value, java.io.Writer writer, int aByteOrdering, int aSize)
           
 void formatToWriterForType(java.lang.Object value, java.lang.String conversionType, java.io.Writer writer, PropertyDescription descriptor, Hashtable parameters)
          Formats the Object using the specified conversion type and the writer passed as arguments.
 void formatToWriterForType(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.
 int getByteOrdering()
          Returns the value of the byteOrdering attribute.
 boolean getSign()
          Returns the value of the sign attribute.
 int getSize()
          Returns the value of the size attribute.
protected  long parse(java.lang.String aString, int aByteOrdering, int aSize, boolean aSign)
          Converts a String to a char[] and then converts the char[] to a Java long.
protected  java.lang.Object unformat(java.lang.String integerAsString, java.lang.String convType, PropertyDescription descriptor, java.util.Locale locale)
          Converts a String representing an Integer into another Integer.
protected  java.lang.Object unformat(java.lang.String integerAsString, java.lang.String convType, PropertyDescription descriptor, java.util.Locale locale, Hashtable parameters)
          Converts a String representing an Integer into another Integer.
 java.lang.Object unformatFromReaderForType(java.io.Reader reader, java.lang.String conversionType, PropertyDescription descriptor, Hashtable parameters)
          Converts the stream into a Byte, Short, Integer, or Long (depending on the size attribute) using the appropriate conversion Type.
 java.lang.Object unformatFromReaderForType(java.io.Reader reader, java.lang.String conversionType, PropertyDescription descriptor, java.util.Locale locale, Hashtable parameters)
          Constructs an Object of the correct type using the appropriate conversion type and locale.
 void validateParams(PropertyDescription pd)
          Validates the parameters externally defined for this converter.
 
Methods inherited from class com.ibm.btt.base.types.AbstractConverter
convertFrom, convertFrom, convertFrom, convertFrom, convertFrom, convertTo, convertTo, convertTo, convertTo, convertTo, formatToWriter, formatToWriter, formatToWriter, formatToWriterForType, formatToWriterForType, getParameters, getSupportedConversionTypes, readExternal, supportsConversionType, unformatFromReader, unformatFromReader, unformatFromReader, unformatFromReader, unformatFromReaderForType, unformatFromReaderForType, writeExternal
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

binaryConversion

protected boolean binaryConversion
Constructor Detail

IntegerConverter

public IntegerConverter()
                 throws DSETypeException
This constructor creates an IntegerConverter object.

Throws:
DSETypeException - - If the supportedConversionTypes parameter passed to the superclass is null or empty

IntegerConverter

public IntegerConverter(java.lang.String[] supportedConversionTypes,
                        java.util.Hashtable keyValuePairs)
                 throws DSETypeException
Creates an IntegerConverter object.

Parameters:
supportedConversionTypes - java.lang.String[]
keyValuePairs - java.util.Hashtable
Throws:
DSETypeException - - If conversion types passed to the superclass is null or empty
Method Detail

formatToWriter

protected void formatToWriter(long value,
                              java.io.Writer writer,
                              int aByteOrdering,
                              int aSize)
                       throws java.io.IOException,
                              DSETypeException
Throws:
java.io.IOException
DSETypeException

formatToWriterForType

public void formatToWriterForType(java.lang.Object value,
                                  java.lang.String conversionType,
                                  java.io.Writer writer,
                                  PropertyDescription descriptor,
                                  Hashtable parameters)
                           throws java.io.IOException,
                                  DSETypeException
Formats the Object using the specified conversion type and the writer passed as arguments. This method first tries to get the parameters required for the conversion from the Hashtable passed as an argument. If it does not find the parameters there, the method then tries the descriptor passed as an argument.

Overrides:
formatToWriterForType in class AbstractConverter
Parameters:
value - Object
conversionType - String
writer - Writer
descriptor - PropertyDescription
parameters - com.ibm.btt.base.Hashtable
Throws:
java.io.IOException - - If an I/O error occurs
DSETypeException - - If formatting is unsuccessful

formatToWriterForType

public void formatToWriterForType(java.lang.Object value,
                                  java.lang.String conversionType,
                                  java.io.Writer writer,
                                  PropertyDescription descriptor,
                                  java.util.Locale locale,
                                  Hashtable parameters)
                           throws java.io.IOException,
                                  DSETypeException
Formats the Object using the specified conversion type, locale, and writer passed as arguments. This method first tries to get the parameters required for the conversion from the Hashtable passed as an argument. If it does not find the parameters there, the method then tries the descriptor passed as an argument.

Overrides:
formatToWriterForType in class AbstractConverter
Parameters:
value - Object
conversionType - String
writer - Writer
descriptor - PropertyDescriptor
locale - Locale
parameters - com.ibm.btt.base.Hashtable
Throws:
java.io.IOException - - If an I/O error occurred
DSETypeException - - If unformatting is unsuccessful

getByteOrdering

public int getByteOrdering()
Returns the value of the byteOrdering attribute.

Returns:
int

getSign

public boolean getSign()
Returns the value of the sign attribute.

Returns:
boolean

getSize

public int getSize()
Returns the value of the size attribute.

Returns:
int

parse

protected long parse(java.lang.String aString,
                     int aByteOrdering,
                     int aSize,
                     boolean aSign)
Converts a String to a char[] and then converts the char[] to a Java long.

Parameters:
aString - java.lang.String
Returns:
long

unformat

protected java.lang.Object unformat(java.lang.String integerAsString,
                                    java.lang.String convType,
                                    PropertyDescription descriptor,
                                    java.util.Locale locale)
                             throws DSETypeException
Converts a String representing an Integer into another Integer.

Overrides:
unformat in class AbstractConverter
Returns:
java.lang.Object
Throws:
DSETypeException

unformat

protected java.lang.Object unformat(java.lang.String integerAsString,
                                    java.lang.String convType,
                                    PropertyDescription descriptor,
                                    java.util.Locale locale,
                                    Hashtable parameters)
                             throws DSETypeException
Converts a String representing an Integer into another Integer.

Overrides:
unformat in class AbstractConverter
Returns:
java.lang.Object
Throws:
DSETypeException

unformatFromReaderForType

public java.lang.Object unformatFromReaderForType(java.io.Reader reader,
                                                  java.lang.String conversionType,
                                                  PropertyDescription descriptor,
                                                  Hashtable parameters)
                                           throws java.io.IOException,
                                                  DSETypeException
Converts the stream into a Byte, Short, Integer, or Long (depending on the size attribute) using the appropriate conversion Type. This method first tries to get the parameters required for the conversion from the Hashtable passed as an argument. If it does not find the parameters there, the method then tries the descriptor passed as an argument.

Overrides:
unformatFromReaderForType in class AbstractConverter
Parameters:
reader - Reader
conversionType - String
descriptor - PropertyDescriptor
parameters - com.ibm.btt.base.Hashtable
Returns:
Object
Throws:
java.io.IOException - - If an I/O error occurred
DSETypeException - - If unformatting is unsuccessful

unformatFromReaderForType

public java.lang.Object unformatFromReaderForType(java.io.Reader reader,
                                                  java.lang.String conversionType,
                                                  PropertyDescription descriptor,
                                                  java.util.Locale locale,
                                                  Hashtable parameters)
                                           throws java.io.IOException,
                                                  DSETypeException
Constructs an Object of the correct type using the appropriate conversion type and locale. This method first tries to get the parameters required for the conversion from the Hashtable passed as an argument. If it does not find the parameters there, the method then tries the descriptor passed as an argument.

Overrides:
unformatFromReaderForType in class AbstractConverter
Parameters:
reader - Reader
conversionType - String
descriptor - PropertyDescription
locale - Locale
parameters - com.ibm.btt.base.Hashtable
Throws:
java.io.IOException - - If an I/O error occurred
DSETypeException - - If unformatting is unsuccessful

validateParams

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

Specified by:
validateParams in interface Conversion
Overrides:
validateParams in class AbstractConverter
Parameters:
pd - com.ibm.btt.base.types.PropertyDescription
Throws:
DSETypeException - - If the parameter validation fails

IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2009