org.jvoicexml.xml.ccxml
Class Eventprocessor

java.lang.Object
  org.jvoicexml.xml.XmlNode
      org.jvoicexml.xml.ccxml.CcxmlNode
          org.jvoicexml.xml.ccxml.Eventprocessor

All Implemented Interfaces:

XmlWritable, Node

public final class Eventprocessor
extends CcxmlNode

The <eventprocessor> acts a container for <transition>s. A valid CCXML document MUST only have a single <eventprocessor>.

Version:

$Revision: 1.4 $

Copyright © 2005 JVoiceXML group - http://jvoicexml.sourceforge.net/

Author:

Steve Doyle

Field Summary

protected static ArrayList<String>	ATTRIBUTE_NAMES Supported attribute names for this node.
static String	ATTRIBUTE_STATEVARIABLE This is a CCXML variable name, which is the name of the eventprocessor's state variable.
private static Set<String>	CHILD_TAGS Valid child tags for this node.
static String	TAG_NAME Name of the tag.

Fields inherited from class org.jvoicexml.xml.XmlNode

node

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

Eventprocessor()
Construct a new eventprocessor object without a node.

Eventprocessor(Node node)
Construct a new eventprocessor object.

Method Summary

protected boolean	canContainChild(String tagName) Can the specified sub-tag be contained within this node?
Collection<String>	getAttributeNames() Returns a collection of permitted attribute names for the node.
String	getStatevariable() Retrieve the statevariable attribute.
String	getTagName() Get the name of the tag for the derived node.
XmlNode	newInstance(Node n) Create a new instance for the given node.
void	setStatevariable(String statevariable) Set the statevariable attribute.

Methods inherited from class org.jvoicexml.xml.ccxml.CcxmlNode

getChildNodes, getFirstChild, getLastChild, getNextSibling, getParentNode, getPreviousSibling

Methods inherited from class org.jvoicexml.xml.XmlNode

addChild, appendChild, cloneNode, compareDocumentPosition, getAttribute, getAttributes, getBaseURI, getChildNodes, getFeature, getLocalName, getNamespaceURI, getNode, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getPrefix, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setAttribute, setNodeValue, setPrefix, setTextContent, setUserData, toString, writeChildrenXml, writeXml

Methods inherited from class java.lang.Object

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

Field Detail

TAG_NAME

public static final String TAG_NAME

Name of the tag.

See Also:

Constant Field Values

ATTRIBUTE_STATEVARIABLE

public static final String ATTRIBUTE_STATEVARIABLE

This is a CCXML variable name, which is the name of the eventprocessor's state variable. This variable must be defined using the var or the script element in the ccxml scope.

See Also:

Constant Field Values

ATTRIBUTE_NAMES

protected static final ArrayList<String> ATTRIBUTE_NAMES

Supported attribute names for this node.

CHILD_TAGS

private static final Set<String> CHILD_TAGS

Valid child tags for this node.

Constructor Detail

Eventprocessor

public Eventprocessor()

Construct a new eventprocessor object without a node.

This is necessary for the node factory.

See Also:

VoiceXmlNodeFactory

Eventprocessor

Eventprocessor(Node node)

Construct a new eventprocessor object.

Parameters:

node - The encapsulated node.

Method Detail

getTagName

public String getTagName()

Get the name of the tag for the derived node.

Specified by:

getTagName in class XmlNode

Returns:

name of the tag.

newInstance

public XmlNode newInstance(Node n)

Create a new instance for the given node.

Specified by:

newInstance in class XmlNode

Parameters:

n - The node to encapsulate.

Returns:

The new instance.

getStatevariable

public String getStatevariable()

Retrieve the statevariable attribute.

Returns:

Value of the statevariable attribute.

See Also:

ATTRIBUTE_STATEVARIABLE

setStatevariable

public void setStatevariable(String statevariable)

Set the statevariable attribute.

Parameters:

statevariable - Value of the statevariable attribute.

See Also:

ATTRIBUTE_STATEVARIABLE

canContainChild

protected boolean canContainChild(String tagName)

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

Specified by:

canContainChild in class XmlNode

Parameters:

tagName - Name of child.

Returns:

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

getAttributeNames

public Collection<String> getAttributeNames()

Returns a collection of permitted attribute names for the node.

Overrides:

getAttributeNames in class XmlNode

Returns:

A collection of attribute names that are allowed for the node