/*--  Copyright (C) 2000 Brett McLaughlin & Jason Hunter. All rights reserved.  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:  1. Redistributions of source code must retain the above copyright    notice, this list of conditions, and the following disclaimer.  2. Redistributions in binary form must reproduce the above copyright    notice, this list of conditions, and the disclaimer that follows     these conditions in the documentation and/or other materials     provided with the distribution. 3. The name "JDOM" must not be used to endorse or promote products    derived from this software without prior written permission.  For    written permission, please contact license@jdom.org.  4. Products derived from this software may not be called "JDOM", nor    may "JDOM" appear in their name, without prior written permission    from the JDOM Project Management (pm@jdom.org).  In addition, we request (but do not require) that you include in the  end-user documentation provided with the redistribution and/or in the  software itself an acknowledgement equivalent to the following:     "This product includes software developed by the      JDOM Project (http://www.jdom.org/)." Alternatively, the acknowledgment may be graphical using the logos  available at http://www.jdom.org/images/logos. THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE JDOM AUTHORS OR THE PROJECT CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This software consists of voluntary contributions made by many  individuals on behalf of the JDOM Project and was originally  created by Brett McLaughlin <brett@jdom.org> and  Jason Hunter <jhunter@jdom.org>.  For more information on the  JDOM Project, please see <http://www.jdom.org/>.  */package sax;import java.io.IOException;import java.io.OutputStreamWriter;import java.io.Writer;import java.util.Enumeration;import java.util.HashMap;import java.util.Iterator;import java.util.Map;import org.xml.sax.Attributes;import org.xml.sax.InputSource;import org.xml.sax.SAXException;import org.xml.sax.XMLReader;import org.xml.sax.helpers.NamespaceSupport;/** * Filter to write an XML document from a SAX event stream. * * <i>Code and comments adapted from XMLWriter-0.2, written * by David Megginson and released into the public domain, * without warranty.</i> * * <p>This class can be used by itself or as part of a SAX event * stream: it takes as input a series of SAX2 ContentHandler * events and uses the information in those events to write * an XML document.  Since this class is a filter, it can also * pass the events on down a filter chain for further processing * (you can use the XMLWriter to take a snapshot of the current * state at any point in a filter chain), and it can be * used directly as a ContentHandler for a SAX2 XMLReader.</p> * * <p>The client creates a document by invoking the methods for * standard SAX2 events, always beginning with the * {@link #startDocument startDocument} method and ending with * the {@link #endDocument endDocument} method.</p> * * <p>The following code will send a simple XML document to * standard output:</p> * * <pre> * XMLWriter w = new XMLWriter(); * * w.startDocument(); * w.dataElement("greeting", "Hello, world!"); * w.endDocument(); * </pre> * * <p>The resulting document will look like this:</p> * * <pre> * &lt;?xml version="1.0"?> * * &lt;greeting>Hello, world!&lt;/greeting> * </pre> * * <h2>Whitespace</h2> * * <p>According to the XML Recommendation, <em>all</em> whitespace * in an XML document is potentially significant to an application, * so this class never adds newlines or indentation.  If you * insert three elements in a row, as in</p> * * <pre> * w.dataElement("item", "1"); * w.dataElement("item", "2"); * w.dataElement("item", "3"); * </pre> * * <p>you will end up with</p> * * <pre> * &lt;item>1&lt;/item>&lt;item>3&lt;/item>&lt;item>3&lt;/item> * </pre> * * <p>You need to invoke one of the <var>characters</var> methods * explicitly to add newlines or indentation.  Alternatively, you * can use {@link samples.sax.DataFormatFilter DataFormatFilter} * add linebreaks and indentation (but does not support mixed content * properly).</p> * * * <h2>Namespace Support</h2> * * <p>The writer contains extensive support for XML Namespaces, so that * a client application does not have to keep track of prefixes and * supply <var>xmlns</var> attributes.  By default, the XML writer will * generate Namespace declarations in the form _NS1, _NS2, etc., wherever * they are needed, as in the following example:</p> * * <pre> * w.startDocument(); * w.emptyElement("http://www.foo.com/ns/", "foo"); * w.endDocument(); * </pre> * * <p>The resulting document will look like this:</p> * * <pre> * &lt;?xml version="1.0"?> * * &lt;_NS1:foo xmlns:_NS1="http://www.foo.com/ns/"/> * </pre> * * <p>In many cases, document authors will prefer to choose their * own prefixes rather than using the (ugly) default names.  The * XML writer allows two methods for selecting prefixes:</p> * * <ol> * <li>the qualified name</li> * <li>the {@link #setPrefix setPrefix} method.</li> * </ol> * * <p>Whenever the XML writer finds a new Namespace URI, it checks * to see if a qualified (prefixed) name is also available; if so * it attempts to use the name's prefix (as long as the prefix is * not already in use for another Namespace URI).</p> * * <p>Before writing a document, the client can also pre-map a prefix * to a Namespace URI with the setPrefix method:</p> * * <pre> * w.setPrefix("http://www.foo.com/ns/", "foo"); * w.startDocument(); * w.emptyElement("http://www.foo.com/ns/", "foo"); * w.endDocument(); * </pre> * * <p>The resulting document will look like this:</p> * * <pre> * &lt;?xml version="1.0"?> * * &lt;foo:foo xmlns:foo="http://www.foo.com/ns/"/> * </pre> * * <p>The default Namespace simply uses an empty string as the prefix:</p> * * <pre> * w.setPrefix("http://www.foo.com/ns/", ""); * w.startDocument(); * w.emptyElement("http://www.foo.com/ns/", "foo"); * w.endDocument(); * </pre> * * <p>The resulting document will look like this:</p> * * <pre> * &lt;?xml version="1.0"?> * * &lt;foo xmlns="http://www.foo.com/ns/"/> * </pre> * * <p>By default, the XML writer will not declare a Namespace until * it is actually used.  Sometimes, this approach will create * a large number of Namespace declarations, as in the following * example:</p> * * <pre> * &lt;xml version="1.0"?> * * &lt;rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"> *  &lt;rdf:Description about="http://www.foo.com/ids/books/12345"> *   &lt;dc:title xmlns:dc="http://www.purl.org/dc/">A Dark Night&lt;/dc:title> *   &lt;dc:creator xmlns:dc="http://www.purl.org/dc/">Jane Smith&lt;/dc:title> *   &lt;dc:date xmlns:dc="http://www.purl.org/dc/">2000-09-09&lt;/dc:title> *  &lt;/rdf:Description> * &lt;/rdf:RDF> * </pre> * * <p>The "rdf" prefix is declared only once, because the RDF Namespace * is used by the root element and can be inherited by all of its * descendants; the "dc" prefix, on the other hand, is declared three * times, because no higher element uses the Namespace.  To solve this * problem, you can instruct the XML writer to predeclare Namespaces * on the root element even if they are not used there:</p> * * <pre> * w.forceNSDecl("http://www.purl.org/dc/"); * </pre> * * <p>Now, the "dc" prefix will be declared on the root element even * though it's not needed there, and can be inherited by its * descendants:</p> * * <pre> * &lt;xml version="1.0"?> * * &lt;rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" *             xmlns:dc="http://www.purl.org/dc/"> *  &lt;rdf:Description about="http://www.foo.com/ids/books/12345"> *   &lt;dc:title>A Dark Night&lt;/dc:title> *   &lt;dc:creator>Jane Smith&lt;/dc:title> *   &lt;dc:date>2000-09-09&lt;/dc:title> *  &lt;/rdf:Description> * &lt;/rdf:RDF> * </pre> * * <p>This approach is also useful for declaring Namespace prefixes * that be used by qualified names appearing in attribute values or * character data.</p> * * @see XMLFilterBase */public class XMLWriter extends XMLFilterBase{    ////////////////////////////////////////////////////////////////////    // Constructors.    ////////////////////////////////////////////////////////////////////    /**     * Create a new XML writer.     *     * <p>Write to standard output.</p>     */    public XMLWriter()    {        init(null);    }    /**     * Create a new XML writer.     *     * <p>Write to the writer provided.</p>     *     * @param writer The output destination, or null to use standard     *        output.     */    public XMLWriter(Writer writer)    {        init(writer);    }    /**     * Create a new XML writer.     *     * <p>Use the specified XML reader as the parent.</p>     *     * @param xmlreader The parent in the filter chain, or null     *        for no parent.     */    public XMLWriter(XMLReader xmlreader)    {        super(xmlreader);        init(null);    }    /**     * Create a new XML writer.     *     * <p>Use the specified XML reader as the parent, and write     * to the specified writer.</p>     *     * @param xmlreader The parent in the filter chain, or null     *        for no parent.     * @param writer The output destination, or null to use standard     *        output.     */    public XMLWriter(XMLReader xmlreader, Writer writer)    {        super(xmlreader);        init(writer);    }    /**     * Internal initialization method.     *     * <p>All of the public constructors invoke this method.     *     * @param writer The output destination, or null to use     *        standard output.     */    private void init (Writer writer)    {        setOutput(writer);        nsSupport = new NamespaceSupport();        prefixTable = new HashMap();        forcedDeclTable = new HashMap();        doneDeclTable = new HashMap();    }    ////////////////////////////////////////////////////////////////////    // Public methods.    ////////////////////////////////////////////////////////////////////    /**     * Reset the writer.     *     * <p>This method is especially useful if the writer throws an     * exception before it is finished, and you want to reuse the     * writer for a new document.  It is usually a good idea to     * invoke {@link #flush flush} before resetting the writer,     * to make sure that no output is lost.</p>     *     * <p>This method is invoked automatically by the     * {@link #startDocument startDocument} method before writing     * a new document.</p>     *     * <p><strong>Note:</strong> this method will <em>not</em>     * clear the prefix or URI information in the writer or     * the selected output writer.</p>     *     * @see #flush     */    public void reset ()    {        openElement = false;        elementLevel = 0;        prefixCounter = 0;        nsSupport.reset();        inDTD = false;    }    /**     * Flush the output.     *     * <p>This method flushes the output stream.  It is especially useful     * when you need to make certain that the entire document has     * been written to output but do not want to close the output     * stream.</p>     *