com.ibm.btt.format.impl
Class FormatDefine
java.lang.Object
com.ibm.btt.format.AbstractFormatElement
com.ibm.btt.format.impl.FormatDefine
- All Implemented Interfaces:
- FormatElement
- Direct Known Subclasses:
- JSONFormat, XMLFormat
public class FormatDefine
- extends AbstractFormatElement
Method Summary |
void |
addChild(FormatElement child)
|
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 |
getId()
|
FormatElement |
getRootFormat()
|
boolean |
isContainer()
if true, this FormatElement has children. if false, this FormatElement
has no children. |
void |
setId(java.lang.String id)
|
java.util.List<java.lang.String> |
toStrings()
This method is used to support AbstractFormatElement.toString() method
Client code of Formatter is not allowed to call it. |
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 |
id
protected java.lang.String id
rootFormat
protected FormatElement rootFormat
FormatDefine
public FormatDefine()
getId
public java.lang.String getId()
setId
public void setId(java.lang.String id)
getRootFormat
public FormatElement getRootFormat()
addChild
public void addChild(FormatElement child)
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
isContainer
public boolean isContainer()
- Description copied from interface:
FormatElement
- if true, this FormatElement has children. if false, this FormatElement
has no children.
For example:
com.ibm.btt.format.CompositeFormat and its sub class will always
return true;
com.ibm.btt.format.FiledFormat and its sub class will always return
false;
com.ibm.btt.format.FormatDecorator and its subclass will delegate
this method to its decorated FormatElement.
- Returns:
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
toStrings
public java.util.List<java.lang.String> toStrings()
- Description copied from interface:
FormatElement
- This method is used to support AbstractFormatElement.toString() method
Client code of Formatter is not allowed to call it.
But subclasses of AbstractFormatElement are allowed to override this method to
customize its toString() method.
- Specified by:
toStrings
in interface FormatElement
- Overrides:
toStrings
in class AbstractFormatElement
- Returns:
- List of Strings that represent the FormatElement.
(c) Copyright IBM Corporation 1998, 2008