|
IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.btt.base.FormatElement
com.ibm.btt.base.KeyedCollectionFormat
com.ibm.btt.base.DynamicXMLFormat
@ATTR(value={"kCollInsertedOnFormat#Boolean#IMPLIED","createKCollOnUnformat#Boolean#IMPLIED"}) public class DynamicXMLFormat
The DynamicXMLFormat class formats a KeyedCollection into an XML compliant format. You can specify a DataElement from another parent context. When formatted, the DataElement is included in the formatted string. When unformatted, the DataElement is unformatted to the specified context.
Field Summary | |
---|---|
(package private) Context |
context
Initial context to start the search of context pointed by a DataPointer |
protected java.lang.String |
datePattern
The pattern to be used to format/unformat dates * |
protected java.lang.String |
escape
|
(package private) java.util.Vector |
pointers
The set of pointers used in the format |
Fields inherited from class com.ibm.btt.base.KeyedCollectionFormat |
---|
dataElementEmpty, elements |
Fields inherited from class com.ibm.btt.base.FormatElement |
---|
dataElementName, externalizer, name |
Constructor Summary | |
---|---|
DynamicXMLFormat()
|
Method Summary | |
---|---|
protected java.util.Date |
createDate(java.lang.String aString)
Creates a date from aString with dataConverter dd/MM/yy/hh/mm/ss |
protected java.lang.Object |
createNumber(java.lang.String aString,
char type)
Creates a number from aString and type char. |
protected java.lang.String |
escape(java.lang.String msg)
|
java.lang.String[] |
extractElement(java.lang.String elementName,
java.lang.String aString)
Extracts the element from aString named elementName. |
java.lang.String |
formatContext(Context aContext)
Formats a Context into an XML compliant format. |
protected java.lang.String |
formatDateXml(java.util.Date aDate)
Formats a Date with the pattern: dd/MM/yy/hh/mm/ss. |
java.lang.String |
formatHashtableXml(java.util.Hashtable aHashtable)
Formats a KeyedCollection into an XML compliant format. |
java.lang.String |
formatKeyedCollection(KeyedCollection aKeyedCollection)
Formats a KeyedCollection into an XML compliant format. |
protected java.lang.String |
formatNumberXml(java.lang.Number aNumber)
Formats a Number into the default format of the number. |
java.lang.String |
formatVectorXml(java.util.Vector aVector)
Formats a Vector into an XML compliant format. |
Context |
getContext(java.lang.String aString)
Extracts the ContextName attribute from a Tag and returns this context if it exists. |
java.lang.String |
getCreateOnUnformat()
Obtains createOnUnformat attribute. |
java.lang.String |
getDatePattern()
Gets the datePattern attribute. |
protected java.lang.String |
getElementName(java.lang.String aString)
Obtains element name. |
java.lang.String |
getEscape()
Obtains the value of the escape attribute. |
java.lang.String |
getInsertOnFormat()
Obtains insertOnFormat. |
protected int |
getNdxFrom(int ndxFrom,
java.lang.String elementName,
java.lang.String aString)
get the initial index . |
protected int |
getNdxTo(int ndxFrom,
java.lang.String elementName,
java.lang.String aString)
get the end index . |
java.util.Vector |
getPointers()
Obtains the DataPointers. |
protected java.lang.String |
getPostDataFieldTag(DataField data)
Constructs the tag after each dataField. |
protected java.lang.String |
getPostIndexedCollectionTag(IndexedCollection data)
Constructs the tag after each IndexedCollection. |
protected java.lang.String |
getPostKeyedCollectionTag(KeyedCollection data)
Constructs the tag after each KeyedCollection. |
protected java.lang.String |
getPreDataFieldTag(DataField data)
Constructs the tag before each DataField. |
protected java.lang.String |
getPreIndexedCollectionTag(IndexedCollection data)
Constructs the tag before each IndexedCollection. |
protected java.lang.String |
getPreKeyedCollectionTag(KeyedCollection data)
Constructs the tag before each KeyedCollection. |
protected java.lang.String |
getType(java.lang.String aString)
Obtains the type of this field. |
java.lang.Object |
initializeFrom(Tag aTag)
Initializes an XMLFormat with the Tag attributes. |
boolean |
insertKCollOnFormat()
Returns true if the insertKCollOnFormat is set to yes. |
protected boolean |
isDate(java.lang.String aString)
Identifies a Date. |
boolean |
isEscape()
Check whether the formatter are required to escape the format result or unescape the input string before unformatting. |
protected boolean |
isHashtable(java.lang.String aString)
Identifies a java.util.Hashtable. |
boolean |
isIndexedCollection(java.lang.String aString)
Identifies an IndexedCollection. |
boolean |
isKeyedCollection(java.lang.String aString)
Identifies a KeyedCollection. |
protected boolean |
isNull(java.lang.String aString)
Identifies a null. |
boolean |
isNumber(java.lang.String aString)
Identifies a number. |
protected boolean |
isString(java.lang.String aString)
Identifies a String. |
protected boolean |
isVector(java.lang.String aString)
Identifies a java.util.Vector. |
protected java.lang.String |
parseDataElementAsXml(java.lang.Object data)
Selects the method to invoke depending on the argument data class. |
protected java.lang.String |
parseDataFieldAsXml(DataField data)
Converts a dataField to an XML format. |
protected java.lang.String |
parseIndexedCollectionAsXml(IndexedCollection data)
Converts IndexedCollection to an XML format. |
protected java.lang.String |
parseKeyedCollectionAsXml(KeyedCollection data)
Converts KeyedCollection to an XML format. |
protected java.lang.String |
parseOtherDataAsXml(java.lang.Object data)
Prepares Parser for other data. |
protected java.lang.String |
parsePointerAsXml(java.lang.Object data,
java.lang.String ContextName)
Selects the method to invoke depending on the argument data class. |
void |
setCreateOnUnformat(java.lang.String aString)
Sets the createOnUnformat property value. |
void |
setDatePattern(java.lang.String newPattern)
Sets the datePattern attribute to the newPattern |
void |
setEscape(java.lang.String newEscape)
|
void |
setInsertOnFormat(java.lang.String aString)
Sets the insertOnFormat property value. |
void |
setPointers(java.util.Vector v)
Sets the pointers property (Vector) value. |
java.lang.String |
toString()
Returns a String representating the format. |
Vector |
toStrings()
Returns a visual representation of this format. |
protected java.lang.String |
unescape(java.lang.String msg)
Replace special characters with XML escapes: |
int |
unformat(int ndxFrom,
int ndxTo,
java.lang.String aString,
Context aContext)
Unformats a XML String and stores it in the context aContext. |
int |
unformat(int ndxFrom,
int ndxTo,
java.lang.String str,
DataElement de)
Unformats an XML String and stores it in aKeyedCollection. |
DataElement |
unformatContext(java.lang.String aString,
Context aContext)
Unformats a XML String and stores it in the context aContext. |
int |
unformatKeyedCollection(int ndxFrom,
int ndxTo,
java.lang.String aString,
KeyedCollection aKeyedCollection)
Unformats an XML String and stores it in aKeyedCollection. |
KeyedCollection |
unformatKeyedCollection(java.lang.String aString,
KeyedCollection aKeyedCollection)
Unformats an XML String and stores it in aKeyedCollection. |
Methods inherited from class com.ibm.btt.base.KeyedCollectionFormat |
---|
add, addElementAt, addFirst, at, checkIndexes, format, format, getDataElementEmpty, getElements, getEnumeration, reinitialize, removeAll, removeAt, setElements, size, unformat, unformat |
Methods inherited from class com.ibm.btt.base.FormatElement |
---|
exceptionInfo, externalizer, extract, getDataElementName, getExternalizer, getName, getTagName, isCacheable, isConstant, isItConstant, isNull, readExternal, readExternal, readObject, removeExternal, rootDecorated, setDataElementName, setExternalizer, setName, setSize, toTags, writeExternal, writeExternal |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected java.lang.String datePattern
protected java.lang.String escape
java.util.Vector pointers
Context context
Constructor Detail |
---|
public DynamicXMLFormat()
Method Detail |
---|
protected java.util.Date createDate(java.lang.String aString) throws DSEInvalidRequestException
aString
- java.lang.String
DSEInvalidRequestException
protected java.lang.Object createNumber(java.lang.String aString, char type)
aString
- java.lang.String
public java.lang.String[] extractElement(java.lang.String elementName, java.lang.String aString)
elementName
- java.lang.StringaString
- java.lang.Stringpublic java.lang.String formatContext(Context aContext) throws DSEInvalidClassException, DSEInvalidRequestException, DSEInvalidArgumentException
formatContext
in class KeyedCollectionFormat
aContext
- java.lang.String
DSEInvalidClassException
DSEInvalidRequestException
DSEInvalidArgumentException
protected java.lang.String formatDateXml(java.util.Date aDate) throws DSEInvalidArgumentException
aDate
- java.util.Date
DSEInvalidArgumentException
public java.lang.String formatHashtableXml(java.util.Hashtable aHashtable) throws DSEInvalidArgumentException
aHashtable
- java.util.Hashtable
DSEInvalidArgumentException
public java.lang.String formatKeyedCollection(KeyedCollection aKeyedCollection) throws DSEInvalidClassException, DSEInvalidRequestException, DSEInvalidArgumentException
formatKeyedCollection
in class KeyedCollectionFormat
aKeyedCollection
- java.lang.String
DSEInvalidClassException
DSEInvalidRequestException
DSEInvalidArgumentException
protected java.lang.String formatNumberXml(java.lang.Number aNumber)
aNumber
- java.lang.Number
public java.lang.String formatVectorXml(java.util.Vector aVector) throws DSEInvalidArgumentException
DSEInvalidArgumentException
public Context getContext(java.lang.String aString)
aString
- java.lang.String
public java.lang.String getCreateOnUnformat()
public java.lang.String getDatePattern()
protected java.lang.String getElementName(java.lang.String aString)
aString
- java.lang.String
public java.lang.String getInsertOnFormat()
public java.lang.String getEscape()
public java.util.Vector getPointers()
protected java.lang.String getPostDataFieldTag(DataField data)
data
- com.ibm.btt.base.DataField
protected java.lang.String getPostIndexedCollectionTag(IndexedCollection data)
data
- com.ibm.btt.base.IndexedCollection
protected java.lang.String getPostKeyedCollectionTag(KeyedCollection data)
data
- com.ibm.btt.base.KeyedCollection
protected java.lang.String getPreDataFieldTag(DataField data)
data
- com.ibm.btt.base.DataField
protected java.lang.String getPreIndexedCollectionTag(IndexedCollection data)
data
- com.ibm.btt.base.IndexedCollection
protected java.lang.String getPreKeyedCollectionTag(KeyedCollection data)
data
- com.ibm.btt.base.KeyedCollection
protected java.lang.String getType(java.lang.String aString)
aString
- com.ibm.btt.base.DataField
public java.lang.Object initializeFrom(Tag aTag) throws java.io.IOException
initializeFrom
in class FormatElement
aTag
- com.ibm.btt.base.Tag
java.io.IOException.
java.io.IOException
public boolean insertKCollOnFormat()
protected boolean isDate(java.lang.String aString)
aString
- java.lang.String
protected boolean isHashtable(java.lang.String aString)
aString
- java.lang.String
public boolean isIndexedCollection(java.lang.String aString)
aString
- java.lang.String
public boolean isKeyedCollection(java.lang.String aString)
aString
- java.lang.String
protected boolean isNull(java.lang.String aString)
aString
- java.lang.String
public boolean isNumber(java.lang.String aString)
aString
- java.lang.String
protected boolean isString(java.lang.String aString)
aString
- java.lang.String
protected boolean isVector(java.lang.String aString)
aString
- java.lang.String
public boolean isEscape()
protected java.lang.String parseDataElementAsXml(java.lang.Object data) throws DSEInvalidArgumentException
data
- java.lang.Object
DSEInvalidArgumentException
protected java.lang.String parseDataFieldAsXml(DataField data) throws DSEInvalidArgumentException
data
- com.ibm.btt.base.DataField
DSEInvalidArgumentException
protected java.lang.String parseIndexedCollectionAsXml(IndexedCollection data) throws DSEInvalidArgumentException
data
- com.ibm.btt.base.IndexedCollection
DSEInvalidArgumentException
protected java.lang.String parseKeyedCollectionAsXml(KeyedCollection data) throws DSEInvalidArgumentException
data
- com.ibm.btt.base.KeyedCollection
DSEInvalidArgumentException
protected java.lang.String parseOtherDataAsXml(java.lang.Object data) throws DSEInvalidArgumentException
data
- java.lang.Object
com.ibm.btt.base.DSEInvalidArgumentException.
DSEInvalidArgumentException
protected java.lang.String parsePointerAsXml(java.lang.Object data, java.lang.String ContextName) throws DSEInvalidArgumentException
data
- java.lang.Object
DSEInvalidArgumentException
public void setCreateOnUnformat(java.lang.String aString)
aString
- getCreateOnUnformat()
public void setDatePattern(java.lang.String newPattern)
newPattern
- java.lang.Stringpublic void setInsertOnFormat(java.lang.String aString)
aString
- getInsertOnFormat()
public void setEscape(java.lang.String newEscape)
public void setPointers(java.util.Vector v)
v
- The new value for the property.getPointers()
public java.lang.String toString()
toString
in class FormatElement
public Vector toStrings()
toStrings
in class FormatElement
public DataElement unformatContext(java.lang.String aString, Context aContext) throws DSEInvalidRequestException, DSEInvalidArgumentException
unformatContext
in class KeyedCollectionFormat
aString
- java.lang.StringaContext
- com.ibm.btt.base.Context
DSEInvalidRequestException
DSEInvalidArgumentException
public KeyedCollection unformatKeyedCollection(java.lang.String aString, KeyedCollection aKeyedCollection) throws DSEInvalidRequestException, DSEInvalidArgumentException
unformatKeyedCollection
in class KeyedCollectionFormat
aString
- java.lang.StringaKeyedCollection
- com.ibm.btt.base.KeyedCollection
DSEInvalidRequestException
DSEInvalidArgumentException
public int unformat(int ndxFrom, int ndxTo, java.lang.String aString, Context aContext) throws DSEInvalidRequestException, DSEInvalidArgumentException
unformat
in class KeyedCollectionFormat
ndxFrom
- is the initial indexndxTo
- intaString
- StringaContext
- Context
DSEInvalidRequestException
DSEInvalidArgumentException
public int unformat(int ndxFrom, int ndxTo, java.lang.String str, DataElement de) throws DSEInvalidRequestException, DSEInvalidArgumentException
unformat
in class KeyedCollectionFormat
ndxFrom
- is the initial indexndxTo
- one is the final index
DSEInvalidRequestException
DSEInvalidArgumentException
public int unformatKeyedCollection(int ndxFrom, int ndxTo, java.lang.String aString, KeyedCollection aKeyedCollection) throws DSEInvalidRequestException, DSEInvalidArgumentException
DSEInvalidRequestException
DSEInvalidArgumentException
protected int getNdxFrom(int ndxFrom, java.lang.String elementName, java.lang.String aString)
protected int getNdxTo(int ndxFrom, java.lang.String elementName, java.lang.String aString)
protected java.lang.String escape(java.lang.String msg)
protected java.lang.String unescape(java.lang.String msg)
string
- The string to be escaped.
java.io.UnsupportedEncodingException
|
IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |