org.apache.ws.commons.schema.docpath

Class XmlSchemaPathFinder<U,V>

java.lang.Object

org.xml.sax.helpers.DefaultHandler

org.apache.ws.commons.schema.docpath.XmlSchemaPathFinder<U,V>

All Implemented Interfaces:

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

public final class XmlSchemaPathFinder<U,V>
extends org.xml.sax.helpers.DefaultHandler

Performs a SAX-based walk through the XML document, determining the interpretation ("path") that best matches the XML Schema.

This is a traditional DefaultHandler that can be attached to either a SAXParser during a parse, or to SaxWalkerOverDom to find paths through an Document.

Because this is a SAX-based walk, the source information need not be an XML document. It can be any data that can be interpreted via a SAX walk. This can be helpful when trying to confirm the source data can be converted back into XML.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	XmlSchemaPathFinder.DecisionPoint<U,V>
private static class	XmlSchemaPathFinder.Fulfillment
private static class	XmlSchemaPathFinder.PathSegment<U,V>
private static class	XmlSchemaPathFinder.TraversedElement

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.ArrayList<javax.xml.namespace.QName>	anyStack
private XmlSchemaPathNode<U,V>	currentPath
private java.util.ArrayList<XmlSchemaPathFinder.DecisionPoint<U,V>>	decisionPoints
private java.util.ArrayList<javax.xml.namespace.QName>	elementStack
private static int	MAX_DEPTH
private XmlSchemaNamespaceContext	nsContext
private XmlSchemaPathManager<U,V>	pathMgr
private XmlSchemaPathNode<U,V>	rootPathNode
private java.util.ArrayList<XmlSchemaPathFinder.TraversedElement>	traversedElements

Constructor Summary

Constructors

Constructor and Description
XmlSchemaPathFinder(XmlSchemaStateMachineNode root) Creates a new XmlToAvroPathCreator with the root XmlSchemaStateMachineNode to start from when evaluating documents.

Method Summary

Modifier and Type	Method and Description
void	characters(char[] ch, int start, int length) Adds a new XmlSchemaPathNode.Direction.CONTENT XmlSchemaPathNode to the path.
void	endDocument() Called when the XML Document traversal is complete.
void	endElement(java.lang.String uri, java.lang.String localName, java.lang.String qName) Ends the current element.
void	endPrefixMapping(java.lang.String prefix) Handles the end of a prefix mapping in the SAX walk.
private java.util.List<XmlSchemaPathFinder.PathSegment<U,V>>	find(XmlSchemaPathNode<U,V> startNode, javax.xml.namespace.QName elemQName)
private java.util.List<XmlSchemaPathFinder.PathSegment<U,V>>	find(XmlSchemaPathNode<U,V> startNode, javax.xml.namespace.QName elemQName, int currDepth)
private java.util.List<XmlSchemaPathFinder.PathSegment<U,V>>	find(XmlSchemaPathNode<U,V> startNode, javax.xml.namespace.QName elemQName, XmlSchemaStateMachineNode doNotFollow)
private void	followPath(XmlSchemaPathFinder.PathSegment<U,V> path)
private java.lang.String	getElementsTraversedAsString()
private java.lang.String	getLeafNodeName(XmlSchemaStateMachineNode node)
private XmlSchemaStateMachineNode	getStateMachineOfOwningElement()
XmlSchemaPathNode<U,V>	getXmlSchemaTraversal() Once a traversal completes successfully, this method may be called to retrieve the relevant interpretation of the path through the XmlSchemaStateMachineNodes.
private static <U,V> XmlSchemaPathFinder.Fulfillment	isPositionFulfilled(XmlSchemaPathNode<U,V> currentPath, java.util.List<java.lang.Integer> possiblePaths)
void	startDocument() Kick-starts a new SAX walk, building new XmlSchemaPathNode and XmlSchemaDocumentNode traversals in the process.
void	startElement(java.lang.String uri, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes atts) Find the path through the XML Schema that best matches this element, traversing any relevant groups, and backtracking if necessary.
void	startPrefixMapping(java.lang.String prefix, java.lang.String uri) Handles a new prefix mapping in the SAX walk.
private void	validateAttributes(org.xml.sax.Attributes attrs)
private void	verifyCurrentPositionIsAtElement(java.lang.String errMsgPrefix)
private void	walkUpToElement(javax.xml.namespace.QName element)
private void	walkUpTree(javax.xml.namespace.QName currElem)

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

