public final class XmlSchemaDocumentNode<U> extends Object
XmlSchemaDocumentNode
represents a node in the XML Schema as
it is used by an XML document. As XmlSchemaPathFinder
walks through
an XML document, it builds XmlSchemaPathNode
s representing the path
walked, and XmlSchemaDocumentNode
s representing where the XML
document's elements fall in the XML Schema's sequences, choices, and all
groups.
While XmlSchemaStateMachineNode
s may loop back on themselves, the
XmlSchemaDocumentNode
s will not. Likewise, the document nodes
form a tree that represent the XML Schema as it is applied to the document.
If a single node has multiple occurrences, the children of each occurrence
can be retrieved by calling getChildren(int)
. getChildren()
returns the child nodes for the final occurrence.
Modifier and Type | Method and Description |
---|---|
SortedMap<Integer,XmlSchemaDocumentNode<U>> |
getChildren()
Retrieves the children in the last occurrence of this node, mapped to
their relative position.
|
SortedMap<Integer,XmlSchemaDocumentNode<U>> |
getChildren(int iteration)
Retrieves the children in the provided occurrence of this node, mapped to
their relative position.
|
int |
getIteration()
The total number of occurrences of this
XmlSchemaDocumentNode in the underlying document. |
long |
getMaxOccurs()
Shortcut for calling
getStateMachineNode().getMaxOccurs() . |
long |
getMinOccurs()
Shortcut for calling
getStateMachineNode().getMinOccurs() . |
XmlSchemaDocumentNode<U> |
getParent()
The
XmlSchemaDocumentNode representing this one's immediate
parent. |
XmlSchemaStateMachineNode |
getStateMachineNode()
Returns the
XmlSchemaStateMachineNode representing the place in
the XML Schema that this XmlSchemaDocumentNode represents. |
U |
getUserDefinedContent()
Retrieves any user-defined content attached to this
XmlSchemaDocumentNode , or null if none. |
void |
setUserDefinedContent(U userDefinedContent)
Attaches user-defined content to this
XmlSchemaDocumentNode . |
public XmlSchemaStateMachineNode getStateMachineNode()
XmlSchemaStateMachineNode
representing the place in
the XML Schema that this XmlSchemaDocumentNode
represents.public XmlSchemaDocumentNode<U> getParent()
XmlSchemaDocumentNode
representing this one's immediate
parent.public SortedMap<Integer,XmlSchemaDocumentNode<U>> getChildren()
public SortedMap<Integer,XmlSchemaDocumentNode<U>> getChildren(int iteration)
iteration
- The 1-based occurrence to retrieve children for.public int getIteration()
XmlSchemaDocumentNode
in the underlying document.public long getMinOccurs()
getStateMachineNode().getMinOccurs()
.public long getMaxOccurs()
getStateMachineNode().getMaxOccurs()
.public U getUserDefinedContent()
XmlSchemaDocumentNode
, or null
if none.public void setUserDefinedContent(U userDefinedContent)
XmlSchemaDocumentNode
.Copyright © 2004–2017 The Apache Software Foundation. All rights reserved.