org.apache.axiom.om.impl.serialize
Class OMXMLReader

java.lang.Object
  org.apache.axiom.om.impl.serialize.OMXMLReader

All Implemented Interfaces:

org.xml.sax.XMLReader

public class OMXMLReader
extends java.lang.Object
implements org.xml.sax.XMLReader

SAX XMLReader implementation that traverses a given OM tree and invokes the callback methods on the configured ContentHandler. This can be used to serialize an Axiom tree to SAX.

Note that this class doesn't support serializing OMDocType nodes. They will be silently skipped.

This class can also generate SAX events for a subtree. This is the case if the element passed to the constructor is not the root element of the document. In this case, care is taken to properly generate startPrefixMapping and endPrefixMapping events also for namespace mappings declared on the ancestors of the element.

To understand why this is important, consider the following example:

<root xmlns:ns="urn:ns"><element attr="ns:someThing"/><root>

In that case, to correctly interpret the attribute value, the SAX content handler must be aware of the namespace mapping for the ns prefix, even if the serialization starts only at the child element.

Nested Class Summary

protected static class

OMXMLReader.AttributesAdapter

Constructor Summary

OMXMLReader(OMElement element)

Method Summary

org.xml.sax.ContentHandler	getContentHandler()
org.xml.sax.DTDHandler	getDTDHandler()
org.xml.sax.EntityResolver	getEntityResolver()
org.xml.sax.ErrorHandler	getErrorHandler()
boolean	getFeature(java.lang.String name)
java.lang.Object	getProperty(java.lang.String name)
void	parse(org.xml.sax.InputSource input)
void	parse(java.lang.String systemId)
void	setContentHandler(org.xml.sax.ContentHandler contentHandler)
void	setDTDHandler(org.xml.sax.DTDHandler dtdHandler)
void	setEntityResolver(org.xml.sax.EntityResolver entityResolver)
void	setErrorHandler(org.xml.sax.ErrorHandler errorHandler)
void	setFeature(java.lang.String name, boolean value)
void	setProperty(java.lang.String name, java.lang.Object value)

Methods inherited from class java.lang.Object

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

Constructor Detail

OMXMLReader

public OMXMLReader(OMElement element)

Method Detail

getContentHandler

public org.xml.sax.ContentHandler getContentHandler()

Specified by:

getContentHandler in interface org.xml.sax.XMLReader

setContentHandler

public void setContentHandler(org.xml.sax.ContentHandler contentHandler)

Specified by:

setContentHandler in interface org.xml.sax.XMLReader

getDTDHandler

public org.xml.sax.DTDHandler getDTDHandler()

Specified by:

getDTDHandler in interface org.xml.sax.XMLReader

setDTDHandler

public void setDTDHandler(org.xml.sax.DTDHandler dtdHandler)

Specified by:

setDTDHandler in interface org.xml.sax.XMLReader

getEntityResolver

public org.xml.sax.EntityResolver getEntityResolver()

Specified by:

getEntityResolver in interface org.xml.sax.XMLReader

setEntityResolver

public void setEntityResolver(org.xml.sax.EntityResolver entityResolver)

Specified by:

setEntityResolver in interface org.xml.sax.XMLReader

getErrorHandler

public org.xml.sax.ErrorHandler getErrorHandler()

Specified by:

getErrorHandler in interface org.xml.sax.XMLReader

setErrorHandler

public void setErrorHandler(org.xml.sax.ErrorHandler errorHandler)

Specified by:

setErrorHandler in interface org.xml.sax.XMLReader

getFeature

public boolean getFeature(java.lang.String name)
                   throws org.xml.sax.SAXNotRecognizedException,
                          org.xml.sax.SAXNotSupportedException

Specified by:

getFeature in interface org.xml.sax.XMLReader

Throws:

org.xml.sax.SAXNotRecognizedException

org.xml.sax.SAXNotSupportedException

setFeature

public void setFeature(java.lang.String name,
                       boolean value)
                throws org.xml.sax.SAXNotRecognizedException,
                       org.xml.sax.SAXNotSupportedException

Specified by:

setFeature in interface org.xml.sax.XMLReader

Throws:

org.xml.sax.SAXNotRecognizedException

org.xml.sax.SAXNotSupportedException

getProperty

public java.lang.Object getProperty(java.lang.String name)
                             throws org.xml.sax.SAXNotRecognizedException,
                                    org.xml.sax.SAXNotSupportedException

Specified by:

getProperty in interface org.xml.sax.XMLReader

Throws:

org.xml.sax.SAXNotRecognizedException

org.xml.sax.SAXNotSupportedException

setProperty

public void setProperty(java.lang.String name,
                        java.lang.Object value)
                 throws org.xml.sax.SAXNotRecognizedException,
                        org.xml.sax.SAXNotSupportedException

Specified by:

setProperty in interface org.xml.sax.XMLReader

Throws:

org.xml.sax.SAXNotRecognizedException

org.xml.sax.SAXNotSupportedException

parse

public void parse(org.xml.sax.InputSource input)
           throws java.io.IOException,
                  org.xml.sax.SAXException

Specified by:

parse in interface org.xml.sax.XMLReader

Throws:

java.io.IOException

org.xml.sax.SAXException

parse

public void parse(java.lang.String systemId)
           throws java.io.IOException,
                  org.xml.sax.SAXException

Specified by:

parse in interface org.xml.sax.XMLReader

Throws:

java.io.IOException

org.xml.sax.SAXException