org.jvoicexml.xml

Interface XmlNode

All Superinterfaces:

org.w3c.dom.Node

All Known Subinterfaces:

CcxmlNode, PlsNode, ScxmlNode, SrgsNode, SsmlNode, TextContainer, VoiceXmlNode

All Known Implementing Classes:

AbstractCatchElement, AbstractXmlDocumentType, AbstractXmlNode, Accept, Alias, Assign, Assign, Assign, Audio, Block, Break, Cancel, Cancel, Catch, Ccxml, Choice, Clear, Content, Createcall, Createccxml, Createconference, Data, Data, Datamodel, Desc, Destroyconference, Dialogprepare, Dialogstart, Dialogterminate, Disconnect, Disconnect, Donedata, Else, Else, Else, Elseif, Elseif, Elseif, Emphasis, Enumerate, Error, Eventprocessor, Example, Example, Exit, Exit, Fetch, Field, Filled, Final, Finalize, Foreach, Foreach, Form, Goto, Goto, Grammar, Grapheme, Help, History, If, If, If, Initial, Initial, Invoke, Item, Join, Lexeme, Lexicon, Lexicon, Lexicon, Link, Log, Log, Log, Mark, Menu, Merge, Meta, Meta, Meta, Meta, Metadata, Metadata, Metadata, Metadata, Move, Noinput, Nomatch, ObjectTag, Onentry, OneOf, Onexit, Option, P, Parallel, Param, Param, Phoneme, Phoneme, Prompt, Property, Prosody, Raise, Record, Redirect, Reject, Reprompt, Return, Rule, Ruleref, S, SayAs, Script, Script, Script, Scxml, Send, Send, Speak, State, Sub, Subdialog, Submit, Tag, Text, Throw, Token, Transfer, Transition, Transition, Unjoin, Validate, Value, Var, Var, Voice, VoiceXml20DocumentType, VoiceXml21DocumentType, VoiceXmlComment, Vxml, XmlCDataSection

public interface XmlNode
extends org.w3c.dom.Node

Base interface for all nodes in an XML document.

Since:

0.5

See Also:

XmlDocument

Field Summary

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

Method Summary

Modifier and Type	Method and Description
XmlNode	addChild(java.lang.String tagName) Adds an instance of the specified child class to this node.
java.lang.String	getAttribute(java.lang.String attribute) Convenient method to get the value of an attribute.
java.util.Collection<java.lang.String>	getAttributeNames() Returns a collection of permitted attribute names for the node.
<T extends XmlNode> java.util.Collection<T>	getChildNodes(java.lang.Class<T> tagClass) Return a collection of child nodes with the specified tag class.
<T extends XmlNode> java.util.Collection<T>	getChildren() Return a collection of all child nodes.
org.w3c.dom.Node	getNode() Retrieves the encapsulated node.
java.lang.String	getTagName() Retrieves 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	setAttribute(java.lang.String name, java.lang.String value) Convenient method to set the value of an attribute.

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

Method Detail

getNode

org.w3c.dom.Node getNode()

Retrieves the encapsulated node.

Returns:

The encapsulated node.

getTagName

java.lang.String getTagName()

Retrieves the name of the tag for the derived node.

Returns:

The name of the tag.

newInstance

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

addChild

XmlNode addChild(java.lang.String tagName)

Adds an instance of the specified child class to this node. This causes a new node to be created and appended to this node. The type of the node to add must be a subclass of the XmlNode class.

Parameters:

tagName - the tag name of the node to add without any attributes.

Returns:

Newly created and appended node or null if the child is not allowed on this node.

getAttribute

java.lang.String getAttribute(java.lang.String attribute)

Convenient method to get the value of an attribute.

Parameters:

attribute - Name of the attribute.

Returns:

Value of theattribute, null if the value of the attribute cannot be retrieved.

setAttribute

void setAttribute(java.lang.String name,
                  java.lang.String value)

Convenient method to set the value of an attribute. If the assigned value is null then the attribute is removed.

Parameters:

name - Name of the attribute.

value - New value of the attribute or null to remove the attribute.

getAttributeNames

java.util.Collection<java.lang.String> getAttributeNames()

Returns a collection of permitted attribute names for the node.

Returns:

A collection of attribute names that are allowed for the node

Since:

0.3.1

getChildNodes

<T extends XmlNode> java.util.Collection<T> getChildNodes(java.lang.Class<T> tagClass)

Return a collection of child nodes with the specified tag class.

Type Parameters:

T - Type of the child nodes.

Parameters:

tagClass - Class of child node to return.

Returns:

A collection of child nodes of the specified type. If this node does not contain any child nodes of the specified type then an empty collection is returned.

Since:

0.5

getChildren

<T extends XmlNode> java.util.Collection<T> getChildren()

Return a collection of all child nodes.

Type Parameters:

T - Type of the child nodes.

Returns:

A collection of child nodes of the specified type. If this node does not contain any child nodes of the specified type then an empty collection is returned.

Since:

0.6