XmlSchemaDocumentNode

java.lang.Object
- org.apache.ws.commons.schema.docpath.XmlSchemaDocumentNode

```
public final class XmlSchemaDocumentNode
extends java.lang.Object
```
The 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 XmlSchemaPathNodes representing the path walked, and XmlSchemaDocumentNodes representing where the XML document's elements fall in the XML Schema's sequences, choices, and all groups.
While XmlSchemaStateMachineNodes may loop back on themselves, the XmlSchemaDocumentNodes 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.

Field Summary

Fields
Modifier and Type	Field and Description
`private java.util.List<java.util.SortedMap<java.lang.Integer,XmlSchemaDocumentNode<U>>>`	`children`
`private XmlSchemaDocumentNode<U>`	`parent`
`private boolean`	`receivedContent`
`private XmlSchemaStateMachineNode`	`stateMachineNode`
`private U`	`userDefinedContent`
`private java.util.List<XmlSchemaPathNode<U,?>>`	`visitors`

Constructor Summary

Constructors
Constructor and Description

XmlSchemaDocumentNode(XmlSchemaDocumentNode parent, XmlSchemaStateMachineNode stateMachineNode)

Constructors
Constructor and Description
`XmlSchemaDocumentNode(XmlSchemaDocumentNode<U> parent, XmlSchemaStateMachineNode stateMachineNode)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`(package private) void`	`addVisitor(XmlSchemaPathNode<U,?> path)` A visitor is a CHILD or SIBLING `XmlSchemaPathNode` entering this `XmlSchemaDocumentNode`.
`java.util.SortedMap<java.lang.Integer,XmlSchemaDocumentNode<U>>`	`getChildren()` Retrieves the children in the last occurrence of this node, mapped to their relative position.
`java.util.SortedMap<java.lang.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.
`(package private) boolean`	`getReceivedContent()` Indicates whether an element has text in it.
`(package private) int`	`getSequencePosition()`
`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.
`(package private) boolean`	`removeVisitor(XmlSchemaPathNode<U,?> path)`
`(package private) void`	`set(XmlSchemaDocumentNode<U> parent, XmlSchemaStateMachineNode stateMachineNode)`
`(package private) void`	`setReceivedContent(boolean receivedContent)` Sets whether the element has text in it.
`void`	`setUserDefinedContent(U userDefinedContent)` Attaches user-defined content to this `XmlSchemaDocumentNode`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
 - stateMachineNode
```
private XmlSchemaStateMachineNode stateMachineNode
```
 - parent
```
private XmlSchemaDocumentNode parent
```
 - children
```
private java.util.List<java.util.SortedMap<java.lang.Integer,XmlSchemaDocumentNode>> children
```
 - visitors
```
private java.util.List<XmlSchemaPathNode<U,?>> visitors
```
 - receivedContent
```
private boolean receivedContent
```
 - userDefinedContent
```
private U userDefinedContent
```
- Constructor Detail
 - XmlSchemaDocumentNode
```
XmlSchemaDocumentNode(XmlSchemaDocumentNode parent,
 XmlSchemaStateMachineNode stateMachineNode)
```
- Method Detail
 - getStateMachineNode
```
public XmlSchemaStateMachineNode getStateMachineNode()
```
 Returns the XmlSchemaStateMachineNode representing the place in the XML Schema that this XmlSchemaDocumentNode represents.
 - getParent
```
public XmlSchemaDocumentNode getParent()
```
 The XmlSchemaDocumentNode representing this one's immediate parent.
 - getChildren
```
public java.util.SortedMap<java.lang.Integer,XmlSchemaDocumentNode> getChildren()
```
 Retrieves the children in the last occurrence of this node, mapped to their relative position.
 - getChildren
```
public java.util.SortedMap<java.lang.Integer,XmlSchemaDocumentNode> getChildren(int iteration)
```
 Retrieves the children in the provided occurrence of this node, mapped to their relative position.
 
 Parameters:
 
 iteration - The 1-based occurrence to retrieve children for.
 - getReceivedContent
```
boolean getReceivedContent()
```
 Indicates whether an element has text in it.
 - setReceivedContent
```
void setReceivedContent(boolean receivedContent)
```
 Sets whether the element has text in it.
 
 Parameters:
 
 receivedContent -
 - addVisitor
```
void addVisitor(XmlSchemaPathNode<U,?> path)
```
 A visitor is a CHILD or SIBLING XmlSchemaPathNode entering this XmlSchemaDocumentNode. This is used to keep track of how many occurrences are active via the current path winding through the schema.
 - removeVisitor
```
boolean removeVisitor(XmlSchemaPathNode<U,?> path)
```
 - getIteration
```
public int getIteration()
```
 The total number of occurrences of this XmlSchemaDocumentNode in the underlying document.
 - getMinOccurs
```
public long getMinOccurs()
```
 Shortcut for calling getStateMachineNode().getMinOccurs().
 
 See Also:
 
 XmlSchemaStateMachineNode.getMinOccurs()
 - getMaxOccurs
```
public long getMaxOccurs()
```
 Shortcut for calling getStateMachineNode().getMaxOccurs().
 
 See Also:
 
 XmlSchemaStateMachineNode.getMaxOccurs()
 - getSequencePosition
```
int getSequencePosition()
```
 - set
```
void set(XmlSchemaDocumentNode parent,
 XmlSchemaStateMachineNode stateMachineNode)
```
 - getUserDefinedContent
```
public U getUserDefinedContent()
```
 Retrieves any user-defined content attached to this XmlSchemaDocumentNode, or null if none.
 - setUserDefinedContent
```
public void setUserDefinedContent(U userDefinedContent)
```
 Attaches user-defined content to this XmlSchemaDocumentNode.

Class XmlSchemaDocumentNode<U>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

stateMachineNode

parent

children

visitors

receivedContent

userDefinedContent

Constructor Detail

XmlSchemaDocumentNode

Method Detail

getStateMachineNode

getParent

getChildren

getChildren

getReceivedContent

setReceivedContent

addVisitor

removeVisitor

getIteration

getMinOccurs

getMaxOccurs

getSequencePosition

set

getUserDefinedContent

setUserDefinedContent