MAX_DEPTH

private static final int MAX_DEPTH

See Also:

Constant Field Values

nsContext

private final XmlSchemaNamespaceContext nsContext

rootPathNode

private XmlSchemaPathNode<U,V> rootPathNode

currentPath

private XmlSchemaPathNode<U,V> currentPath

traversedElements

private java.util.ArrayList<XmlSchemaPathFinder.TraversedElement> traversedElements

decisionPoints

private java.util.ArrayList<XmlSchemaPathFinder.DecisionPoint<U,V>> decisionPoints

elementStack

private java.util.ArrayList<javax.xml.namespace.QName> elementStack

anyStack

private java.util.ArrayList<javax.xml.namespace.QName> anyStack

pathMgr

private XmlSchemaPathManager<U,V> pathMgr

Constructor Detail

XmlSchemaPathFinder

public XmlSchemaPathFinder(XmlSchemaStateMachineNode root)

Creates a new XmlToAvroPathCreator with the root XmlSchemaStateMachineNode to start from when evaluating documents.

Method Detail

startDocument

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

Kick-starts a new SAX walk, building new XmlSchemaPathNode and XmlSchemaDocumentNode traversals in the process.

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

Handles a new prefix mapping in the SAX walk.

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

Handles the end of a prefix mapping in the SAX walk.

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

Find the path through the XML Schema that best matches this element, traversing any relevant groups, and backtracking if necessary.

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 a new XmlSchemaPathNode.Direction.CONTENT XmlSchemaPathNode to the path. Throws an IllegalStateException if the owning element should not receive content, or the content is empty when it should not be.

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

Ends the current element. If the current element is not of the provided uri and localName, throws an IllegalStateException.

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

Called when the XML Document traversal is complete.

Confirms all open elements have been closed. If not, throws an IllegalStateException.

Specified by:

endDocument in interface org.xml.sax.ContentHandler

Overrides:

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

Throws:

org.xml.sax.SAXException

getXmlSchemaTraversal

public XmlSchemaPathNode<U,V> getXmlSchemaTraversal()

Once a traversal completes successfully, this method may be called to retrieve the relevant interpretation of the path through the XmlSchemaStateMachineNodes.

XmlSchemaPathNode.getDocumentNode() can be called to retrieve the interpretation of the XML Schema as applied to the document; meanwhile the walk through XmlSchemaPathNodes will show how that schema was traversed.

isPositionFulfilled

private static <U,V> XmlSchemaPathFinder.Fulfillment isPositionFulfilled(XmlSchemaPathNode<U,V> currentPath,
                                                                         java.util.List<java.lang.Integer> possiblePaths)

find

private java.util.List<XmlSchemaPathFinder.PathSegment<U,V>> find(XmlSchemaPathNode<U,V> startNode,
                                                                  javax.xml.namespace.QName elemQName)

find

private java.util.List<XmlSchemaPathFinder.PathSegment<U,V>> find(XmlSchemaPathNode<U,V> startNode,
                                                                  javax.xml.namespace.QName elemQName,
                                                                  XmlSchemaStateMachineNode doNotFollow)

find

private java.util.List<XmlSchemaPathFinder.PathSegment<U,V>> find(XmlSchemaPathNode<U,V> startNode,
                                                                  javax.xml.namespace.QName elemQName,
                                                                  int currDepth)

walkUpTree

private void walkUpTree(javax.xml.namespace.QName currElem)

walkUpToElement

private void walkUpToElement(javax.xml.namespace.QName element)

followPath

private void followPath(XmlSchemaPathFinder.PathSegment<U,V> path)

getElementsTraversedAsString

private java.lang.String getElementsTraversedAsString()

verifyCurrentPositionIsAtElement

private void verifyCurrentPositionIsAtElement(java.lang.String errMsgPrefix)

getLeafNodeName

private java.lang.String getLeafNodeName(XmlSchemaStateMachineNode node)

getStateMachineOfOwningElement

private XmlSchemaStateMachineNode getStateMachineOfOwningElement()

validateAttributes

private void validateAttributes(org.xml.sax.Attributes attrs)