org.jvoicexml.xml.pls

Class Phoneme

java.lang.Object

org.jvoicexml.xml.AbstractXmlNode

org.jvoicexml.xml.pls.Phoneme

All Implemented Interfaces:

PlsNode, XmlNode, org.w3c.dom.Node

public final class Phoneme
extends AbstractXmlNode

A <lexeme> MAY contain one or more <phoneme> elements. The <phoneme> element contains text describing how the <lexeme> is pronounced.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTRIBUTE_ALPHABET A <phoneme> element MAY have an alphabet attribute, which indicates the pronunciation alphabet that is used for this <phoneme> element only.
protected static java.util.ArrayList<java.lang.String>	ATTRIBUTE_NAMES Supported attribute names for this node.
static java.lang.String	ATTRIBUTE_PREFER The prefer is an OPTIONAL attribute, which indicates the pronunciation that MUST be used by a speech synthesis engine when it is set to "true".
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
Phoneme() Construct a new object without a node.

Method Summary

Modifier and Type	Method and Description
Text	addText(java.lang.String text) Create a new text within this grapheme element.
protected boolean	canContainChild(java.lang.String tagName) Can the specified sub-tag be contained within this node?
java.lang.String	getAlpabet() Retrieve the alphabet attribute.
java.util.Collection<java.lang.String>	getAttributeNames() Returns a collection of permitted attribute names for the node.
java.lang.String	getPrefer() Retrieve the prefer 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	setAlphabet(java.lang.String alphabet) Set the alphabet attribute.
void	setPrefer(java.lang.String prefer) Set the prefer 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_PREFER

public static final java.lang.String ATTRIBUTE_PREFER

The prefer is an OPTIONAL attribute, which indicates the pronunciation that MUST be used by a speech synthesis engine when it is set to "true". The possible values are: "true" or "false". The default value is "false".

See Also:

Constant Field Values

ATTRIBUTE_ALPHABET

public static final java.lang.String ATTRIBUTE_ALPHABET

A <phoneme> element MAY have an alphabet attribute, which indicates the pronunciation alphabet that is used for this <phoneme> element only.

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

Phoneme

public Phoneme()

Construct a new object without a node.

This is necessary for the node factory.

See Also:

PlsNodeFactory

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

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.

addText

public Text addText(java.lang.String text)

Create a new text within this grapheme element.

Parameters:

text - The text to be added.

Returns:

The new created text.

getPrefer

public java.lang.String getPrefer()

Retrieve the prefer attribute.

Returns:

Value of the version attribute.

See Also:

ATTRIBUTE_PREFER

setPrefer

public void setPrefer(java.lang.String prefer)

Set the prefer attribute.

Parameters:

prefer - Value of the prefer attribute.

See Also:

ATTRIBUTE_PREFER

getAlpabet

public java.lang.String getAlpabet()

Retrieve the alphabet attribute.

Returns:

value of the alphabet attribute.

See Also:

ATTRIBUTE_ALPHABET

setAlphabet

public void setAlphabet(java.lang.String alphabet)

Set the alphabet attribute.

Parameters:

alphabet - value of the alphabet attribute.

See Also:

ATTRIBUTE_ALPHABET

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