Save This Page
Home » openjdk-7 » com.sun.xml.internal » txw2 » output » [javadoc | source]
com.sun.xml.internal.txw2.output
public class: XMLWriter [javadoc | source]
java.lang.Object
   org.xml.sax.helpers.XMLFilterImpl
      com.sun.xml.internal.txw2.output.XMLWriter

All Implemented Interfaces:
    LexicalHandler, ContentHandler, DTDHandler, ErrorHandler, XMLFilter, EntityResolver

Direct Known Subclasses:
    DataWriter

Filter to write an XML document from a SAX event stream.

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.

The client creates a document by invoking the methods for standard SAX2 events, always beginning with the startDocument method and ending with the endDocument method. There are convenience methods provided so that clients to not have to create empty attribute lists or provide empty strings as parameters; for example, the method invocation

w.startElement("foo");

is equivalent to the regular SAX2 ContentHandler method

w.startElement("", "foo", "", new AttributesImpl());

Except that it is more efficient because it does not allocate a new empty attribute list each time. The following code will send a simple XML document to standard output:

XMLWriter w = new XMLWriter();

w.startDocument();
w.startElement("greeting");
w.characters("Hello, world!");
w.endElement("greeting");
w.endDocument();

The resulting document will look like this:

<?xml version="1.0" standalone="yes"?>

<greeting>Hello, world!</greeting>

In fact, there is an even simpler convenience method, dataElement, designed for writing elements that contain only character data, so the code to generate the document could be shortened to

XMLWriter w = new XMLWriter();

w.startDocument();
w.dataElement("greeting", "Hello, world!");
w.endDocument();

Whitespace

According to the XML Recommendation, all 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

w.dataElement("item", "1");
w.dataElement("item", "2");
w.dataElement("item", "3");

you will end up with

<item>1</item><item>3</item><item>3</item>

You need to invoke one of the characters methods explicitly to add newlines or indentation. Alternatively, you can use DataWriter , which is derived from this class -- it is optimized for writing purely data-oriented (or field-oriented) XML, and does automatic linebreaks and indentation (but does not support mixed content properly).

Namespace Support

The writer contains extensive support for XML Namespaces, so that a client application does not have to keep track of prefixes and supply xmlns 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:

w.startDocument();
w.emptyElement("http://www.foo.com/ns/", "foo");
w.endDocument();

The resulting document will look like this:

<?xml version="1.0" standalone="yes"?>

<_NS1:foo xmlns:_NS1="http://www.foo.com/ns/"/>

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:

  1. the qualified name
  2. the setPrefix method.

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).

Before writing a document, the client can also pre-map a prefix to a Namespace URI with the setPrefix method:

w.setPrefix("http://www.foo.com/ns/", "foo");
w.startDocument();
w.emptyElement("http://www.foo.com/ns/", "foo");
w.endDocument();

The resulting document will look like this:

<?xml version="1.0" standalone="yes"?>

<foo:foo xmlns:foo="http://www.foo.com/ns/"/>

The default Namespace simply uses an empty string as the prefix:

w.setPrefix("http://www.foo.com/ns/", "");
w.startDocument();
w.emptyElement("http://www.foo.com/ns/", "foo");
w.endDocument();

The resulting document will look like this:

<?xml version="1.0" standalone="yes"?>

<foo xmlns="http://www.foo.com/ns/"/>

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:

<xml version="1.0" standalone="yes"?>

<rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
<rdf:Description about="http://www.foo.com/ids/books/12345">
<dc:title xmlns:dc="http://www.purl.org/dc/">A Dark Night</dc:title>
<dc:creator xmlns:dc="http://www.purl.org/dc/">Jane Smith</dc:title>
<dc:date xmlns:dc="http://www.purl.org/dc/">2000-09-09</dc:title>
</rdf:Description>
</rdf:RDF>

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:

w.forceNSDecl("http://www.purl.org/dc/");

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:

<xml version="1.0" standalone="yes"?>

<rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:dc="http://www.purl.org/dc/">
<rdf:Description about="http://www.foo.com/ids/books/12345">
<dc:title>A Dark Night</dc:title>
<dc:creator>Jane Smith</dc:title>
<dc:date>2000-09-09</dc:title>
</rdf:Description>
</rdf:RDF>

This approach is also useful for declaring Namespace prefixes that be used by qualified names appearing in attribute values or character data.

Constructor:
 public XMLWriter(Writer writer,
    String encoding) 
 public XMLWriter(Writer writer,
    String encoding,
    CharacterEscapeHandler _escapeHandler) 
    Create a new XML writer.

    Write to the writer provided.

    Parameters:
    writer - The output destination, or null to use standard output.
    encoding - If non-null string is specified, it is written as a part of the XML declaration.
