IBM Bank Transformation Toolkit Javadoc

com.ibm.btt.format.impl
Class BinaryIntegerStringFormat

java.lang.Object
  extended by com.ibm.btt.format.AbstractFormatElement
      extended by com.ibm.btt.format.FieldFormat
          extended by com.ibm.btt.format.impl.BinaryIntegerStringFormat
All Implemented Interfaces:
FormatElement, Constant

public class BinaryIntegerStringFormat
extends FieldFormat
implements Constant


Field Summary
 
Fields inherited from class com.ibm.btt.format.AbstractFormatElement
dataName, tagName, TOSTRINGS_MARGIN
 
Fields inherited from interface com.ibm.btt.format.impl.Constant
CODE_PAGE
 
Constructor Summary
BinaryIntegerStringFormat()
           
 
Method Summary
protected  java.util.Map<java.lang.String,java.lang.String> attributes()
          Generic attributes method.
 Message[] extract(Message message)
          Extracts (strips) the subMessage corresponding to the FormatElement from the input Message and returns it and the remaining Message as the elements of an array.
 Message format(ReadAdapter dataAdapter)
          This method is attended to be called by client code of FormatElement
 java.lang.String getByteOrdering()
           
 char getPadChar()
           
 boolean getSignRule()
           
 int getSize()
           
 int getUnformattedSize()
           
 long parseToLong(java.lang.String aString)
           
 void setByteOrdering(java.lang.String byteOrdering)
           
 void setPadChar(java.lang.String padChar)
           
 void setSignRule(java.lang.String signed)
           
 void setSize(java.lang.String size)
           
 void setUnformattedSize(java.lang.String unformattedSize)
           
 void unformat(Message message, WriteAdapter dataAdapter)
          This method is attended to be called by client code of FormatElement
 
Methods inherited from class com.ibm.btt.format.FieldFormat
isContainer
 
Methods inherited from class com.ibm.btt.format.AbstractFormatElement
getDataName, rootDecorated, setDataName, toString, toStrings
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.ibm.btt.format.FormatElement
getDataName, rootDecorated, toStrings
 

Constructor Detail

BinaryIntegerStringFormat

public BinaryIntegerStringFormat()
Method Detail

getByteOrdering

public java.lang.String getByteOrdering()

setByteOrdering

public void setByteOrdering(java.lang.String byteOrdering)

getSize

public int getSize()

setSize

public void setSize(java.lang.String size)

getSignRule

public boolean getSignRule()

setSignRule

public void setSignRule(java.lang.String signed)

getPadChar

public char getPadChar()

setPadChar

public void setPadChar(java.lang.String padChar)

extract

public Message[] extract(Message message)
                  throws ExtractException
Description copied from interface: FormatElement
Extracts (strips) the subMessage corresponding to the FormatElement from the input Message and returns it and the remaining Message as the elements of an array.
The returned array of Message should always contain two elements.

Take Message 1FCD2639FE for example. The returned array of Message may be {1FCD, 2639FE}, the first element 1FCD is the Message required by this FormatElement, while the second element 2639FE is the remaining Message.

This method is not attended to be called by client code of FormatElement
This method is called by the unformat() method of the composite formats such as com.ibm.btt.format.impl.RecordFormat and com.ibm.btt.format.impl.IndexedFormat.

Specified by:
extract in interface FormatElement
Overrides:
extract in class AbstractFormatElement
Returns:
Throws:
ExtractException

format

public Message format(ReadAdapter dataAdapter)
               throws FormatException
Description copied from interface: FormatElement
This method is attended to be called by client code of FormatElement

Specified by:
format in interface FormatElement
Returns:
Throws:
FormatException

unformat

public void unformat(Message message,
                     WriteAdapter dataAdapter)
              throws UnformatException
Description copied from interface: FormatElement
This method is attended to be called by client code of FormatElement

Specified by:
unformat in interface FormatElement
Throws:
UnformatException

parseToLong

public long parseToLong(java.lang.String aString)

getUnformattedSize

public int getUnformattedSize()

setUnformattedSize

public void setUnformattedSize(java.lang.String unformattedSize)

attributes

protected java.util.Map<java.lang.String,java.lang.String> attributes()
Description copied from class: AbstractFormatElement
Generic attributes method. This method parse throw the 'get' methods of the class, and finds out all the attributes of the bean. It is a simple implementation. Customers are recommended to override this method.

Overrides:
attributes in class AbstractFormatElement
Returns:

IBM Bank Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2008