com.ibm.btt.format.impl
Class RecordFormat
java.lang.Object
com.ibm.btt.format.AbstractFormatElement
com.ibm.btt.format.CompositeFormat
com.ibm.btt.format.impl.RecordFormat
- All Implemented Interfaces:
- FormatElement
- Direct Known Subclasses:
- MapRecordFormat
public class RecordFormat
- extends CompositeFormat
Method Summary |
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 |
getType()
|
void |
setType(java.lang.String type)
|
void |
unformat(Message message,
WriteAdapter dataAdapter)
This method is attended to be called by client code of FormatElement
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
RecordFormat
public RecordFormat()
setType
public void setType(java.lang.String type)
getType
public java.lang.String getType()
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
- 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
- Throws:
UnformatException
(c) Copyright IBM Corporation 1998, 2008