org.jvoicexml.xml.ccxml

Class Merge

java.lang.Object

org.jvoicexml.xml.AbstractXmlNode

org.jvoicexml.xml.ccxml.Merge

All Implemented Interfaces:

CcxmlNode, XmlNode, org.w3c.dom.Node

public final class Merge
extends AbstractXmlNode

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.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTRIBUTE_CONNECTIONID1 An ECMAScript expression which returns a string that is the identifier of the first connection that is to be merged.
static java.lang.String	ATTRIBUTE_CONNECTIONID2 An ECMAScript expression which returns a string that is the identifier of the second connection that is to be merged.
static java.lang.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 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
Merge() Construct a new merge 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	getConnectionid1() Retrieve the connectionid1 attribute.
java.lang.String	getConnectionid2() Retrieve the connectionid2 attribute.
java.lang.String	getHints() Retrieve the hints attribute.
java.lang.String	getTagName() Get the name of the tag for the derived node.
XmlNode	newInstance(org.w3c.dom.Node n, XmlNodeFactory<? extends XmlNode> factory) Create a new instance for the given node.
void	setConnectionid1(java.lang.String connectionid1) Set the connectionid1 attribute.
void	setConnectionid2(java.lang.String connectionid2) Set the connectionid2 attribute.
void	setHints(java.lang.String hints) Set the hints 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_CONNECTIONID1

public static final java.lang.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 java.lang.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 java.lang.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 java.util.ArrayList<java.lang.String> ATTRIBUTE_NAMES

Supported attribute names 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:

CcxmlNodeFactory

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

getConnectionid1

public java.lang.String getConnectionid1()

Retrieve the connectionid1 attribute.

Returns:

Value of the connectionid1 attribute.

See Also:

ATTRIBUTE_CONNECTIONID1

setConnectionid1

public void setConnectionid1(java.lang.String connectionid1)

Set the connectionid1 attribute.

Parameters:

connectionid1 - Value of the connectionid1 attribute.

See Also:

ATTRIBUTE_CONNECTIONID1

getConnectionid2

public java.lang.String getConnectionid2()

Retrieve the connectionid2 attribute.

Returns:

Value of the connectionid2 attribute.

See Also:

ATTRIBUTE_CONNECTIONID2

setConnectionid2

public void setConnectionid2(java.lang.String connectionid2)

Set the connectionid2 attribute.

Parameters:

connectionid2 - Value of the connectionid2 attribute.

See Also:

ATTRIBUTE_CONNECTIONID2

getHints

public java.lang.String getHints()

Retrieve the hints attribute.

Returns:

Value of the hints attribute.

See Also:

ATTRIBUTE_HINTS

setHints

public void setHints(java.lang.String hints)

Set the hints attribute.

Parameters:

hints - Value of the hints attribute.

See Also:

ATTRIBUTE_HINTS

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