org.jvoicexml.xml.pls

Class Lexeme

java.lang.Object

org.jvoicexml.xml.AbstractXmlNode

org.jvoicexml.xml.pls.Lexeme

All Implemented Interfaces:

PlsNode, XmlNode, org.w3c.dom.Node

public final class Lexeme
extends AbstractXmlNode

The <lexeme> element is a container for a lexical entry which MAY include multiple orthographies and multiple pronunciation information.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.util.ArrayList<java.lang.String>	ATTRIBUTE_NAMES Supported attribute names for this node.
static java.lang.String	ATTRIBUTE_ROLE The OPTIONAL role attribute which takes as its value one or more white space separated QNames as defined in Section 4 of Namespaces in XML (1.0 or 1.1, depending on the version of XML being used).
static java.lang.String	ATTRIBUTE_XML_ID The OPTIONAL xml:id [XML-ID] attribute allows the element to be referenced from other documents (through fragment identifiers or XPointer, for instance).
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
Lexeme() 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.util.Collection<java.lang.String>	getAttributeNames() Returns a collection of permitted attribute names for the node.
java.lang.String	getRole() Retrieve the role attribute.
java.lang.String	getTagName() Get the name of the tag for the derived node.
java.lang.String	getXmlId() Retrieve the xml:id attribute.
XmlNode	newInstance(org.w3c.dom.Node n, XmlNodeFactory<? extends XmlNode> factory) Create a new instance for the given node.
void	setRole(java.lang.String role) Set the xml:lang attribute.
void	setXmlId(java.lang.String xmlId) Set the xml:id 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_XML_ID

public static final java.lang.String ATTRIBUTE_XML_ID

The OPTIONAL xml:id [XML-ID] attribute allows the element to be referenced from other documents (through fragment identifiers or XPointer, for instance). For example, developers may use external RDF statements to associate metadata (such as part of speech or word relationships) with a lexeme.

See Also:

Constant Field Values

ATTRIBUTE_ROLE

public static final java.lang.String ATTRIBUTE_ROLE

The OPTIONAL role attribute which takes as its value one or more white space separated QNames as defined in Section 4 of Namespaces in XML (1.0 or 1.1, depending on the version of XML being used).

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

Lexeme

public Lexeme()

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

getXmlId

public java.lang.String getXmlId()

Retrieve the xml:id attribute.

Returns:

value of the xml:id attribute.

See Also:

ATTRIBUTE_XML_ID

setXmlId

public void setXmlId(java.lang.String xmlId)

Set the xml:id attribute.

Parameters:

xmlId - value of the xml:id attribute.

See Also:

ATTRIBUTE_XML_ID

getRole

public java.lang.String getRole()

Retrieve the role attribute.

Returns:

Value of the role attribute.

See Also:

ATTRIBUTE_ROLE

setRole

public void setRole(java.lang.String role)

Set the xml:lang attribute.

Parameters:

role - Value of the xml:lang attribute.

See Also:

ATTRIBUTE_ROLE

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