|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.dse.base.FormatElement | +--com.ibm.dse.base.KeyedCollectionFormat | +--com.ibm.dse.base.RecordFormat | +--com.ibm.dse.base.XMLFormat
This class formats a KeyedCollection to an XML-compliant format.
Field Summary | |
protected java.lang.String |
includeDataType
includeDataType tag attribute. |
protected java.lang.String |
unNamed
unNamed tag attribute. |
Fields inherited from class com.ibm.dse.base.FormatElement |
dataElementName,
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 | |
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 |
getIncludeDataType()
Gets the includeDataType property value. |
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 |
isIncludeDataType()
Returns the boolean value of the includeDataType property |
boolean |
isUnNamed()
Returns the boolean value of the unNamed property |
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. |
DataElement |
unformatContext(java.lang.String aString,
Context aContext)
Unformats an XMLFormat updating data elements in the context. |
KeyedCollection |
unformatKeyedCollection(java.lang.String aString,
KeyedCollection aKeyedCollection)
Unformats an XMLFormat updating data elements in the collection passed as a parameter. |
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.dse.base.RecordFormat |
obtainDataElement,
obtainDataElement,
toString |
Methods inherited from class com.ibm.dse.base.KeyedCollectionFormat |
add,
addElementAt,
addFirst,
at,
format,
getElements,
getEnumeration,
removeAll,
removeAt,
setElements,
size,
unformat,
unformat |
Methods inherited from class com.ibm.dse.base.FormatElement |
exceptionInfo,
externalizer,
format,
getDataElementName,
getExternalizer,
getName,
getTagName,
isCacheable,
isConstant,
readExternal,
readExternal,
readObject,
reinitialize,
removeExternal,
rootDecorated,
setDataElementName,
setExternalizer,
setName,
setSize,
toTags,
unformat,
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
Constructor Detail |
public XMLFormat()
public XMLFormat(java.lang.String aName) throws java.io.IOException
aName
- java.lang.StringMethod Detail |
public java.lang.String[] extract(java.lang.String aString) throws DSEInvalidArgumentException
String
- aString, a string which contains formated stringspublic java.lang.String[] extractElement(java.lang.String elementName, java.lang.String aString)
elementName
- java.lang.StringaString
- java.lang.Stringpublic java.lang.String format(Context aContext) throws DSEInvalidClassException, DSEInvalidRequestException, DSEInvalidArgumentException
aContext
- com.ibm.dse.base.Contextpublic java.lang.String format(KeyedCollection aKeyedCollection) throws DSEInvalidClassException, DSEInvalidRequestException, DSEInvalidArgumentException
aKeyedCollection
- com.ibm.dse.base.KeyedCollectionpublic java.lang.String formatAsXML(DataElement aDataElement, FormatElement aFormatElement)
aDataElement
- com.ibm.dse.base.DataElementaFormatElement
- com.ibm.dse.base.FormatElementpublic java.lang.String formatContext(Context aContext) throws DSEInvalidClassException, DSEInvalidRequestException, DSEInvalidArgumentException
aContext
- com.ibm.dse.base.Contextpublic java.lang.String formatKeyedCollection(KeyedCollection aKeyedCollection) throws DSEInvalidClassException, DSEInvalidRequestException, DSEInvalidArgumentException
aKeyedCollection
- com.ibm.dse.base.KeyedCollectionpublic java.lang.String getIncludeDataType()
setIncludeDataType(java.lang.String)
protected java.lang.String getPostTag(java.lang.String aName)
String
- aNameprotected java.lang.String getPreTag(java.lang.String aName)
String
- aNameprotected java.lang.String getPreTag(java.lang.String aName, java.lang.String aType)
aName
- StringaType
- Stringprotected java.lang.String getType(FormatElement aFormatElement)
FormatElement
- aFormatElementpublic java.lang.String getUnNamed()
public java.lang.Object initializeFrom(Tag aTag) throws java.io.IOException
aTag
- com.ibm.dse.base.Tagpublic boolean isIncludeDataType()
getIncludeDataType()
,
setIncludeDataType(java.lang.String)
public boolean isUnNamed()
getUnNamed()
,
setUnNamed(java.lang.String)
public void setIncludeDataType(java.lang.String aString)
The
- includeDataType property value.getIncludeDataType()
public void setUnNamed(java.lang.String newUnNamed)
newUnNamed
- java.lang.String The new value of the property.public Vector toStrings()
public DataElement unformatContext(java.lang.String aString, Context aContext) throws DSEInvalidRequestException, DSEInvalidArgumentException
aString
- java.lang.StringaContext
- com.ibm.dse.base.Contextpublic KeyedCollection unformatKeyedCollection(java.lang.String aString, KeyedCollection aKeyedCollection) throws DSEInvalidRequestException, DSEInvalidArgumentException
aString
- java.lang.StringaContext
- com.ibm.dse.base.Contextpublic void unformatXML(java.lang.String aString, DataElement aDataElement, FormatElement aFormatElement) throws DSEInvalidRequestException, DSEInvalidArgumentException, DSEObjectNotFoundException
String
- aStringaDataElement
- com.ibm.dse.base.DataElementaFormatElement
- com.ibm.dse.base.FormatElement
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |