org.mdiutil.xml

Class XmlWriter

java.lang.Object

org.mdiutil.xml.XmlWriter

public class XmlWriter
extends Object

Writes a Node (or XML Document) as text output. This is -not- a full XML printout implementation. However, this class can process correctly text (in ATTR or TEXT nodes) which is not plain ASCII. For example:

• Unicode characters outside of ASCII values are corresly escaped
• Quoted attributes are correctly handled

Field Summary

Fields

Modifier and Type	Field and Description
protected String	doctype
protected boolean	escapeHex
protected String	publicID
protected String	systemID

Constructor Summary

Constructors

Constructor and Description
XmlWriter()
XmlWriter(String doctype, String publicID, String systemID) Create a new XmlWriter, capable to write a XML DOM document to a file., with escaped hexadecimal sequences.
XmlWriter(String doctype, String publicID, String systemID, boolean escapeHex) Create a new XmlWriter, capable to write a XML DOM document to a file.

Method Summary

Modifier and Type	Method and Description
void	flush()
String	getDoctype() Return the doctype.
String	getPublicID() Return the publicID.
String	getSystemID() Return the systemID.
void	setPublicSystemID(String doctype, String publicID, String systemID) Set the public and system ID of the written XML Document.
void	writeDocument(Document doc, Writer writer)
void	writeXml(Node node, Writer writer)

Methods inherited from class java.lang.Object

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

Field Detail

escapeHex

protected boolean escapeHex

publicID

protected String publicID

systemID

protected String systemID

doctype

protected String doctype

Constructor Detail

XmlWriter

public XmlWriter()

XmlWriter

public XmlWriter(String doctype,
                 String publicID,
                 String systemID)

Create a new XmlWriter, capable to write a XML DOM document to a file., with escaped hexadecimal sequences.

Parameters:

doctype - the document type

publicID - the publicID of the document

systemID - the systemID of the document

XmlWriter

public XmlWriter(String doctype,
                 String publicID,
                 String systemID,
                 boolean escapeHex)

Create a new XmlWriter, capable to write a XML DOM document to a file.

Parameters:

doctype - the document type

publicID - the publicID of the document

systemID - the systemID of the document

escapeHex - defines if non ASCII characters are writen as UTF-8 chars (false) or escaped XML hexadecimal sequences (true)

See Also:

for rules for giving these parameters

Method Detail

setPublicSystemID

public void setPublicSystemID(String doctype,
                              String publicID,
                              String systemID)

Set the public and system ID of the written XML Document. You must be aware that XML constructs force you to have a systemID literal if you provide a publicID identifier, or the document header will not be valid.

Parameters:

doctype - the doctype

publicID - the publicID

systemID - the systemID

getPublicID

public String getPublicID()

Return the publicID.

Returns:

the publicID

getDoctype

public String getDoctype()

Return the doctype.

Returns:

the doctype

getSystemID

public String getSystemID()

Return the systemID.

Returns:

the systemID

flush

public void flush()
           throws IOException

Throws:

IOException

writeDocument

public void writeDocument(Document doc,
                          Writer writer)
                   throws IOException,
                          XmlWriterIOException

Throws:

IOException

XmlWriterIOException

writeXml

public void writeXml(Node node,
                     Writer writer)
              throws XmlWriterIOException

Throws:

XmlWriterIOException