org.jvoicexml.xml.scxml

Class Scxml

java.lang.Object

org.jvoicexml.xml.AbstractXmlNode

org.jvoicexml.xml.scxml.Scxml

All Implemented Interfaces:

ScxmlNode, XmlNode, org.w3c.dom.Node

public final class Scxml
extends AbstractXmlNode

The top-level wrapper element, which carries version information. The actual state machine consists of its children.

Since:

0.7.6

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTRIBUTE_BINDING The data binding to use.
static java.lang.String	ATTRIBUTE_DATAMODEL The datamodel that this document requires.
static java.lang.String	ATTRIBUTE_EXMODE Determines whether the processor should silently ignore markup that it does not support.
protected static java.util.ArrayList<java.lang.String>	ATTRIBUTE_NAMES Supported attribute names for this node.
static java.lang.String	ATTRIBUTE_VERSION The value MUST be 1.0.
static java.lang.String	ATTRIBUTE_XMLNS The namespace URI for SCXML is "http://www.w3.org/2005/07/scxm".
static java.lang.String	TAG_NAME Name of the tag.

Fields inherited from interface org.w3c.dom.Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Constructor Summary

Constructors

Constructor and Description
Scxml() Construct a new scxml object without a node.

Method Summary

Modifier and Type	Method and Description
protected boolean	canContainChild(java.lang.String tagName) Can the specified sub-tag be contained within this node?
java.util.Collection<java.lang.String>	getAttributeNames() Returns a collection of permitted attribute names for the node.
java.lang.String	getBinding() Retrieves the binding attribute.
java.lang.String	getDatamodel() Retrieves the datamodel attribute.
java.lang.String	getExmode() Retrieves the exmode attribute.
java.lang.String	getInitial() Retrieve the initial attribute.
java.lang.String	getName() Retrieve the name attribute.
java.lang.String	getTagName() Get the name of the tag for the derived node.
java.lang.String	getVersion() Retrieve the version attribute.
java.lang.String	getXmlns() Retrieve the xmlns attribute.
XmlNode	newInstance(org.w3c.dom.Node n, XmlNodeFactory<? extends XmlNode> factory) Create a new instance for the given node.
void	setBinding(java.lang.String binding) Sets the binding attribute.
void	setDatamodel(java.lang.String datamodel) Sets the datamodel attribute.
void	setExmode(java.lang.String exmode) Sets the exmode attribute.
void	setInitial(java.lang.String initial) Set the initial attribute.
void	setName(java.lang.String name) Sets the name attribute.
void	setVersion(java.lang.String version) Set the version attribute.
void	setXmlns(java.lang.String xmlns) Set the xmlns attribute.

Methods inherited from class org.jvoicexml.xml.AbstractXmlNode

addChild, addChild, appendChild, appendChild, appendDeepClone, cloneNode, compareDocumentPosition, equals, getAttribute, getAttributes, getBaseURI, getChildNodes, getChildNodes, getChildren, getDefinedAttributeNames, getFeature, getFirstChild, getFirstLevelTextContent, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNode, getNodeFactory, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getOwnerXmlDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttribute, hasAttributes, hasChildNodes, hashCode, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setAttribute, setNodeValue, setPrefix, setTextContent, setUserData, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jvoicexml.xml.XmlNode

addChild, getAttribute, getChildNodes, getChildren, getNode, setAttribute

Methods inherited from interface org.w3c.dom.Node

appendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData

Field Detail

TAG_NAME

public static final java.lang.String TAG_NAME

Name of the tag.

See Also:

Constant Field Values

ATTRIBUTE_XMLNS

public static final java.lang.String ATTRIBUTE_XMLNS

The namespace URI for SCXML is "http://www.w3.org/2005/07/scxm".

See Also:

Constant Field Values

ATTRIBUTE_VERSION

public static final java.lang.String ATTRIBUTE_VERSION

The value MUST be 1.0.

See Also:

Constant Field Values

ATTRIBUTE_DATAMODEL

public static final java.lang.String ATTRIBUTE_DATAMODEL

The datamodel that this document requires. null denotes the Null datamodel, ecmascript the ECMAScript datamodel, and xpath the XPath datamodel.

See Also:

Constant Field Values

ATTRIBUTE_BINDING

public static final java.lang.String ATTRIBUTE_BINDING

