public interface XmlSchemaVisitor
XmlSchema
using the
XmlSchemaWalker
.
Use this interface in conjunction with XmlSchemaWalker
to
receive events as an XmlSchema
is
traversed.
Modifier and Type | Method and Description |
---|---|
void |
onEndAttributes(org.apache.ws.commons.schema.XmlSchemaElement element,
XmlSchemaTypeInfo typeInfo)
This method is called when all of the attributes have been processed
(provided the element has a type defined).
|
void |
onEnterAllGroup(org.apache.ws.commons.schema.XmlSchemaAll all)
Called when an all group is entered.
|
void |
onEnterChoiceGroup(org.apache.ws.commons.schema.XmlSchemaChoice choice)
Called when a choice group is entered.
|
void |
onEnterElement(org.apache.ws.commons.schema.XmlSchemaElement element,
XmlSchemaTypeInfo typeInfo,
boolean previouslyVisited)
A notification that an
XmlSchemaElement has been entered. |
void |
onEnterSequenceGroup(org.apache.ws.commons.schema.XmlSchemaSequence seq)
Called when a sequence is entered.
|
void |
onEnterSubstitutionGroup(org.apache.ws.commons.schema.XmlSchemaElement base)
This method is called when the walker enters a substitution group.
|
void |
onExitAllGroup(org.apache.ws.commons.schema.XmlSchemaAll all)
Called when an all group is exited.
|
void |
onExitChoiceGroup(org.apache.ws.commons.schema.XmlSchemaChoice choice)
Called when a choice group is exited.
|
void |
onExitElement(org.apache.ws.commons.schema.XmlSchemaElement element,
XmlSchemaTypeInfo typeInfo,
boolean previouslyVisited)
Signifies the end of the element that was previously entered.
|
void |
onExitSequenceGroup(org.apache.ws.commons.schema.XmlSchemaSequence seq)
Called when a sequence is exited.
|
void |
onExitSubstitutionGroup(org.apache.ws.commons.schema.XmlSchemaElement base)
Called when the end of the substitution group is reached.
|
void |
onVisitAny(org.apache.ws.commons.schema.XmlSchemaAny any)
Called when a wildcard element is entered.
|
void |
onVisitAnyAttribute(org.apache.ws.commons.schema.XmlSchemaElement element,
org.apache.ws.commons.schema.XmlSchemaAnyAttribute anyAttr)
Called when a wildcard attribute is visited.
|
void |
onVisitAttribute(org.apache.ws.commons.schema.XmlSchemaElement element,
XmlSchemaAttrInfo attrInfo)
This method is called for each attribute associated with the element,
providing the
XmlSchemaAttrInfo representing that attribute. |
void onEnterElement(org.apache.ws.commons.schema.XmlSchemaElement element, XmlSchemaTypeInfo typeInfo, boolean previouslyVisited)
XmlSchemaElement
has been entered. The
element returned will be a true representation of the element at that
point in the schema: if the schema defines a reference, the reference is
followed and merged with its global definition.
The first time this element is reached, all of its attributes will be
visited (if any). Once the attributes have been visited,
onEndAttributes(XmlSchemaElement, XmlSchemaTypeInfo)
will be
called. The only exception is when the element has no type information,
at which point the next call will be to
onExitElement(XmlSchemaElement, XmlSchemaTypeInfo, boolean)
.
On all subsequent visits to this element, previouslyVisited
will be set to true
and the attributes will not be
revisited. The next call will be to
onExitElement(XmlSchemaElement, XmlSchemaTypeInfo, boolean)
, as
all of the element's attributes and children have already been provided.
element
- The element the walker is currently entering.typeInfo
- The type information of that element.previouslyVisited
- Whether the element was previously visited.void onExitElement(org.apache.ws.commons.schema.XmlSchemaElement element, XmlSchemaTypeInfo typeInfo, boolean previouslyVisited)
onEnterElement(XmlSchemaElement, XmlSchemaTypeInfo, boolean)
in
the event it is easier to process on exit.element
- The element the walker is currently exiting.typeInfo
- The type information of that element.previouslyVisited
- Whether the element was previously visited.void onVisitAttribute(org.apache.ws.commons.schema.XmlSchemaElement element, XmlSchemaAttrInfo attrInfo)
XmlSchemaAttrInfo
representing that attribute.element
- The element owing the attribute.attrInfo
- The attribute information.void onEndAttributes(org.apache.ws.commons.schema.XmlSchemaElement element, XmlSchemaTypeInfo typeInfo)
element
- The element the walker is traversing.typeInfo
- Type information about the element, if it is easier to
process here.void onEnterSubstitutionGroup(org.apache.ws.commons.schema.XmlSchemaElement base)
onEnterElement(XmlSchemaElement, XmlSchemaTypeInfo, boolean)
is
called for all types in the substitution group, starting with the base
type.
The only exception is when the base type of the substitution group is
abstract (XmlSchemaElement.isAbstract()
returns true
). When this happens,
onEnterElement(XmlSchemaElement, XmlSchemaTypeInfo, boolean)
is
not called with the abstract type, as there is no information to provide.
If the root element is the base of a substitution group, this method will
be the first one called. Otherwise,
onEnterElement(XmlSchemaElement, XmlSchemaTypeInfo, boolean)
will be called with the root element.
base
- The XmlSchemaElement
representing the base of the
substitution group.void onExitSubstitutionGroup(org.apache.ws.commons.schema.XmlSchemaElement base)
base
- The base element of the subtitution group.void onEnterAllGroup(org.apache.ws.commons.schema.XmlSchemaAll all)
all
- The XmlSchemaAll
representing the all group.void onExitAllGroup(org.apache.ws.commons.schema.XmlSchemaAll all)
all
- The XmlSchemaAll
representing the all group.void onEnterChoiceGroup(org.apache.ws.commons.schema.XmlSchemaChoice choice)
all
- The XmlSchemaChoice
representing the choice group.void onExitChoiceGroup(org.apache.ws.commons.schema.XmlSchemaChoice choice)
all
- The XmlSchemaChoice
representing the choice group.void onEnterSequenceGroup(org.apache.ws.commons.schema.XmlSchemaSequence seq)
seq
- The XmlSchemaSequence
representing the sequence.void onExitSequenceGroup(org.apache.ws.commons.schema.XmlSchemaSequence seq)
seq
- The XmlSchemaSequence
representing the sequence.void onVisitAny(org.apache.ws.commons.schema.XmlSchemaAny any)
any
- The XmlSchemaAny
representing the wildcard element.void onVisitAnyAttribute(org.apache.ws.commons.schema.XmlSchemaElement element, org.apache.ws.commons.schema.XmlSchemaAnyAttribute anyAttr)
onEndAttributes(XmlSchemaElement, XmlSchemaTypeInfo)
.element
- The owning element.anyAttr
- The XmlSchemaAnyAttribute
representing the
wildcard attribute.Copyright © 2004–2017 The Apache Software Foundation. All rights reserved.