oracle.apps.fnd.applseed.rt.extract.util.xml
Interface SDXMLWriter

All Known Implementing Classes:

SDAbstractXMLWriter, SDXMLSaxWriter

public interface SDXMLWriter

Interface for Seed Data XML Writers.

Method Summary

void	abort(java.lang.String msg) Abort the current xml processing, add comment in xml.
void	addComment(java.lang.String comment) Add a comment to the XML.
void	addElement(java.lang.String elementName) Create and append a new element with no attributes at current node.
void	addElement(java.lang.String elementName, SDNodeAttributes attribs) Create and append new element with name attributes at current node.
void	addElement(java.lang.String elementName, java.lang.String attrib, java.lang.String attribValue) Create and append new element with named attribute at current node.
void	addText(java.lang.String textVal) Add text at current node.
void	appendElement(java.lang.String elementName) Append the new Element node to current node.
void	endDocument() Ends the current document.
void	flush() Flush the Xml xmlSerializer output stream.
void	newElement(java.lang.String elementName) Create a new element node.
void	newElement(java.lang.String elementName, SDNodeAttributes attributes) Create new element node under current node.
void	newElement(java.lang.String elementName, java.lang.String attribName, java.lang.String attribVal) Create a new element node.
void	newTextNode(java.lang.String textNodeName, java.lang.String textValue) Overloaded method to add new text node under current node without attributes.
void	newTextNode(java.lang.String textNodeName, java.lang.String textValue, SDNodeAttributes attributes) Add a new text node under current node.
void	newTextNode(java.lang.String textNodeName, java.lang.String textValue, java.lang.String attribName, java.lang.String attribValue) Overloaded method to add new text node under current node adding attribute name=value.
void	startDocument() Start a new xml document.

Method Detail

startDocument

void startDocument()
                   throws ExtractXmlSerializeException

Start a new xml document.

Throws:

ExtractXmlSerializeException

endDocument

void endDocument()
                 throws ExtractXmlSerializeException

Ends the current document.

Throws:

ExtractXmlSerializeException - failure to end doc

newElement

void newElement(java.lang.String elementName,
                SDNodeAttributes attributes)
                throws ExtractXmlSerializeException

Create new element node under current node.

Parameters:

elementName - name to create

attributes - any attributes to add

Throws:

ExtractXmlSerializeException - failure to add new element

addComment

void addComment(java.lang.String comment)
                throws ExtractXmlSerializeException

Add a comment to the XML.

Parameters:

comment - String comment to add

Throws:

ExtractXmlSerializeException

flush

void flush()
           throws ExtractXmlSerializeException

Flush the Xml xmlSerializer output stream.

Throws:

ExtractXmlSerializeException

addText

void addText(java.lang.String textVal)
             throws ExtractXmlSerializeException

Add text at current node.

Parameters:

textVal - text value to add

Throws:

ExtractXmlSerializeException - SaxException adding text

addElement

void addElement(java.lang.String elementName)
                throws ExtractXmlSerializeException

Create and append a new element with no attributes at current node.

Parameters:

elementName - String name

Throws:

ExtractXmlSerializeException

addElement

void addElement(java.lang.String elementName,
                java.lang.String attrib,
                java.lang.String attribValue)
                throws ExtractXmlSerializeException

Create and append new element with named attribute at current node.

Parameters:

elementName - String name

attrib - attribute name

attribValue - attribute value

Throws:

ExtractXmlSerializeException

addElement

void addElement(java.lang.String elementName,
                SDNodeAttributes attribs)
                throws ExtractXmlSerializeException

Create and append new element with name attributes at current node.

Parameters:

elementName - String name

attribs - SDNodeAttributes of attribute name value pairs

Throws:

ExtractXmlSerializeException

newElement

void newElement(java.lang.String elementName)
                throws ExtractXmlSerializeException

Create a new element node.

Parameters:

elementName - name for element to add

Throws:

ExtractXmlSerializeException - failure to add new element

newElement

void newElement(java.lang.String elementName,
                java.lang.String attribName,
                java.lang.String attribVal)
                throws ExtractXmlSerializeException

Create a new element node.

Parameters:

elementName - name of element to create

attribName - attribute name

attribVal - attribute value

Throws:

ExtractXmlSerializeException - failure to add new element

appendElement

void appendElement(java.lang.String elementName)
                   throws ExtractXmlSerializeException

Append the new Element node to current node.

Parameters:

elementName - element name to add

Throws:

ExtractXmlSerializeException

newTextNode

void newTextNode(java.lang.String textNodeName,
                 java.lang.String textValue,
                 SDNodeAttributes attributes)
                 throws ExtractXmlSerializeException

Add a new text node under current node.

Parameters:

textNodeName - name to add

textValue - value to add

attributes - any attributes to insert in node

Throws:

ExtractXmlSerializeException

newTextNode

void newTextNode(java.lang.String textNodeName,
                 java.lang.String textValue)
                 throws ExtractXmlSerializeException

Overloaded method to add new text node under current node without attributes.

Parameters:

textNodeName - the name of the new text node

textValue - the value of the text to add

Throws:

ExtractXmlSerializeException

newTextNode

void newTextNode(java.lang.String textNodeName,
                 java.lang.String textValue,
                 java.lang.String attribName,
                 java.lang.String attribValue)
                 throws ExtractXmlSerializeException

Overloaded method to add new text node under current node adding attribute name=value.

Parameters:

textNodeName - the name of the new text node

textValue - the value of the text to add

attribName - node attribute name

attribValue - node attribute value

Throws:

ExtractXmlSerializeException

abort

void abort(java.lang.String msg)
           throws ExtractXmlSerializeException

Abort the current xml processing, add comment in xml.

Parameters:

msg - String any fail message to add to writer, null if none

Throws:

ExtractXmlSerializeException