The data binding to use.

See Also:

Constant Field Values

ATTRIBUTE_EXMODE

public static final java.lang.String ATTRIBUTE_EXMODE

Determines whether the processor should silently ignore markup that it does not support.

See Also:

Constant Field Values

ATTRIBUTE_NAMES

protected static final java.util.ArrayList<java.lang.String> ATTRIBUTE_NAMES

Supported attribute names for this node.

Constructor Detail

Scxml

public Scxml()

Construct a new scxml object without a node.

This is necessary for the node factory.

See Also:

ScxmlNodeFactory

Method Detail

getTagName

public java.lang.String getTagName()

Get the name of the tag for the derived node.

Returns:

name of the tag.

newInstance

public XmlNode newInstance(org.w3c.dom.Node n,
                           XmlNodeFactory<? extends XmlNode> factory)

Create a new instance for the given node.

Each XmlNode can serve as a prototype in a XmlNodeFactory to produce a collection of child nodes. Factories can then use the prototype pattern to produce new nodes.

Parameters:

n - The node to encapsulate.

factory - the factroy that calls this method.

Returns:

The new instance.

See Also:

XmlNodeFactory

getInitial

public java.lang.String getInitial()

Retrieve the initial attribute.

Returns:

value of the inital attribute.

See Also:

ATTRIBUTE_INITIAL

setInitial

public void setInitial(java.lang.String initial)

Set the initial attribute.

Parameters:

initial - value of the initial attribute.

See Also:

ATTRIBUTE_INITIAL

getName

public java.lang.String getName()

Retrieve the name attribute.

Returns:

value of the name attribute.

See Also:

ATTRIBUTE_NAME

setName

public void setName(java.lang.String name)

Sets the name attribute.

Parameters:

name - Value of the name attribute.

See Also:

ATTRIBUTE_NAME

getXmlns

public java.lang.String getXmlns()

Retrieve the xmlns attribute.

Returns:

Value of the xmlns attribute.

See Also:

ATTRIBUTE_XMLNS

setXmlns

public void setXmlns(java.lang.String xmlns)

Set the xmlns attribute.

Parameters:

xmlns - Value of the xml:base attribute.

See Also:

ATTRIBUTE_XMLNS

getVersion

public java.lang.String getVersion()

Retrieve the version attribute.

Returns:

Value of the version attribute.

See Also:

ATTRIBUTE_VERSION

setVersion

public void setVersion(java.lang.String version)

Set the version attribute.

Parameters:

version - Value of the version attribute.

See Also:

ATTRIBUTE_VERSION

getDatamodel

public java.lang.String getDatamodel()

Retrieves the datamodel attribute.

Returns:

value of the datamodel attribute.

See Also:

ATTRIBUTE_DATAMODEL

setDatamodel

public void setDatamodel(java.lang.String datamodel)

Sets the datamodel attribute.

Parameters:

datamodel - Value of the datamodel attribute.

See Also:

ATTRIBUTE_DATAMODEL

getBinding

public java.lang.String getBinding()

Retrieves the binding attribute.

Returns:

value of the binding attribute.

See Also:

ATTRIBUTE_DATAMODEL

setBinding

public void setBinding(java.lang.String binding)

Sets the binding attribute.

Parameters:

binding - Value of the binding attribute.

See Also:

ATTRIBUTE_BINDING

getExmode

public java.lang.String getExmode()

Retrieves the exmode attribute.

Returns:

value of the exmode attribute.

See Also:

ATTRIBUTE_EXMODE

setExmode

public void setExmode(java.lang.String exmode)

Sets the exmode attribute.

Parameters:

exmode - Value of the exmode attribute.

See Also:

ATTRIBUTE_EXMODE

canContainChild

protected boolean canContainChild(java.lang.String tagName)

Can the specified sub-tag be contained within this node?

Specified by:

canContainChild in class AbstractXmlNode

Parameters:

tagName - Name of child.

Returns:

True if the sub-tag is allowed on this node.

getAttributeNames

public java.util.Collection<java.lang.String> getAttributeNames()

Returns a collection of permitted attribute names for the node.

Specified by:

getAttributeNames in interface XmlNode

Overrides:

getAttributeNames in class AbstractXmlNode

Returns:

A collection of attribute names that are allowed for the node