org.jvoicexml.xml.ccxml
Class Transition

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

All Implemented Interfaces:

XmlWritable, Node

public final class Transition
extends CcxmlNode

The content of a <transition> specifies the actions to be taken when it is selected. The <transition> are examined by the EHIA in document order.

Version:

$Revision: 1.4 $

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

Author:

Steve Doyle

Field Summary

static String	ATTRIBUTE_COND An ECMAScript expression which can be evaluated to true or false.
static String	ATTRIBUTE_EVENT This is a pattern that indicates a matching event type.
static String	ATTRIBUTE_NAME An ECMAScript left hand side expression evaluating to a previously defined variable.
protected static ArrayList<String>	ATTRIBUTE_NAMES Supported attribute names for this node.
static String	ATTRIBUTE_STATE This indicates the current possible state(s) of the eventprocessor .
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

Transition()
Construct a new transition object without a node.

Transition(Node node)
Construct a new transition 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	getCond() Retrieve the cond attribute.
String	getEvent() Retrieve the event attribute.
String	getName() Retrieve the name attribute.
String	getState() Retrieve the state 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	setCond(String cond) Set the cond attribute.
void	setEvent(String event) Set the event attribute.
void	setName(String name) Set the name attribute.
void	setState(String state) Set the state 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_COND

public static final String ATTRIBUTE_COND

An ECMAScript expression which can be evaluated to true or false. If this attribute is present, it must evaluate to true for the transition to be selected. Note: You can not access the value of a the variable listed in the name attribute as it will not do the assign until the transition has been selected.

See Also:

Constant Field Values

ATTRIBUTE_EVENT

public static final String ATTRIBUTE_EVENT

This is a pattern that indicates a matching event type. Event types are dot-separated strings of arbitrary length. The character * is a wild-card, and will match zero or more characters of the processed event's type name.

See Also:

Constant Field Values

ATTRIBUTE_NAME

public static final String ATTRIBUTE_NAME

An ECMAScript left hand side expression evaluating to a previously defined variable. The value of the attribute will be set to the received event object. The event object can only be referenced by this name while executing the transition .

See Also:

Constant Field Values

ATTRIBUTE_STATE

public static final String ATTRIBUTE_STATE

This indicates the current possible state(s) of the eventprocessor . More than one state name may be specified, separated by white space.

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

Transition

public Transition()

Construct a new transition object without a node.

This is necessary for the node factory.

See Also:

VoiceXmlNodeFactory

Transition

Transition(Node node)

Construct a new transition 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.

getCond

public String getCond()

Retrieve the cond attribute.

Returns:

Value of the cond attribute.

See Also:

ATTRIBUTE_COND

setCond

public void setCond(String cond)

Set the cond attribute.

Parameters:

cond - Value of the cond attribute.

See Also:

ATTRIBUTE_COND

getEvent

public String getEvent()

Retrieve the event attribute.

Returns:

Value of the event attribute.

See Also:

ATTRIBUTE_EVENT

setEvent

public void setEvent(String event)

Set the event attribute.

Parameters:

event - Value of the event attribute.

See Also:

ATTRIBUTE_EVENT

getName

public String getName()

Retrieve the name attribute.

Returns:

Value of the name attribute.

See Also:

ATTRIBUTE_NAME

setName

public void setName(String name)

Set the name attribute.

Parameters:

name - Value of the name attribute.

See Also:

ATTRIBUTE_NAME

getState

public String getState()

Retrieve the state attribute.

Returns:

Value of the state attribute.

See Also:

ATTRIBUTE_STATE

setState

public void setState(String state)

Set the state attribute.

Parameters:

state - Value of the state attribute.

See Also:

ATTRIBUTE_STATE

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