com.ibm.btt.format.impl
Class IndexedFormat
java.lang.Object
com.ibm.btt.format.AbstractFormatElement
com.ibm.btt.format.CompositeFormat
com.ibm.btt.format.impl.IndexedFormat
- All Implemented Interfaces:
- FormatElement
public class IndexedFormat
- extends CompositeFormat
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
IndexedFormat
public IndexedFormat()
getElementType
public java.lang.String getElementType()
- Returns:
- the elementType
setElementType
public void setElementType(java.lang.String elementType)
- Parameters:
elementType
- the elementType to set
getAppend
public int getAppend()
- Returns:
- the append
setAppend
public void setAppend(java.lang.String append)
- Parameters:
append
- the append to set
getTimes
public int getTimes()
- Returns:
- the times
setTimes
public void setTimes(java.lang.String times)
- Parameters:
times
- the times to set
getElement
public FormatElement getElement()
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.
- Specified by:
isContainer
in interface FormatElement
- Overrides:
isContainer
in class CompositeFormat
- Returns:
unformat
public void unformat(Message bytes,
WriteAdapter dataAdapter)
throws UnformatException
- Description copied from interface:
FormatElement
- This method is attended to be called by client code of FormatElement
- Throws:
UnformatException
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:
(c) Copyright IBM Corporation 1998, 2008