org.jvoicexml.xml.scxml

Class Send

java.lang.Object

org.jvoicexml.xml.AbstractXmlNode

org.jvoicexml.xml.scxml.Send

All Implemented Interfaces:

ScxmlNode, XmlNode, org.w3c.dom.Node

public final class Send
extends AbstractXmlNode

<send> s used to send events and data to external systems, including external SCXML Interpreters, or to raise events in the current SCXML session.

Since:

0.7.6

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.util.ArrayList<java.lang.String>	ATTRIBUTE_NAMES Supported attribute names for this node.
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
Send() Construct a new send 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	getDelay() Retrieves the delay attribute.
java.lang.String	getDelayexpr() Retrieves the delayexpr attribute.
java.lang.String	getEvent() Retrieves the event attribute.
java.lang.String	getEventExpr() Retrieves the eventexpr attribute.
java.lang.String	getId() Retrieves the id attribute.
java.lang.String	getIdlocation() Retrieves the idlocation attribute.
java.lang.String	getNamelist() Retrieves the namelist attribute.
java.lang.String	getTagName() Get the name of the tag for the derived node.
java.lang.String	getTarget() Retrieves the target attribute.
java.lang.String	getTargetexpr() Retrieves the targetexpr attribute.
java.lang.String	getType() Retrieves the type attribute.
java.lang.String	getTypeexpr() Retrieves the typeexpr attribute.
XmlNode	newInstance(org.w3c.dom.Node n, XmlNodeFactory<? extends XmlNode> factory) Create a new instance for the given node.
void	setDelay(java.lang.String delay) Sets the delay attribute.
void	setDelayexpr(java.lang.String delayexpr) Sets the delayexpr attribute.
void	setEvent(java.lang.String event) Sets the event attribute.
void	setEventExpr(java.lang.String eventexpr) Sets the eventexpr attribute.
void	setId(java.lang.String id) Sets the id attribute.
void	setIdlocation(java.lang.String idlocation) Sets the idlocation attribute.
void	setNamelist(java.lang.String namelist) Sets the namelist attribute.
void	setTarget(java.lang.String target) Sets the target attribute.
void	setTargetexpr(java.lang.String targetexpr) Sets the targetexpr attribute.
void	setType(java.lang.String type) Sets the type attribute.
void	setTypeexpr(java.lang.String typeexpr) Sets the typeexpr 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_NAMES

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

Supported attribute names for this node.

Constructor Detail

Send

public Send()

Construct a new send 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

getEvent

public java.lang.String getEvent()

Retrieves the event attribute.

Returns:

value of the event attribute.

See Also:

ATTRIBUTE_EVENT

setEvent

public void setEvent(java.lang.String event)

Sets the event attribute.

Parameters:

event - Value of the event attribute.

See Also:

ATTRIBUTE_EVENT

getEventExpr

public java.lang.String getEventExpr()

Retrieves the eventexpr attribute.

Returns:

value of the eventexpr attribute.

See Also:

ATTRIBUTE_EVENTEXPR

setEventExpr

public void setEventExpr(java.lang.String eventexpr)

Sets the eventexpr attribute.

Parameters:

eventexpr - Value of the eventexpr attribute.

See Also:

ATTRIBUTE_EVENTEXPR

getTarget

public java.lang.String getTarget()

Retrieves the target attribute.

Returns:

value of the target attribute.

See Also:

ATTRIBUTE_TARGET

setTarget

public void setTarget(java.lang.String target)

Sets the target attribute.

Parameters:

target - Value of the target attribute.

See Also:

ATTRIBUTE_TARGET

getTargetexpr

public java.lang.String getTargetexpr()

Retrieves the targetexpr attribute.

Returns:

value of the targetexpr attribute.

See Also:

ATTRIBUTE_TARGETEXPR

setTargetexpr

public void setTargetexpr(java.lang.String targetexpr)

Sets the targetexpr attribute.

Parameters:

targetexpr - Value of the targetexpr attribute.

See Also:

ATTRIBUTE_TARGETEXPR

getType

public java.lang.String getType()

Retrieves the type attribute.

Returns:

value of the type attribute.

See Also:

ATTRIBUTE_TYPE

setType

public void setType(java.lang.String type)

Sets the type attribute.

Parameters:

type - Value of the target attribute.

See Also:

ATTRIBUTE_TYPE

getTypeexpr

public java.lang.String getTypeexpr()

Retrieves the typeexpr attribute.

Returns:

value of the typeexpr attribute.

See Also:

ATTRIBUTE_TYPEEXPR

setTypeexpr

public void setTypeexpr(java.lang.String typeexpr)

Sets the typeexpr attribute.

Parameters:

typeexpr - Value of the target attribute.

See Also:

ATTRIBUTE_TYPEEXPR

getId

public java.lang.String getId()

Retrieves the id attribute.

Returns:

value of the id attribute.

See Also:

ATTRIBUTE_ID

setId

public void setId(java.lang.String id)

Sets the id attribute.

Parameters:

id - Value of the id attribute.

See Also:

ATTRIBUTE_ID

getIdlocation

public java.lang.String getIdlocation()

Retrieves the idlocation attribute.

Returns:

value of the idlocation attribute.

See Also:

ATTRIBUTE_IDLOCATION

setIdlocation

public void setIdlocation(java.lang.String idlocation)

Sets the idlocation attribute.

Parameters:

idlocation - Value of the idlocation attribute.

See Also:

ATTRIBUTE_IDLOCATION

getDelay

public java.lang.String getDelay()

Retrieves the delay attribute.

Returns:

value of the delay attribute.

See Also:

ATTRIBUTE_DELAY

setDelay

public void setDelay(java.lang.String delay)

Sets the delay attribute.

Parameters:

delay - Value of the delay attribute.

See Also:

ATTRIBUTE_DELAY

getDelayexpr

public java.lang.String getDelayexpr()

Retrieves the delayexpr attribute.

Returns:

value of the delayexpr attribute.

See Also:

ATTRIBUTE_DELAYEXPR

setDelayexpr

public void setDelayexpr(java.lang.String delayexpr)

Sets the delayexpr attribute.

Parameters:

delayexpr - Value of the delayexpr attribute.

See Also:

ATTRIBUTE_DELAYEXPR

getNamelist

public java.lang.String getNamelist()

Retrieves the namelist attribute.

Returns:

value of the namelist attribute.

See Also:

ATTRIBUTE_NAMELIST

setNamelist

public void setNamelist(java.lang.String namelist)

Sets the namelist attribute.

Parameters:

namelist - Value of the namelist attribute.

See Also:

ATTRIBUTE_NAMELIST

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