com.ibm.dse.appl.forwarding.base
Class VectorFormat

java.lang.Object
  |
  +--com.ibm.dse.base.FormatElement
        |
        +--com.ibm.dse.base.FieldFormat
              |
              +--com.ibm.dse.appl.forwarding.base.VectorFormat

public class VectorFormat
extends FieldFormat

Vector class for providing methods to maintain and manipulate the formats required for forwarding.

See Also:
Serialized Form

Fields inherited from class com.ibm.dse.base.FormatElement
dataElementName, name
 
Constructor Summary
VectorFormat()
           
 
Method Summary
 java.lang.String formatField(DataField aDataElement)
          Format a data field with a specified separator and return a string.
 java.lang.String getSeparator()
          Retrieves the separator.
 java.lang.Object initializeFrom(Tag aTag)
          Retrieves the parameters from the external files and store in the object.
 void setSeparator(java.lang.String newSeparator)
          Set the separator value retrieved from the external file to the object.
 java.lang.String toString()
          Returns a visible representation of this format.
 DataField unformatField(java.lang.String aString, DataField aDataField)
          Take the string and set the values back to the DataField.
 
Methods inherited from class com.ibm.dse.base.FieldFormat
format, format, unformat, unformat
 
Methods inherited from class com.ibm.dse.base.FormatElement
exceptionInfo, externalizer, extract, format, getDataElementName, getExternalizer, getName, getTagName, isCacheable, isConstant, readExternal, readExternal, readObject, reinitialize, removeExternal, rootDecorated, setDataElementName, setExternalizer, setName, setSize, toStrings, toTags, unformat, writeExternal, writeExternal
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

VectorFormat

public VectorFormat()
Method Detail

formatField

public java.lang.String formatField(DataField aDataElement)
                             throws DSEInvalidClassException,
                                    DSEInvalidArgumentException
Format a data field with a specified separator and return a string.
Overrides:
formatField in class FieldFormat
Parameters:
aDataElement - DataField, a DataField
Returns:
java.lang.String, a String representation of the Vector
Throws:
DSEInvalidClassException -  
DSEInvalidArgumentException -  

getSeparator

public java.lang.String getSeparator()
Retrieves the separator.
Returns:
java.lang.String, a separator

initializeFrom

public java.lang.Object initializeFrom(Tag aTag)
                                throws java.io.IOException,
                                       DSEException
Retrieves the parameters from the external files and store in the object.
Overrides:
initializeFrom in class FormatElement
Parameters:
aTag - com.ibm.dse.base.Tag, configuration parameter
Returns:
java.lang.Object, a FormatExternalizer
Throws:
java.io.IOException, - throws when problem occurs in accessing XML files
DSEException -  

setSeparator

public void setSeparator(java.lang.String newSeparator)
Set the separator value retrieved from the external file to the object.
Parameters:
newSeparator - java.lang.String, the new separator

toString

public java.lang.String toString()
Returns a visible representation of this format.
Overrides:
toString in class FormatElement
Returns:
com.ibm.dse.base.Vector

unformatField

public DataField unformatField(java.lang.String aString,
                               DataField aDataField)
                        throws DSEInvalidArgumentException
Take the string and set the values back to the DataField.
Overrides:
unformatField in class FieldFormat
Parameters:
aString - java.lang.String, a String representation of the Vector
aDataField - com.ibm.dse.base.DataField, a given DataField
Returns:
com.ibm.dse.base.DataField, a DataField contains a new BigDecimal