org.jvoicexml.xml
Class Text

java.lang.Object
  org.jvoicexml.xml.AbstractXmlNode
      org.jvoicexml.xml.Text

All Implemented Interfaces:

SrgsNode, SsmlNode, VoiceXmlNode, XmlNode, XmlWritable, Node

Direct Known Subclasses:

XmlCDataSection

public class Text
extends AbstractXmlNode
implements VoiceXmlNode, SrgsNode, SsmlNode

Implementation of a text node.

Version:

$Revision: 211 $

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

Author:

Dirk Schnelle

Field Summary

static String

TAG_NAME Name of the block 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

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

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

Text()
Constructs a new text object without a node.

Text(Node n, XmlNodeFactory<? extends XmlNode> nodeFactory)
Construct a new text object.

Method Summary

protected boolean	canContainChild(String tagName) Can the specified sub-tag be contained within this node?
NodeList	getChildNodes()
String	getTagName() Retrieves the name of the tag for the derived node.
XmlNode	newInstance(Node n) Create a new instance for the given node.
void	writeXml(XmlWriter writer) This is the primary method used to write an object and its children as XML text.

Methods inherited from class org.jvoicexml.xml.AbstractXmlNode

addChild, addChild, appendChild, cloneNode, compareDocumentPosition, getAttribute, getAttributeNames, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNode, getNodeFactory, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setAttribute, setNodeValue, setPrefix, setTextContent, setUserData, toString, writeChildrenXml

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jvoicexml.xml.XmlNode

addChild, getAttribute, getAttributeNames, getChildNodes, getNode, setAttribute

Methods inherited from interface org.jvoicexml.xml.XmlWritable

writeChildrenXml

Methods inherited from interface org.w3c.dom.Node

appendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, 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

Methods inherited from interface org.jvoicexml.xml.XmlNode

addChild, getAttribute, getAttributeNames, getChildNodes, getNode, setAttribute

Methods inherited from interface org.jvoicexml.xml.XmlWritable

writeChildrenXml

Methods inherited from interface org.w3c.dom.Node

appendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, 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

Methods inherited from interface org.jvoicexml.xml.XmlNode

addChild, getAttribute, getAttributeNames, getChildNodes, getNode, setAttribute

Methods inherited from interface org.jvoicexml.xml.XmlWritable

writeChildrenXml

Methods inherited from interface org.w3c.dom.Node

appendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, 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 String TAG_NAME

Name of the block tag.

See Also:

Constant Field Values

Constructor Detail

Text

public Text()

Constructs a new text object without a node.

This is necessary for the node factory.

See Also:

XmlNodeFactory

Text

public Text(Node n,
            XmlNodeFactory<? extends XmlNode> nodeFactory)

Construct a new text object.

Parameters:

n - The encapsulated node.

nodeFactory - The node factory.

Method Detail

getTagName

public String getTagName()

Retrieves the name of the tag for the derived node.

Specified by:

getTagName in interface XmlNode

Returns:

The name of the tag.

writeXml

public void writeXml(XmlWriter writer)
              throws IOException

This is the primary method used to write an object and its children as XML text. Implementations with children should use writeChildrenXml to write those children, to allow selective overriding.

Specified by:

writeXml in interface XmlWritable

Overrides:

writeXml in class AbstractXmlNode

Parameters:

writer - XMLWriter used when writing XML text.

Throws:

IOException - Error in writing.

newInstance

public XmlNode newInstance(Node n)

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.

Specified by:

newInstance in interface XmlNode

Parameters:

n - The node to encapsulate.

Returns:

The new instance.

See Also:

XmlNodeFactory

canContainChild

protected boolean canContainChild(String tagName)

Can the specified sub-tag be contained within this node?

Specified by:

canContainChild in class AbstractXmlNode

Parameters:

tagName - Name of child.

Returns:

false since this tag cannot contain child nodes.

getChildNodes

public final NodeList getChildNodes()

Specified by:

getChildNodes in interface Node