|
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.RecordFormat
com.ibm.btt.base.XMLFormat
@ATTR(value={"unNamed#Boolean#IMPLIED","includeDataType#Boolean#IMPLIED"}) public class XMLFormat
This class formats a KeyedCollection to an XML-compliant format.
Field Summary | |
---|---|
protected java.lang.String |
escape
|
protected java.lang.String |
includeDataType
includeDataType tag attribute |
protected java.lang.String |
unNamed
unNamed tag attribute |
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 | |
---|---|
XMLFormat()
This constructor creates an XMLFormat object. |
|
XMLFormat(java.lang.String aName)
This constructor creates an XMLFormat object with a specified name. |
Method Summary | |
---|---|
protected java.lang.String |
escape(java.lang.String msg)
|
java.lang.String[] |
extract(java.lang.String aString)
Extracts a String taking the substring in which the format is interested. |
java.lang.String[] |
extractElement(java.lang.String elementName,
java.lang.String aString)
Extracts from aString the element named elementName. |
java.lang.String |
format(Context aContext)
Formats data elements getting them from the context. |
java.lang.String |
format(KeyedCollection aKeyedCollection)
Formats data elements, getting them from the collection passes as a parameter. |
java.lang.String |
formatAsXML(DataElement aDataElement,
FormatElement aFormatElement)
Formats aDataElement to an XML-compliant format. |
java.lang.String |
formatContext(Context aContext)
This method performs the format seeking the elements to format around the context tree of the context passed as parameter. |
java.lang.String |
formatKeyedCollection(KeyedCollection aKeyedCollection)
This method performs the format seeking the elements to format around the keyedCollection passed as parameter. |
java.lang.String |
getEscape()
|
java.lang.String |
getIncludeDataType()
Gets the includeDataType property value. |
protected int |
getNdxFrom(int ndxFrom,
int ndxTo,
java.lang.String elementName,
java.lang.String aString)
get initial index |
protected int[] |
getNdxFromAndTo(int ndxFrom,
int ndxTo,
java.lang.String elementName,
java.lang.String aString)
get end index |
protected java.lang.String |
getPostTag(java.lang.String aName)
Returns the tag that follows each DataElement. |
protected java.lang.String |
getPreTag(java.lang.String aName)
Returns the tag that preceeds each DataElement. |
protected java.lang.String |
getPreTag(java.lang.String aName,
java.lang.String aType)
Returns the tag already built. |
protected java.lang.String |
getType(FormatElement aFormatElement)
Returns the type of the DataElement referenced in the FormatElement |
java.lang.String |
getUnNamed()
Returns the value of the unNamed property. |
java.lang.Object |
initializeFrom(Tag aTag)
Initializes an XMLFormat with the aTag attributes. |
boolean |
isEscape()
Check whether the formatter are required to escape the format result or unescape the input string before unformatting. |
boolean |
isIncludeDataType()
Returns the boolean value of the includeDataType property. |
boolean |
isUnNamed()
Returns the boolean value of the unNamed property. |
void |
setEscape(java.lang.String newEscape)
|
void |
setIncludeDataType(java.lang.String aString)
Sets the includeDataType property (String) value. |
void |
setUnNamed(java.lang.String newUnNamed)
Sets the value of the unNamed property. |
Vector |
toStrings()
Returns a visual representation of this format element. |
protected java.lang.String |
unescape(java.lang.String msg)
Replace special characters with XML escapes: |
protected java.lang.String |
unescape(java.lang.String msg,
int ndxFrom,
int ndxTo)
|
int |
unformat(int ndxFrom,
int ndxTo,
java.lang.String aString,
Context aContext)
Unformats an XMLFormat updating data elements in the context. |
int |
unformat(int ndxFrom,
int ndxTo,
java.lang.String str,
DataElement de)
Verifies that the passed DataElement is an KeyedCollection and calls unformatKeyedCollection(). |
DataElement |
unformatContext(java.lang.String aString,
Context aContext)
Unformats an XMLFormat updating data elements in the context. |
int |
unformatKeyedCollection(int ndxFrom,
int ndxTo,
java.lang.String aString,
KeyedCollection aKeyedCollection)
Unformats an XMLFormat updating data elements in the collection passed as a parameter. |
KeyedCollection |
unformatKeyedCollection(java.lang.String aString,
KeyedCollection aKeyedCollection)
Unformats an XMLFormat updating data elements in the collection passed as a parameter. |
int |
unformatXML(int ndxFrom,
int ndxTo,
java.lang.String aString,
DataElement aDataElement,
FormatElement aFormatElement)
This method unformats a String XML compliant format in aDataElement. |
void |
unformatXML(java.lang.String aString,
DataElement aDataElement,
FormatElement aFormatElement)
This method unformats a String XML compliant format in aDataElement. |
Methods inherited from class com.ibm.btt.base.RecordFormat |
---|
obtainDataElement, obtainDataElement, toString |
Methods inherited from class com.ibm.btt.base.KeyedCollectionFormat |
---|
add, addElementAt, addFirst, at, checkIndexes, format, getDataElementEmpty, getElements, getEnumeration, reinitialize, removeAll, removeAt, setElements, size, unformat, unformat |
Methods inherited from class com.ibm.btt.base.FormatElement |
---|
exceptionInfo, externalizer, 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 includeDataType
protected java.lang.String unNamed
protected java.lang.String escape
Constructor Detail |
---|
public XMLFormat()
public XMLFormat(java.lang.String aName) throws java.io.IOException
aName
- java.lang.String
java.io.IOException
Method Detail |
---|
public java.lang.String[] extract(java.lang.String aString) throws DSEInvalidArgumentException
extract
in class RecordFormat
aString
- java.lang.String - A string which contains formated strings
DSEInvalidArgumentException
public java.lang.String[] extractElement(java.lang.String elementName, java.lang.String aString)
elementName
- java.lang.StringaString
- java.lang.String
public java.lang.String format(Context aContext) throws DSEInvalidClassException, DSEInvalidRequestException, DSEInvalidArgumentException
format
in class KeyedCollectionFormat
aContext
- com.ibm.btt.base.Context
com.ibm.btt.base.DSEInvalidClassException.
com.ibm.btt.base.DSEInvalidRequestException,
DSEInvalidArgumentException
DSEInvalidClassException
DSEInvalidRequestException
public java.lang.String format(KeyedCollection aKeyedCollection) throws DSEInvalidClassException, DSEInvalidRequestException, DSEInvalidArgumentException
aKeyedCollection
- com.ibm.btt.base.KeyedCollection
com.ibm.btt.base.DSEInvalidClassException.
com.ibm.btt.base.DSEInvalidRequestException,
DSEInvalidArgumentException
DSEInvalidClassException
DSEInvalidRequestException
public java.lang.String formatAsXML(DataElement aDataElement, FormatElement aFormatElement)
aDataElement
- com.ibm.btt.base.DataElementaFormatElement
- com.ibm.btt.base.FormatElement
public java.lang.String formatContext(Context aContext) throws DSEInvalidClassException, DSEInvalidRequestException, DSEInvalidArgumentException
formatContext
in class RecordFormat
aContext
- com.ibm.btt.base.Context
DSEInvalidClassException
DSEInvalidRequestException
DSEInvalidArgumentException
public java.lang.String formatKeyedCollection(KeyedCollection aKeyedCollection) throws DSEInvalidClassException, DSEInvalidRequestException, DSEInvalidArgumentException
formatKeyedCollection
in class RecordFormat
aKeyedCollection
- com.ibm.btt.base.KeyedCollection
DSEInvalidClassException
DSEInvalidRequestException
DSEInvalidArgumentException
public java.lang.String getIncludeDataType()
setIncludeDataType(java.lang.String)
protected java.lang.String getPostTag(java.lang.String aName)
aName
- java.lang.String
protected java.lang.String getPreTag(java.lang.String aName)
aName
- java.lang.String
protected java.lang.String getPreTag(java.lang.String aName, java.lang.String aType)
aName
- StringaType
- Stringprotected java.lang.String getType(FormatElement aFormatElement)
aFormatElement
- com.ibm.btt.base.FormatElement
public java.lang.String getUnNamed()
public java.lang.String getEscape()
public java.lang.Object initializeFrom(Tag aTag) throws java.io.IOException
initializeFrom
in class RecordFormat
aTag
- com.ibm.btt.base.Tag
java.io.IOException
public boolean isIncludeDataType()
getIncludeDataType()
,
setIncludeDataType(java.lang.String)
public boolean isUnNamed()
getUnNamed()
,
setUnNamed(java.lang.String)
public boolean isEscape()
public void setIncludeDataType(java.lang.String aString)
aString
- java.lang.String - The includeDataType property valuegetIncludeDataType()
public void setUnNamed(java.lang.String newUnNamed)
newUnNamed
- java.lang.String - The new value of the propertypublic void setEscape(java.lang.String newEscape)
public Vector toStrings()
FormatElement
toStrings
in class RecordFormat
RecordFormat.toStrings()
public DataElement unformatContext(java.lang.String aString, Context aContext) throws DSEInvalidRequestException, DSEInvalidArgumentException
unformatContext
in class RecordFormat
aString
- java.lang.StringaContext
- com.ibm.btt.base.Context
com.ibm.btt.base.DSEInvalidRequestException.
com.ibm.btt.base.DSEInvalidArgumentException.
DSEInvalidRequestException
DSEInvalidArgumentException
public KeyedCollection unformatKeyedCollection(java.lang.String aString, KeyedCollection aKeyedCollection) throws DSEInvalidRequestException, DSEInvalidArgumentException
unformatKeyedCollection
in class RecordFormat
aString
- java.lang.StringaKeyedCollection
- com.ibm.btt.base.KeyedCollection
com.ibm.btt.base.DSEInvalidRequestException,
DSEInvalidArgumentException
DSEInvalidRequestException
public void unformatXML(java.lang.String aString, DataElement aDataElement, FormatElement aFormatElement) throws DSEInvalidRequestException, DSEInvalidArgumentException, DSEObjectNotFoundException
aString
- java.lang.StringaDataElement
- com.ibm.btt.base.DataElementaFormatElement
- com.ibm.btt.base.FormatElement
com.ibm.btt.base.DSEInvalidRequestException,
DSEInvalidArgumentException
DSEObjectNotFoundException
DSEInvalidRequestException
public int unformat(int ndxFrom, int ndxTo, java.lang.String str, DataElement de) throws DSEInvalidRequestException, DSEInvalidArgumentException
unformat
in class RecordFormat
ndxFrom
- -
the initial indexndxTo
- -
the final indexstr
- Stringde
- DataElement
DSEInvalidRequestException
DSEInvalidArgumentException
public int unformatKeyedCollection(int ndxFrom, int ndxTo, java.lang.String aString, KeyedCollection aKeyedCollection) throws DSEInvalidRequestException, DSEInvalidArgumentException
ndxFrom
- -
the initial indexndxTo
- -
the final indexaString
- java.lang.StringaKeyedCollection
- com.ibm.btt.base.Context
DSEInvalidRequestException
DSEInvalidArgumentException
public int unformat(int ndxFrom, int ndxTo, java.lang.String aString, Context aContext) throws DSEInvalidRequestException, DSEInvalidArgumentException
unformat
in class RecordFormat
ndxFrom
- -
the initial indexndxTo
- -
the final indexaString
- java.lang.StringaContext
- com.ibm.btt.base.Context
com.ibm.btt.base.DSEInvalidRequestException.
com.ibm.btt.base.DSEInvalidArgumentException.
DSEInvalidRequestException
DSEInvalidArgumentException
protected int getNdxFrom(int ndxFrom, int ndxTo, java.lang.String elementName, java.lang.String aString)
protected int[] getNdxFromAndTo(int ndxFrom, int ndxTo, java.lang.String elementName, java.lang.String aString)
public int unformatXML(int ndxFrom, int ndxTo, java.lang.String aString, DataElement aDataElement, FormatElement aFormatElement) throws DSEInvalidRequestException, DSEInvalidArgumentException, DSEObjectNotFoundException
ndxFrom
- -
the initial indexndxTo
- -
the final indexString
- aStringaDataElement
- com.ibm.btt.base.DataElementaFormatElement
- com.ibm.btt.base.FormatElement
com.ibm.btt.base.DSEInvalidRequestException,
DSEInvalidArgumentException
DSEObjectNotFoundException
DSEInvalidRequestException
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
protected java.lang.String unescape(java.lang.String msg, int ndxFrom, int ndxTo)
|
IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |