Package org.apache.ws.commons.schema.docpath

Class XmlSchemaPathNode<U,V>

java.lang.Object

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

public final class XmlSchemaPathNode<U,V>
extends Object

This represents a node in the path when walking an XML or Avro 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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	XmlSchemaPathNode.Direction	Represents a path's direction.

Field Summary

Fields

Modifier and Type	Field	Description
private XmlSchemaPathNode.Direction	direction
private XmlSchemaDocumentNode<U>	documentNode
private int	iterationNum
private XmlSchemaPathNode<U,V>	nextNode
private int	nextNodeStateIndex
private XmlSchemaPathNode<U,V>	prevNode
private XmlSchemaStateMachineNode	stateMachineNode
private V	userDefinedContent

Constructor Summary

Constructors

Constructor	Description
XmlSchemaPathNode(XmlSchemaPathNode.Direction dir, XmlSchemaPathNode<U,V> previous, XmlSchemaDocumentNode<U> node)
XmlSchemaPathNode(XmlSchemaPathNode.Direction dir, XmlSchemaPathNode<U,V> previous, XmlSchemaStateMachineNode stateMachine)

Method Summary

Modifier and Type	Method	Description
XmlSchemaPathNode.Direction	getDirection()	The direction this path travels.
int	getDocIteration()	Shortcut for calling getDocumentNode().getIteration().
(package private) int	getDocSequencePosition()
XmlSchemaDocumentNode<U>	getDocumentNode()	Retrieves the XmlSchemaDocumentNode this XmlSchemaPathNode is visiting.
(package private) int	getIndexOfNextNodeState()
int	getIteration()	The iteration through the underlying XmlSchemaDocumentNode.
long	getMaxOccurs()	Shortcut for calling getStateMachineNode().getMaxOccurs().
long	getMinOccurs()	Shortcut for calling getStateMachineNode().getMinOccurs().
XmlSchemaPathNode<U,V>	getNext()	The next node in the path, or null if at the end of the path.
XmlSchemaPathNode<U,V>	getPrevious()	The previous node in the path, or null if at the beginning of the path.
XmlSchemaStateMachineNode	getStateMachineNode()	Retrieves the XmlSchemaStateMachineNode representing the XML Schema that this XmlSchemaPathNode is visiting.
V	getUserDefinedContent()	Retrieves any user-defined content attached to this XmlSchemaPathNode, or null if none.
(package private) void	setDocumentNode(XmlSchemaDocumentNode<U> docNode)
(package private) void	setIteration(int newIteration)
(package private) void	setNextNode(int nextNodeIndex, XmlSchemaPathNode<U,V> newNext)
(package private) XmlSchemaPathNode<U,V>	setPreviousNode(XmlSchemaPathNode<U,V> newPrevious)	Changes the previous node this one was pointing to.
void	setUserDefinedContent(V content)	Attaches user-defined content to this XmlSchemaPathNode.
(package private) void	update(XmlSchemaPathNode.Direction newDirection, XmlSchemaPathNode<U,V> newPrevious, XmlSchemaDocumentNode<U> newNode)	Use this method when changing the the XmlSchemaStateMachineNode this DocumentPathNode refers to.
(package private) void	update(XmlSchemaPathNode.Direction newDirection, XmlSchemaPathNode<U,V> newPrevious, XmlSchemaStateMachineNode newStateMachineNode)

Methods inherited from class java.lang.Object

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

Field Details

direction

private XmlSchemaPathNode.Direction direction

documentNode

private XmlSchemaDocumentNode<U> documentNode

stateMachineNode

private XmlSchemaStateMachineNode stateMachineNode

nextNodeStateIndex

private int nextNodeStateIndex

iterationNum

private int iterationNum

userDefinedContent

private V userDefinedContent

prevNode

private XmlSchemaPathNode<U,V> prevNode

nextNode

private XmlSchemaPathNode<U,V> nextNode

Constructor Details

XmlSchemaPathNode

XmlSchemaPathNode(XmlSchemaPathNode.Direction dir,
 XmlSchemaPathNode<U,V> previous,
 XmlSchemaDocumentNode<U> node)

XmlSchemaPathNode

XmlSchemaPathNode(XmlSchemaPathNode.Direction dir,
 XmlSchemaPathNode<U,V> previous,
 XmlSchemaStateMachineNode stateMachine)

Method Details

getDocumentNode

public XmlSchemaDocumentNode<U> getDocumentNode()

Retrieves the XmlSchemaDocumentNode this XmlSchemaPathNode is visiting.

getStateMachineNode

public XmlSchemaStateMachineNode getStateMachineNode()

Retrieves the XmlSchemaStateMachineNode representing the XML Schema that this XmlSchemaPathNode is visiting. This is equivalent to calling getDocumentNode().getStateMachineNode().

getDirection

public XmlSchemaPathNode.Direction getDirection()

The direction this path travels.

getIteration

public int getIteration()

The iteration through the underlying XmlSchemaDocumentNode. If the path traverses the same XmlSchemaDocumentNode twice, XmlSchemaDocumentNode.getIteration() will return two, and one getIteration() will return one, while the other will return two.

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()

getDocIteration

public int getDocIteration()

Shortcut for calling getDocumentNode().getIteration().

See Also:

• XmlSchemaDocumentNode.getIteration()

getPrevious

public XmlSchemaPathNode<U,V> getPrevious()

The previous node in the path, or null if at the beginning of the path.

getNext

public XmlSchemaPathNode<U,V> getNext()

The next node in the path, or null if at the end of the path.

getIndexOfNextNodeState

int getIndexOfNextNodeState()

getDocSequencePosition

int getDocSequencePosition()

setIteration

void setIteration(int newIteration)

setDocumentNode

void setDocumentNode(XmlSchemaDocumentNode<U> docNode)

setNextNode

void setNextNode(int nextNodeIndex,
 XmlSchemaPathNode<U,V> newNext)

setPreviousNode

XmlSchemaPathNode<U,V> setPreviousNode(XmlSchemaPathNode<U,V> newPrevious)

Changes the previous node this one was pointing to. This is useful when cloning prior nodes in the chain.

Parameters:

newPrevious - The new previous node.

Returns:

The old previous node.

update

void update(XmlSchemaPathNode.Direction newDirection,
 XmlSchemaPathNode<U,V> newPrevious,
 XmlSchemaDocumentNode<U> newNode)

Use this method when changing the the XmlSchemaStateMachineNode this DocumentPathNode refers to. The next node in the path is returned, as it will be discarded internally.

Parameters:

newPrevious - The new previous DocumentPathNode this node is traversed from.

newNode - The new XmlSchemaStateMachineNode this node refers to.

update

void update(XmlSchemaPathNode.Direction newDirection,
 XmlSchemaPathNode<U,V> newPrevious,
 XmlSchemaStateMachineNode newStateMachineNode)

getUserDefinedContent

public V getUserDefinedContent()

Retrieves any user-defined content attached to this XmlSchemaPathNode, or null if none.

setUserDefinedContent

public void setUserDefinedContent(V content)

Attaches user-defined content to this XmlSchemaPathNode.