org.apache.ws.commons.schema.docpath

Class DomBuilderFromSax

java.lang.Object

org.xml.sax.helpers.DefaultHandler

org.apache.ws.commons.schema.docpath.DomBuilderFromSax

All Implemented Interfaces:

org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler

public final class DomBuilderFromSax
extends org.xml.sax.helpers.DefaultHandler

Builds an XML Document from an XML Schema during a SAX walk.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.StringBuilder	content
private javax.xml.parsers.DocumentBuilder	docBuilder
private org.w3c.dom.Document	document
private java.util.Map<javax.xml.namespace.QName,XmlSchemaStateMachineNode>	elementsByQName
private java.util.ArrayList<org.w3c.dom.Element>	elementStack
private java.util.Set<java.lang.String>	globalNamespaces
private java.util.Map<java.lang.String,java.lang.String>	namespaceToLocationMapping
private java.util.List<java.lang.String>	newPrefixes
private XmlSchemaNamespaceContext	nsContext
private XmlSchemaCollection	schemas
private static java.lang.String	XSI_NIL
private static java.lang.String	XSI_NS
private static java.lang.String	XSI_SCHEMALOC

Constructor Summary

Constructors

Constructor and Description
DomBuilderFromSax(XmlSchemaCollection xmlSchemaCollection) Creates a new DocumentBuilderFromSax.

Method Summary

Modifier and Type	Method and Description
private void	addContentToCurrentElement(boolean isEnd)
private void	addNamespaceLocationMappings(org.w3c.dom.Element rootElement)
void	characters(char[] ch, int start, int length) Adds content to the current element.
void	endDocument()
void	endElement(java.lang.String uri, java.lang.String localName, java.lang.String qName) Closes the current element in the generated XML document.
void	endPrefixMapping(java.lang.String prefix)
org.w3c.dom.Document	getDocument() Retrieves the document constructed from the SAX walk.
java.util.Map<java.lang.String,java.lang.String>	getNamespaceToLocationMapping() Retrieves the XML Schema namespace -> location mapping set by the last call to setNamespaceToLocationMapping(Map).
java.util.Map<javax.xml.namespace.QName,XmlSchemaStateMachineNode>	getStateMachinesByQName() Retrieves the QName -> XmlSchemaStateMachineNode mapping defined by the call to setStateMachinesByQName(Map).
void	setNamespaceToLocationMapping(java.util.Map<java.lang.String,java.lang.String> nsToLocMapping) Sets the XML Schema namespace -> location mapping to use when defining the schemaLocation attribute in the generated XML document.
void	setStateMachinesByQName(java.util.Map<javax.xml.namespace.QName,XmlSchemaStateMachineNode> statesByQName) Sets the mapping of QNames to XmlSchemaStateMachineNodes.
void	startDocument()
void	startElement(java.lang.String uri, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes atts) Starts a new element in the generated XML document.
void	startPrefixMapping(java.lang.String prefix, java.lang.String uri)

Methods inherited from class org.xml.sax.helpers.DefaultHandler

error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, setDocumentLocator, skippedEntity, unparsedEntityDecl, warning

Methods inherited from class java.lang.Object

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

Field Detail

XSI_NS

private static final java.lang.String XSI_NS

See Also:

Constant Field Values

XSI_SCHEMALOC

private static final java.lang.String XSI_SCHEMALOC

See Also:

Constant Field Values

XSI_NIL

private static final java.lang.String XSI_NIL

See Also:

Constant Field Values

document

private org.w3c.dom.Document document

content

private java.lang.StringBuilder content

namespaceToLocationMapping

private java.util.Map<java.lang.String,java.lang.String> namespaceToLocationMapping

newPrefixes

private java.util.List<java.lang.String> newPrefixes

nsContext

private XmlSchemaNamespaceContext nsContext

elementsByQName

private java.util.Map<javax.xml.namespace.QName,XmlSchemaStateMachineNode> elementsByQName

elementStack

private final java.util.ArrayList<org.w3c.dom.Element> elementStack

docBuilder

private final javax.xml.parsers.DocumentBuilder docBuilder

schemas

private final XmlSchemaCollection schemas

globalNamespaces

private final java.util.Set<java.lang.String> globalNamespaces

Constructor Detail

DomBuilderFromSax

public DomBuilderFromSax(XmlSchemaCollection xmlSchemaCollection)
                  throws javax.xml.parsers.ParserConfigurationException

Creates a new DocumentBuilderFromSax.

Throws:

