org.jvoicexml.xml.pls

Class Lexicon

java.lang.Object

org.jvoicexml.xml.AbstractXmlNode

org.jvoicexml.xml.pls.Lexicon

All Implemented Interfaces:

PlsNode, XmlNode, org.w3c.dom.Node

public final class Lexicon
extends AbstractXmlNode

The root element of the Pronunciation Lexicon markup language is the <lexicon> element. This element is the container for all other elements of the PLS language. A <lexicon> element MUST contain zero or more <meta> elements, followed by an OPTIONAL <metadata> element, followed by zero or more <lexeme> elements. Note that a PLS document without any <lexeme> elements may be useful as a placeholder for future lexical entries.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTRIBUTE_ALPHABET The <lexicon> element MUST specify an alphabet attribute which indicates the default pronunciation alphabet to be used within the PLS document.
protected static java.util.ArrayList<java.lang.String>	ATTRIBUTE_NAMES Supported attribute names for this node.
static java.lang.String	ATTRIBUTE_VERSION The REQUIRED version attribute indicates the version of the specification to be used for the document and MUST have the value "1.0".
static java.lang.String	ATTRIBUTE_XML_BASE The OPTIONAL xml:base attribute establishes a base URI for the PLS document.
static java.lang.String	ATTRIBUTE_XML_LANG The REQUIRED xml:lang attribute allows identification of the language for which the pronunciation lexicon is relevant.
static java.lang.String	ATTRIBUTE_XMLNS The namespace URI for PLS is "http://www.w3.org/2005/01/pronunciation-lexicon".
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
Lexicon() Construct a new lexicon 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.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	getTagName() Get the name of the tag for the derived node.
java.lang.String	getVersion() Retrieve the version attribute.
java.lang.String	getXmlBase() Retrieve the xml:base attribute.
java.lang.String	getXmlLang() Retrieve the xml:lang attribute.
java.lang.String	getXmlns() Retrieve the xmlns attribute.
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	setVersion(java.lang.String version) Set the version attribute.
void	setXmlBase(java.lang.String xmlBase) Set the xml:base attribute.
void	setXmlLang(java.lang.String xmlLang) Set the xml:lang attribute.
void	setXmlns(java.lang.String xmlBase) Set the xml:base 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_VERSION

public static final java.lang.String ATTRIBUTE_VERSION

The REQUIRED version attribute indicates the version of the specification to be used for the document and MUST have the value "1.0".

See Also:

Constant Field Values

ATTRIBUTE_XML_LANG

public static final java.lang.String ATTRIBUTE_XML_LANG

The REQUIRED xml:lang attribute allows identification of the language for which the pronunciation lexicon is relevant.

See Also:

Constant Field Values

ATTRIBUTE_XML_BASE

public static final java.lang.String ATTRIBUTE_XML_BASE

The OPTIONAL xml:base attribute establishes a base URI for the PLS document.

See Also:

Constant Field Values

ATTRIBUTE_XMLNS

public static final java.lang.String ATTRIBUTE_XMLNS

The namespace URI for PLS is "http://www.w3.org/2005/01/pronunciation-lexicon". All PLS markup MUST be associated with the PLS namespace.

See Also:

Constant Field Values

ATTRIBUTE_ALPHABET

public static final java.lang.String ATTRIBUTE_ALPHABET

The <lexicon> element MUST specify an alphabet attribute which indicates the default pronunciation alphabet to be used within the PLS document.

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

Lexicon

public Lexicon()

Construct a new lexicon 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

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

getXmlLang

public java.lang.String getXmlLang()

Retrieve the xml:lang attribute.

Returns:

Value of the xml:lang attribute.

See Also:

ATTRIBUTE_XML_LANG

setXmlLang

public void setXmlLang(java.lang.String xmlLang)

Set the xml:lang attribute.

Parameters:

xmlLang - Value of the xml:lang attribute.

See Also:

ATTRIBUTE_XML_LANG

getXmlBase

public java.lang.String getXmlBase()

Retrieve the xml:base attribute.

Returns:

Value of the xml:base attribute.

See Also:

ATTRIBUTE_XML_BASE

setXmlBase

public void setXmlBase(java.lang.String xmlBase)

Set the xml:base attribute.

Parameters:

xmlBase - Value of the xml:base attribute.

See Also:

ATTRIBUTE_XML_BASE

getXmlns

public java.lang.String getXmlns()

Retrieve the xmlns attribute.

Returns:

Value of the xmlns attribute.

See Also:

ATTRIBUTE_XMLNS

setXmlns

public void setXmlns(java.lang.String xmlBase)

Set the xml:base attribute.

Parameters:

xmlBase - Value of the xml:base attribute.

See Also:

ATTRIBUTE_XMLNS

getVersion

public java.lang.String getVersion()

Retrieve the version attribute.

Returns:

Value of the version attribute.

See Also:

ATTRIBUTE_VERSION

setVersion

public void setVersion(java.lang.String version)

Set the version attribute.

Parameters:

version - Value of the version attribute.

See Also:

ATTRIBUTE_VERSION

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