Method from com.sun.xml.internal.txw2.output.XMLWriter Summary:
characters,   characters,   comment,   dataElement,   dataElement,   dataElement,   endCDATA,   endDTD,   endDocument,   endElement,   endElement,   endElement,   endEntity,   flush,   ignorableWhitespace,   processingInstruction,   reset,   setEncoding,   setHeader,   setOutput,   setXmlDecl,   startCDATA,   startDTD,   startDocument,   startElement,   startElement,   startElement,   startEntity,   startPrefixMapping
Methods from org.xml.sax.helpers.XMLFilterImpl:
characters,   endDocument,   endElement,   endPrefixMapping,   error,   fatalError,   getContentHandler,   getDTDHandler,   getEntityResolver,   getErrorHandler,   getFeature,   getParent,   getProperty,   ignorableWhitespace,   notationDecl,   parse,   parse,   processingInstruction,   resolveEntity,   setContentHandler,   setDTDHandler,   setDocumentLocator,   setEntityResolver,   setErrorHandler,   setFeature,   setParent,   setProperty,   skippedEntity,   startDocument,   startElement,   startPrefixMapping,   unparsedEntityDecl,   warning
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from com.sun.xml.internal.txw2.output.XMLWriter Detail:
 public  void characters(String data) throws SAXException 
    Write a string of character data, with XML escaping.

    This is a convenience method that takes an XML String, converts it to a character array, then invokes #characters(char[], int, int) .

 public  void characters(char[] ch,
    int start,
    int len) throws SAXException 
    Write character data. Pass the event on down the filter chain for further processing.
 public  void comment(char[] ch,
    int start,
    int length) throws SAXException 
 public  void dataElement(String localName,
    String content) throws SAXException 
 public  void dataElement(String uri,
    String localName,
    String content) throws SAXException 
 public  void dataElement(String uri,
    String localName,
    String qName,
    Attributes atts,
    String content) throws SAXException 
 public  void endCDATA() throws SAXException 
 public  void endDTD() throws SAXException 
 public  void endDocument() throws SAXException 
    Write a newline at the end of the document. Pass the event on down the filter chain for further processing.
 public  void endElement(String localName) throws SAXException 
    End an element without a Namespace URI or qname.

    This method will supply an empty string for the qName and an empty string for the Namespace URI. It invokes #endElement(String, String, String) directly.

 public  void endElement(String uri,
    String localName) throws SAXException 
 public  void endElement(String uri,
    String localName,
    String qName) throws SAXException 
    Write an end tag. Pass the event on down the filter chain for further processing.
 public  void endEntity(String name) throws SAXException 
 public  void flush() throws IOException 
    Flush the output.

    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 _commit the output stream.

    This method is invoked automatically by the endDocument method after writing a document.

 public  void ignorableWhitespace(char[] ch,
    int start,
    int length) throws SAXException 
    Write ignorable whitespace. Pass the event on down the filter chain for further processing.
 public  void processingInstruction(String target,
    String data) throws SAXException 
    Write a processing instruction. Pass the event on down the filter chain for further processing.
 public  void reset() 
    Reset the writer.

    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 flush before resetting the writer, to make sure that no output is lost.

    This method is invoked automatically by the startDocument method before writing a new document.

    Note: this method will not clear the prefix or URI information in the writer or the selected output writer.

 public  void setEncoding(String encoding) 
 public  void setHeader(String _header) 
    Sets the header string. This string will be written right after the xml declaration without any escaping. Useful for generating a boiler-plate DOCTYPE decl, PIs, and comments.
 public  void setOutput(Writer writer,
    String _encoding) 
    Set a new output destination for the document.
 public  void setXmlDecl(boolean _writeXmlDecl) 
    Set whether the writer should print out the XML declaration (<?xml version='1.0' ... ?>).

    This option is set to true by default.

 public  void startCDATA() throws SAXException 
 public  void startDTD(String name,
    String publicId,
    String systemId) throws SAXException 
 public  void startDocument() throws SAXException 
    Write the XML declaration at the beginning of the document. Pass the event on down the filter chain for further processing.
 public  void startElement(String localName) throws SAXException 
    Start a new element without a qname, attributes or a Namespace URI.

    This method will provide an empty string for the Namespace URI, and empty string for the qualified name, and a default empty attribute list. It invokes #startElement(String, String, String, Attributes)} directly.

 public  void startElement(String uri,
    String localName) throws SAXException 
 public  void startElement(String uri,
    String localName,
    String qName,
    Attributes atts) throws SAXException 
    Write a start tag. Pass the event on down the filter chain for further processing.
 public  void startEntity(String name) throws SAXException 
 public  void startPrefixMapping(String prefix,
    String uri) throws SAXException