com.ibm.dse.base
Class FieldFormat

java.lang.Object
  |
  +--com.ibm.dse.base.FormatElement
        |
        +--com.ibm.dse.base.FieldFormat
Direct Known Subclasses:
BigDecimalFormat, DateFormat, FloatFormat, IntegerFormat, NumericStringFormat, PackedFormat, StringFormat, TimeFormat, VectorFormat

public abstract class FieldFormat
extends FormatElement

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

See Also:
Serialized Form

Fields inherited from class com.ibm.dse.base.FormatElement
dataElementName, 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.
 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.dse.base.FormatElement
exceptionInfo, externalizer, extract, format, getDataElementName, getExternalizer, getName, getTagName, initializeFrom, isCacheable, isConstant, readExternal, readExternal, readObject, reinitialize, removeExternal, rootDecorated, setDataElementName, setExternalizer, setName, setSize, toString, toStrings, 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.dse.base.Context
Returns:
java.lang.String

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.
Overrides:
format in class FormatElement
Tags copied from class: FormatElement
Parameters:
aDataElement - DataElement
Returns:
String

formatField

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

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.dse.base.Context
Returns:
com.ibm.dse.base.DataElement

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.
Overrides:
unformat in class FormatElement

unformatField

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