javax.xml.parsers.ParserConfigurationException - If unable to create a DocumentBuilder.

Method Detail

startDocument

public void startDocument()
                   throws org.xml.sax.SAXException

Specified by:

startDocument in interface org.xml.sax.ContentHandler

Overrides:

startDocument in class org.xml.sax.helpers.DefaultHandler

Throws:

org.xml.sax.SAXException

See Also:

DefaultHandler.startDocument()

startPrefixMapping

public void startPrefixMapping(java.lang.String prefix,
                               java.lang.String uri)
                        throws org.xml.sax.SAXException

Specified by:

startPrefixMapping in interface org.xml.sax.ContentHandler

Overrides:

startPrefixMapping in class org.xml.sax.helpers.DefaultHandler

Throws:

org.xml.sax.SAXException

See Also:

DefaultHandler.startPrefixMapping(String, String)

endPrefixMapping

public void endPrefixMapping(java.lang.String prefix)
                      throws org.xml.sax.SAXException

Specified by:

endPrefixMapping in interface org.xml.sax.ContentHandler

Overrides:

endPrefixMapping in class org.xml.sax.helpers.DefaultHandler

Throws:

org.xml.sax.SAXException

See Also:

DefaultHandler.endPrefixMapping(String)

startElement

public void startElement(java.lang.String uri,
                         java.lang.String localName,
                         java.lang.String qName,
                         org.xml.sax.Attributes atts)
                  throws org.xml.sax.SAXException

Starts a new element in the generated XML document. If the previous element was not closed, adds this element as a child to that element.

Specified by:

startElement in interface org.xml.sax.ContentHandler

Overrides:

startElement in class org.xml.sax.helpers.DefaultHandler

Throws:

org.xml.sax.SAXException

See Also:

DefaultHandler.startElement(String, String, String, Attributes)

characters

public void characters(char[] ch,
                       int start,
                       int length)
                throws org.xml.sax.SAXException

Adds content to the current element.

Specified by:

characters in interface org.xml.sax.ContentHandler

Overrides:

characters in class org.xml.sax.helpers.DefaultHandler

Throws:

org.xml.sax.SAXException

See Also:

DefaultHandler.characters(char[], int, int)

endElement

public void endElement(java.lang.String uri,
                       java.lang.String localName,
                       java.lang.String qName)
                throws org.xml.sax.SAXException

Closes the current element in the generated XML document.

Specified by:

endElement in interface org.xml.sax.ContentHandler

Overrides:

endElement in class org.xml.sax.helpers.DefaultHandler

Throws:

org.xml.sax.SAXException

See Also:

DefaultHandler.endElement(String, String, String)

endDocument

public void endDocument()
                 throws org.xml.sax.SAXException

Specified by:

endDocument in interface org.xml.sax.ContentHandler

Overrides:

endDocument in class org.xml.sax.helpers.DefaultHandler

Throws:

org.xml.sax.SAXException

See Also:

DefaultHandler.endDocument()

addContentToCurrentElement

private void addContentToCurrentElement(boolean isEnd)

getDocument

public org.w3c.dom.Document getDocument()

Retrieves the document constructed from the SAX walk.

getNamespaceToLocationMapping

public java.util.Map<java.lang.String,java.lang.String> getNamespaceToLocationMapping()

Retrieves the XML Schema namespace -> location mapping set by the last call to setNamespaceToLocationMapping(Map).

setNamespaceToLocationMapping

public void setNamespaceToLocationMapping(java.util.Map<java.lang.String,java.lang.String> nsToLocMapping)

Sets the XML Schema namespace -> location mapping to use when defining the schemaLocation attribute in the generated XML document.

Parameters:

nsToLocMapping - The namespace -> location mapping.

getStateMachinesByQName

public java.util.Map<javax.xml.namespace.QName,XmlSchemaStateMachineNode> getStateMachinesByQName()

Retrieves the QName -> XmlSchemaStateMachineNode mapping defined by the call to setStateMachinesByQName(Map).

setStateMachinesByQName

public void setStateMachinesByQName(java.util.Map<javax.xml.namespace.QName,XmlSchemaStateMachineNode> statesByQName)

Sets the mapping of QNames to XmlSchemaStateMachineNodes. This is used to disambiguate:

• Whether empty content indicates nil
• If an element's attribute requires a namespace

Parameters:

statesByQName - The state-machine-node-by-QName mapping.

addNamespaceLocationMappings

private void addNamespaceLocationMappings(org.w3c.dom.Element rootElement)