Class DomConsumer

This consumer builds a DOM Document from its input, acting either as a pipeline terminus or as an intermediate buffer. When a document's worth of events has been delivered to this consumer, that document is read with a DomParser and sent to the next consumer. It is also available as a read-once property.

The DOM tree is constructed as faithfully as possible. There are some complications since a DOM should expose behaviors that can't be implemented without API backdoors into that DOM, and because some SAX parsers don't report all the information that DOM permits to be exposed. The general problem areas involve information from the Document Type Declaration (DTD). DOM only represents a limited subset, but has some behaviors that depend on much deeper knowledge of a document's DTD. You shouldn't have much to worry about unless you change handling of "noise" nodes from its default setting (which ignores them all); note if you use JAXP to populate your DOM trees, it wants to save "noise" nodes by default. (Such nodes include ignorable whitespace, comments, entity references and CDATA boundaries.) Otherwise, your main worry will be if you use a SAX parser that doesn't flag ignorable whitespace unless it's validating (few don't).

The SAX2 events used as input must contain XML Names for elements and attributes, with original prefixes. In SAX2, this is optional unless the "namespace-prefixes" parser feature is set. Moreover, many application components won't provide completely correct structures anyway. Before you convert a DOM to an output document, you should plan to postprocess it to create or repair such namespace information. The NSFilter pipeline stage does such work.

Note: changes late in DOM L2 process made it impractical to attempt to create the DocumentType node in any implementation-neutral way, much less to populate it (L1 didn't support even creating such nodes). To create and populate such a node, subclass the inner DomConsumer.Handler class and teach it about the backdoors into whatever DOM implementation you want. It's possible that some revised DOM API (L3?) will make this problem solvable again.

public DomConsumer(Class impl)
            throws SAXException

public DomConsumer(Class impl,
                   EventConsumer n)
            throws SAXException

public final ContentHandler getContentHandler()

public final DTDHandler getDTDHandler()

public final Document getDocument()

public final Object getProperty(String id)
            throws SAXNotRecognizedException

public final boolean isHidingCDATA()

public final boolean isHidingComments()

public final boolean isHidingReferences()

public final boolean isHidingWhitespace()

public void setErrorHandler(ErrorHandler handler)

protected void setHandler(DomConsumer.Handler h)

public final void setHidingCDATA(boolean flag)

public final void setHidingComments(boolean flag)

public final void setHidingReferences(boolean flag)

public final void setHidingWhitespace(boolean flag)