IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

com.ibm.btt.base
Class FieldFormat

java.lang.Object
  extended by com.ibm.btt.base.FormatElement
      extended by com.ibm.btt.base.FieldFormat
All Implemented Interfaces:
Cacheable, java.io.Externalizable, java.io.Serializable
Direct Known Subclasses:
BigDecimalFormat, DateFormat, FloatFormat, IntegerFormat, NumericStringFormat, PackedFormat, StringFormat, TimeFormat

public abstract class FieldFormat
extends FormatElement

This is the abstract parent class for format elements related to simple data fields.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.ibm.btt.base.FormatElement
dataElementName, externalizer, name
 
Constructor Summary
FieldFormat()
           
 
Method Summary
 java.lang.String format(Context aContext)
          Formats a data field using the supplied context.
 java.lang.String format(DataElement aDataElement)
          Verifies that the passed DataElement is a DataField instance and then calls the formatField() method.
abstract  java.lang.String formatField(DataField aDataElement)
          FormatField abstract method.
 Vector toStrings()
          Returns a visual representation of this format element.
 int unformat(int ndxFrom, int ndxTo, java.lang.String str, DataElement aDataElement)
          The new unformat methods added to the FormatElement to minimize the instances created during the unfomat process that later will be collected by the garbage collector (GC).
 DataElement unformat(java.lang.String aString, Context aContext)
          Unformats using the supplied context.
 DataElement unformat(java.lang.String aString, DataElement aDataElement)
          Verifies that the passed DataElement is a DataField instance and then calls the unformatField() method.
abstract  DataField unformatField(java.lang.String aString, DataField aDataField)
          UnformatField abstract method.
 
Methods inherited from class com.ibm.btt.base.FormatElement
checkIndexes, exceptionInfo, externalizer, extract, getDataElementName, getExternalizer, getName, getTagName, initializeFrom, isCacheable, isConstant, isItConstant, isNull, readExternal, readExternal, readObject, reinitialize, removeExternal, rootDecorated, setDataElementName, setExternalizer, setName, setSize, toString, toTags, unformat, writeExternal, writeExternal
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

FieldFormat

public FieldFormat()
Method Detail

format

public java.lang.String format(Context aContext)
                        throws DSEInvalidClassException,
                               DSEInvalidRequestException,
                               DSEInvalidArgumentException
Formats a data field using the supplied context.

Overrides:
format in class FormatElement
Parameters:
aContext - com.ibm.btt.base.Context
Returns:
java.lang.String
Throws:
DSEInvalidClassException
DSEInvalidRequestException
DSEInvalidArgumentException

format

public java.lang.String format(DataElement aDataElement)
                        throws DSEInvalidArgumentException,
                               DSEInvalidClassException
Verifies that the passed DataElement is a DataField instance and then calls the formatField() method.

Specified by:
format in class FormatElement
Parameters:
aDataElement - DataElement
Returns:
String
Throws:
DSEInvalidArgumentException
DSEInvalidClassException

formatField

public abstract java.lang.String formatField(DataField aDataElement)
                                      throws DSEInvalidArgumentException,
                                             DSEInvalidClassException
FormatField abstract method.

Throws:
DSEInvalidArgumentException
DSEInvalidClassException

toStrings

public Vector toStrings()
Returns a visual representation of this format element.

Overrides:
toStrings in class FormatElement
Returns:
com.ibm.btt.base.Vector

unformat

public DataElement unformat(java.lang.String aString,
                            Context aContext)
                     throws DSEInvalidRequestException,
                            DSEInvalidArgumentException
Unformats using the supplied context.

Overrides:
unformat in class FormatElement
Parameters:
aString - java.lang.String
aContext - com.ibm.btt.base.Context
Returns:
com.ibm.btt.base.DataElement
Throws:
DSEInvalidRequestException
DSEInvalidArgumentException

unformat

public DataElement unformat(java.lang.String aString,
                            DataElement aDataElement)
                     throws DSEInvalidArgumentException
Verifies that the passed DataElement is a DataField instance and then calls the unformatField() method.

Specified by:
unformat in class FormatElement
Throws:
DSEInvalidArgumentException

unformatField

public abstract DataField unformatField(java.lang.String aString,
                                        DataField aDataField)
                                 throws DSEInvalidArgumentException
UnformatField abstract method.

Throws:
DSEInvalidArgumentException

unformat

public int unformat(int ndxFrom,
                    int ndxTo,
                    java.lang.String str,
                    DataElement aDataElement)
             throws DSEInvalidRequestException,
                    DSEInvalidArgumentException
The new unformat methods added to the FormatElement to minimize the instances created during the unfomat process that later will be collected by the garbage collector (GC).

Overrides:
unformat in class FormatElement
Parameters:
ndxFrom - is the initial index
ndxTo - one is the final index
Throws:
DSEInvalidRequestException
DSEInvalidArgumentException

IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2009