ifs.fnd.record.serialization

Class FndXmlBuffer

java.lang.Object

ifs.fnd.record.serialization.FndXmlBuffer

public class FndXmlBuffer
extends java.lang.Object

Framework internal class: Helper class to create XML document text.

This is a framework internal class! Backward compatibility is not guaranteed.

Constructor Summary

Constructors

Constructor and Description
FndXmlBuffer(java.lang.String defaultNamespace) Creates a new FndXmlBuffer that writes to an internal FndXmlWriter.

Method Summary

Modifier and Type	Method and Description
void	addElement(java.lang.String name, FndXmlElementAttributeList attributes) Adds a simple element to the document.
void	addElement(java.lang.String name, java.lang.String attrName, java.lang.String attrValue) Adds a simple element with a single attribute to the document.
void	addElement(java.lang.String name, java.lang.String attr1Name, java.lang.String attr1Value, java.lang.String attr2Name, java.lang.String attr2Value) Adds a simple element with two attributes to the document.
void	addHeaderElement(java.lang.String value) Adds a header element to the document.
void	addSimpleElement(java.lang.String name) Adds a simple element to the document.
void	addSimpleElement(java.lang.String name, java.lang.String value) Adds a simple element to the document.
void	addWsdlDocumentation(java.lang.String termDef, java.lang.String definition) Add documentation tag to the XML document.
void	append(java.lang.String s) Appends a XML formatted string to the document.
void	appendXml(byte[] data) Append UTF-8 encoded XML text to the document.
void	close() Closes this XML buffer and its underlying XML writer.
void	endElement() Adds an end element to the document.
byte[]	getBytes() Return byte representation the XML document.
java.lang.StringBuffer	getText() Return a string buffer with the text of the XML document.
void	startElement(java.lang.String name) Adds a start element to the document.
void	startElement(java.lang.String name, FndXmlElementAttributeList attributes) Adds a start element to the document.
void	startElement(java.lang.String name, java.lang.String attrName, java.lang.String attrValue) Adds a start element with a single attribute to the document.
void	startElement(java.lang.String name, java.lang.String attr1Name, java.lang.String attr1Value, java.lang.String attr2Name, java.lang.String attr2Value) Adds a start element with two attributes to the document.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FndXmlBuffer

public FndXmlBuffer(java.lang.String defaultNamespace)
             throws SystemException

Creates a new FndXmlBuffer that writes to an internal FndXmlWriter.

Throws:

SystemException

Method Detail

close

public void close()
           throws SystemException

Closes this XML buffer and its underlying XML writer.

Throws:

SystemException

startElement

public void startElement(java.lang.String name,
                         FndXmlElementAttributeList attributes)

Adds a start element to the document.

Parameters:

name - the name of the element.

attributes - a FndXmlElementAttributeList object with name-value pairs constituting the element's attributes.

startElement

public void startElement(java.lang.String name,
                         java.lang.String attrName,
                         java.lang.String attrValue)

Adds a start element with a single attribute to the document.

Parameters:

name - the name of the element.

attrName - the name of the single attribute

attrValue - the value for the attribute above

startElement

public void startElement(java.lang.String name,
                         java.lang.String attr1Name,
                         java.lang.String attr1Value,
                         java.lang.String attr2Name,
                         java.lang.String attr2Value)

Adds a start element with two attributes to the document.

Parameters:

name - the name of the element.

attr1Name - the name of the first attribute

attr1Value - the value for the first attribute

attr2Name - the name of the second attribute

attr2Value - the value for the second attribute

startElement

public void startElement(java.lang.String name)

Adds a start element to the document.

Parameters:

name - the name of the element.

endElement

public void endElement()

Adds an end element to the document.

addSimpleElement

public void addSimpleElement(java.lang.String name,
                             java.lang.String value)

Adds a simple element to the document.

Parameters:

name - the name of the element.

value - the text value for the element

addSimpleElement

public void addSimpleElement(java.lang.String name)

Adds a simple element to the document.

Parameters:

name - the name of the element.

addHeaderElement

public void addHeaderElement(java.lang.String value)

Adds a header element to the document.

Parameters:

value - the text value for the element

addElement

public void addElement(java.lang.String name,
                       FndXmlElementAttributeList attributes)

Adds a simple element to the document.

Parameters:

name - the name of the element.

attributes - a FndXmlElementAttributeList object with name-value pairs constituting the element's attributes.

addElement

public void addElement(java.lang.String name,
                       java.lang.String attrName,
                       java.lang.String attrValue)

Adds a simple element with a single attribute to the document.

Parameters:

name - the name of the element.

attrName - the name of the single attribute

attrValue - the value for the attribute above

addElement

public void addElement(java.lang.String name,
                       java.lang.String attr1Name,
                       java.lang.String attr1Value,
                       java.lang.String attr2Name,
                       java.lang.String attr2Value)

Adds a simple element with two attributes to the document.

Parameters:

name - the name of the element.

attr1Name - the name of the first attribute

attr1Value - the value for the first attribute

attr2Name - the name of the second attribute

attr2Value - the value for the second attribute

append

public void append(java.lang.String s)

Appends a XML formatted string to the document.

Parameters:

s - string to append

appendXml

public void appendXml(byte[] data)

Append UTF-8 encoded XML text to the document.

Parameters:

data - array of bytes to append

getText

public java.lang.StringBuffer getText()

Return a string buffer with the text of the XML document.

Returns:

the text of created XML document

getBytes

public byte[] getBytes()
                throws java.io.UnsupportedEncodingException

Return byte representation the XML document.

Returns:

the text of created XML document, or null if FndXmlWriter hs been used

Throws:

java.io.UnsupportedEncodingException

addWsdlDocumentation

public void addWsdlDocumentation(java.lang.String termDef,
                                 java.lang.String definition)
                          throws ParseException

Add documentation tag to the XML document.

Parameters:

termDef - term definition path

definition - technical description

Throws:

ParseException