org.jvoicexml.xml.ccxml
Class Merge

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

All Implemented Interfaces:

XmlWritable, Node

public final class Merge
extends CcxmlNode

The <merge> element allows two calls being handled by a particular CCXML session to be merged together at the network level, if supported by the underlying network and CCXML platform. If successful, the two referenced calls will be merged at the network level, and the connections to the CCXML platform associated with those calls will be terminated. A connection.merged event will be generated on each of the two calls affected by a merge. If the merge fails, then a single error.merge event will be thrown which identifies both of the connections against which the merge was performed.

Version:

$Revision: 1.4 $

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

Author:

Steve Doyle

Field Summary

static String	ATTRIBUTE_CONNECTIONID1 An ECMAScript expression which returns a string that is the identifier of the first connection that is to be merged.
static String	ATTRIBUTE_CONNECTIONID2 An ECMAScript expression which returns a string that is the identifier of the second connection that is to be merged.
static String	ATTRIBUTE_HINTS The ECMAScript object returned contains information which may be used by the implementing platform or passed to the network when merging the two connections.
protected static ArrayList<String>	ATTRIBUTE_NAMES Supported attribute names for this node.
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

Merge()
Construct a new merge object without a node.

Merge(Node node)
Construct a new merge 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	getConnectionid1() Retrieve the connectionid1 attribute.
String	getConnectionid2() Retrieve the connectionid2 attribute.
String	getHints() Retrieve the hints 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	setConnectionid1(String connectionid1) Set the connectionid1 attribute.
void	setConnectionid2(String connectionid2) Set the connectionid2 attribute.
void	setHints(String hints) Set the hints 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_CONNECTIONID1

public static final String ATTRIBUTE_CONNECTIONID1

An ECMAScript expression which returns a string that is the identifier of the first connection that is to be merged. The order (connectionid1 vs. connectionid2) of the Connections does not matter. If the attribute value is invalid an error.semantic event will be thrown.

See Also:

Constant Field Values

ATTRIBUTE_CONNECTIONID2

public static final String ATTRIBUTE_CONNECTIONID2

An ECMAScript expression which returns a string that is the identifier of the second connection that is to be merged. If the attribute value is invalid an error.semantic event will be thrown.

See Also:

Constant Field Values

ATTRIBUTE_HINTS

public static final String ATTRIBUTE_HINTS

The ECMAScript object returned contains information which may be used by the implementing platform or passed to the network when merging the two connections. This information MAY consist of protocol-specific parameters. Note: The meaning of these hints is specific to the implementing platform and the underlying protocol.

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

Merge

public Merge()

Construct a new merge object without a node.

This is necessary for the node factory.

See Also:

VoiceXmlNodeFactory

Merge

Merge(Node node)

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

getConnectionid1

public String getConnectionid1()

Retrieve the connectionid1 attribute.

Returns:

Value of the connectionid1 attribute.

See Also:

ATTRIBUTE_CONNECTIONID1

setConnectionid1

public void setConnectionid1(String connectionid1)

Set the connectionid1 attribute.

Parameters:

connectionid1 - Value of the connectionid1 attribute.

See Also:

ATTRIBUTE_CONNECTIONID1

getConnectionid2

public String getConnectionid2()

Retrieve the connectionid2 attribute.

Returns:

Value of the connectionid2 attribute.

See Also:

ATTRIBUTE_CONNECTIONID2

setConnectionid2

public void setConnectionid2(String connectionid2)

Set the connectionid2 attribute.

Parameters:

connectionid2 - Value of the connectionid2 attribute.

See Also:

ATTRIBUTE_CONNECTIONID2

getHints

public String getHints()

Retrieve the hints attribute.

Returns:

Value of the hints attribute.

See Also:

ATTRIBUTE_HINTS

setHints

public void setHints(String hints)

Set the hints attribute.

Parameters:

hints - Value of the hints attribute.

See Also:

ATTRIBUTE_HINTS

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