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

Class XmlSchemaStateMachineNode

java.lang.Object

org.apache.ws.commons.schema.docpath.XmlSchemaStateMachineNode

public final class XmlSchemaStateMachineNode
extends Object

This represents a node in the state machine used when parsing an XML Document based on its XmlSchema and Avro org.apache.avro.Schema.

A SchemaStateMachineNode represents one of:

• An element, its type, and its attributes
• An all group
• A choice group
• A sequence group
• An <any> wildcard element
• A substitution group

As a Document is traversed, the state machine is used to determine how to process the current element. Two passes will be needed: the first pass will determine the correct path through the document's schema in order to properly parse the elements, and the second traversal will read the elements while following that path.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	XmlSchemaStateMachineNode.Type

Field Summary

Fields

Modifier and Type	Field	Description
private final XmlSchemaAny	any
private final List<XmlSchemaAttrInfo>	attributes
private final XmlSchemaElement	element
private final long	maxOccurs
private final long	minOccurs
private final XmlSchemaStateMachineNode.Type	nodeType
private List<XmlSchemaStateMachineNode>	possibleNextStates
private final XmlSchemaTypeInfo	typeInfo

Constructor Summary

Constructors

Constructor	Description
XmlSchemaStateMachineNode(XmlSchemaStateMachineNode.Type nodeType, long minOccurs, long maxOccurs)	Constructs a new SchemaStateMachineNode for a group.
XmlSchemaStateMachineNode(XmlSchemaAny any)	Constructs a XmlSchemaStateMachineNode from the XmlSchemaAny.
XmlSchemaStateMachineNode(XmlSchemaElement elem, List<XmlSchemaAttrInfo> attrs, XmlSchemaTypeInfo typeInfo)	Constructs a new SchemaStateMachineNode for an element.

Method Summary

Modifier and Type	Method	Description
(package private) XmlSchemaStateMachineNode	addPossibleNextState(XmlSchemaStateMachineNode next)	Adds a state that could follow this SchemaStateMachineNode.
(package private) XmlSchemaStateMachineNode	addPossibleNextStates(Collection<XmlSchemaStateMachineNode> nextStates)	Adds the set of possible states that could follow this SchemaStateMachineNode.
XmlSchemaAny	getAny()	Returns the XmlSchemaAny associated with this node, or null if none.
List<XmlSchemaAttrInfo>	getAttributes()	If this SchemaStateMachineNode represents an XmlSchemaElement, the set of XmlSchemaAttrInfos associated with the element it represents.
XmlSchemaElement	getElement()	If this SchemaStateMachineNode represents an XmlSchemaElement, the XmlSchemaElement it represents.
XmlSchemaTypeInfo	getElementType()	If this SchemaStateMachineNode represents an XmlSchemaElement, the XmlSchemaTypeInfo of the element it represents.
long	getMaxOccurs()	The maximum number of times this SchemaStateMachineNode may appear in succession.
long	getMinOccurs()	The minimum number of times this SchemaStateMachineNode may appear in succession.
XmlSchemaStateMachineNode.Type	getNodeType()	The XML Schema node XmlSchemaStateMachineNode.Type this SchemaStateMachineNode represents.
List<XmlSchemaStateMachineNode>	getPossibleNextStates()	All of the known possible states that could follow this one.
String	toString()	Builds a String representing this XmlSchemaStateMachineNode.

Methods inherited from class java.lang.Object

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

Field Details

nodeType

private final XmlSchemaStateMachineNode.Type nodeType

element

private final XmlSchemaElement element

attributes

private final List<XmlSchemaAttrInfo> attributes

typeInfo

private final XmlSchemaTypeInfo typeInfo

minOccurs

private final long minOccurs

maxOccurs

private final long maxOccurs

any

private final XmlSchemaAny any

possibleNextStates

private List<XmlSchemaStateMachineNode> possibleNextStates

Constructor Details

XmlSchemaStateMachineNode

XmlSchemaStateMachineNode(XmlSchemaStateMachineNode.Type nodeType,
 long minOccurs,
 long maxOccurs)

Constructs a new SchemaStateMachineNode for a group.

Parameters:

nodeType - The type of the group node (XmlSchemaStateMachineNode.Type.ALL, XmlSchemaStateMachineNode.Type.SUBSTITUTION_GROUP, XmlSchemaStateMachineNode.Type.CHOICE, XmlSchemaStateMachineNode.Type.SEQUENCE, or XmlSchemaStateMachineNode.Type.ANY).

minOccurs - The minimum number of occurrences of this group.

maxOccurs - The maximum number of occurrences of this group.

Throws:

IllegalArgumentException - if this constructor is used to define an XmlSchemaStateMachineNode.Type.ELEMENT or an XmlSchemaStateMachineNode.Type.ANY.

XmlSchemaStateMachineNode

XmlSchemaStateMachineNode(XmlSchemaElement elem,
 List<XmlSchemaAttrInfo> attrs,
 XmlSchemaTypeInfo typeInfo)

Constructs a new SchemaStateMachineNode for an element.

Parameters:

elem - The XmlSchemaElement this node represents.

attrs - The XmlSchemaAttribute contained by this element. An empty List or null if none.

typeInfo - The type information, if the element has simple content. null if not.

XmlSchemaStateMachineNode

XmlSchemaStateMachineNode(XmlSchemaAny any)

Constructs a XmlSchemaStateMachineNode from the XmlSchemaAny.

Parameters:

any - The XmlSchemaAny to construct the node from.

Method Details

getNodeType

public XmlSchemaStateMachineNode.Type getNodeType()

The XML Schema node XmlSchemaStateMachineNode.Type this SchemaStateMachineNode represents.

getElement

public XmlSchemaElement getElement()

If this SchemaStateMachineNode represents an XmlSchemaElement, the XmlSchemaElement it represents.

getElementType

public XmlSchemaTypeInfo getElementType()

If this SchemaStateMachineNode represents an XmlSchemaElement, the XmlSchemaTypeInfo of the element it represents.

getAttributes

public List<XmlSchemaAttrInfo> getAttributes()

If this SchemaStateMachineNode represents an XmlSchemaElement, the set of XmlSchemaAttrInfos associated with the element it represents.

getMinOccurs

public long getMinOccurs()

The minimum number of times this SchemaStateMachineNode may appear in succession.

getMaxOccurs

public long getMaxOccurs()

The maximum number of times this SchemaStateMachineNode may appear in succession.

getAny

public XmlSchemaAny getAny()

Returns the XmlSchemaAny associated with this node, or null if none.

addPossibleNextState

XmlSchemaStateMachineNode addPossibleNextState(XmlSchemaStateMachineNode next)

Adds a state that could follow this SchemaStateMachineNode.

Parameters:

next - A node that could follow this one in the XML document.

Returns:

Itself, for chaining.

addPossibleNextStates

XmlSchemaStateMachineNode addPossibleNextStates(Collection<XmlSchemaStateMachineNode> nextStates)

Adds the set of possible states that could follow this SchemaStateMachineNode.

Parameters:

nextStates - The set of possible nodes that could follow this one in the XML document.

Returns:

Itself, for chaining.

getPossibleNextStates

public List<XmlSchemaStateMachineNode> getPossibleNextStates()

All of the known possible states that could follow this one.

toString

public String toString()

Builds a String representing this XmlSchemaStateMachineNode.

Overrides:

toString in class Object