org.apache.ws.commons.schema.walker

Class XmlSchemaWalker

java.lang.Object

org.apache.ws.commons.schema.walker.XmlSchemaWalker

public final class XmlSchemaWalker
extends java.lang.Object

Walks an XmlSchema from a starting XmlSchemaElement, notifying attached visitors as it descends.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Map<javax.xml.namespace.QName,java.util.List<XmlSchemaElement>>	elemsBySubstGroup
private XmlSchemaCollection	schemas
private java.util.Map<java.lang.String,XmlSchema>	schemasByNamespace
private java.util.Map<javax.xml.namespace.QName,XmlSchemaScope>	scopeCache
private java.util.Set<javax.xml.namespace.QName>	userRecognizedTypes
private java.util.Set<javax.xml.namespace.QName>	visitedElements
private java.util.ArrayList<XmlSchemaVisitor>	visitors

Constructor Summary

Constructors

Constructor and Description
XmlSchemaWalker(XmlSchemaCollection xmlSchemas) Initializes the XmlSchemaWalker with the XmlSchemaCollection to reference when following an XmlSchemaElement.
XmlSchemaWalker(XmlSchemaCollection xmlSchemas, XmlSchemaVisitor visitor) Initializes the XmlSchemaWalker with an XmlSchemaVisitor to notify as the schema is walked.

Method Summary

Modifier and Type	Method and Description
XmlSchemaWalker	addVisitor(XmlSchemaVisitor visitor) Adds a new visitor to be notified as the XML Schemas are walked.
void	clear() Clears the internal state in preparation for another walk through the schema.
private XmlSchemaElement	getElement(XmlSchemaElement element, boolean isSubstitutionGroup) If the provided XmlSchemaElement is a reference, track down the original and add the minimum and maximum occurrence fields.
private static javax.xml.namespace.QName	getElementQName(XmlSchemaElement element)
java.util.Set<javax.xml.namespace.QName>	getUserRecognizedTypes() The user-defined types set with the call to setUserRecognizedTypes(Set), or null if none.
XmlSchemaWalker	removeVisitor(XmlSchemaVisitor visitor) Removes the visitor to be notified as the XML Schemas are walked.
void	setUserRecognizedTypes(java.util.Set<javax.xml.namespace.QName> userRecognizedTypes) Defines the set of types the calling code recognizes.
void	walk(XmlSchemaElement element) Initiates a walk through the XmlSchemaCollection starting with the provided root XmlSchemaElement.
private void	walk(XmlSchemaGroupParticle group, long minOccurs, long maxOccurs)
private void	walk(XmlSchemaParticle particle)

Methods inherited from class java.lang.Object

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

Field Detail

userRecognizedTypes

private java.util.Set<javax.xml.namespace.QName> userRecognizedTypes

schemas

private final XmlSchemaCollection schemas

visitors

private final java.util.ArrayList<XmlSchemaVisitor> visitors

elemsBySubstGroup

private final java.util.Map<javax.xml.namespace.QName,java.util.List<XmlSchemaElement>> elemsBySubstGroup

schemasByNamespace

private final java.util.Map<java.lang.String,XmlSchema> schemasByNamespace

scopeCache

private final java.util.Map<javax.xml.namespace.QName,XmlSchemaScope> scopeCache

visitedElements

private final java.util.Set<javax.xml.namespace.QName> visitedElements

Constructor Detail

XmlSchemaWalker

public XmlSchemaWalker(XmlSchemaCollection xmlSchemas)

Initializes the XmlSchemaWalker with the XmlSchemaCollection to reference when following an XmlSchemaElement.

XmlSchemaWalker

public XmlSchemaWalker(XmlSchemaCollection xmlSchemas,
                       XmlSchemaVisitor visitor)

Initializes the XmlSchemaWalker with an XmlSchemaVisitor to notify as the schema is walked.

(Other visitors may continue to be added after this one.)

Parameters:

xmlSchemas - The set of schemas to walk.

visitor - The visitor to visit during the walk.

Method Detail

addVisitor

public XmlSchemaWalker addVisitor(XmlSchemaVisitor visitor)

Adds a new visitor to be notified as the XML Schemas are walked.

Parameters:

visitor - The visitor to be notified.

Returns:

This XmlSchemaWalker instance for method chaining.

removeVisitor

public XmlSchemaWalker removeVisitor(XmlSchemaVisitor visitor)

Removes the visitor to be notified as the XML Schemas are walked.

Parameters:

visitor - The visitor to remove.

Returns:

This XmlSchemaWalker instance for method chaining.

clear

public void clear()

Clears the internal state in preparation for another walk through the schema.

setUserRecognizedTypes

public void setUserRecognizedTypes(java.util.Set<javax.xml.namespace.QName> userRecognizedTypes)

Defines the set of types the calling code recognizes. If one of the types are found during the walk through the XML Schema, it is attached to the relevant XmlSchemaTypeInfo that is passed to the XmlSchemaVisitors, with lower types in the hierarchy taking precedence over higher types.

This information is useful when translating from XML Schema to another schema, as this automatically associates the destination type with the source XML Schema type.

Parameters:

userRecognizedTypes - The set of types the user recognizes and would like recognized when traversed.

getUserRecognizedTypes

public java.util.Set<javax.xml.namespace.QName> getUserRecognizedTypes()

The user-defined types set with the call to setUserRecognizedTypes(Set), or null if none.

walk

public void walk(XmlSchemaElement element)

Initiates a walk through the XmlSchemaCollection starting with the provided root XmlSchemaElement. Any visitors will be notified as the walk progresses.

Once this method completes, call clear() before starting another walk through the XML Schemas.

Parameters:

element - The root element to start the walk from.

walk

private void walk(XmlSchemaParticle particle)

walk

private void walk(XmlSchemaGroupParticle group,
                  long minOccurs,
                  long maxOccurs)

getElement

private XmlSchemaElement getElement(XmlSchemaElement element,
                                    boolean isSubstitutionGroup)

If the provided XmlSchemaElement is a reference, track down the original and add the minimum and maximum occurrence fields. Otherwise, just return the provided element.

Parameters:

element - The element to get the definition of.

Returns:

The real XmlSchemaElement.

getElementQName

private static javax.xml.namespace.QName getElementQName(XmlSchemaElement element)