org.jvoicexml.xml.srgs

Class Ruleref

java.lang.Object

org.jvoicexml.xml.AbstractXmlNode

org.jvoicexml.xml.srgs.Ruleref

All Implemented Interfaces:

SrgsNode, VoiceXmlNode, XmlNode, org.w3c.dom.Node

public final class Ruleref
extends AbstractXmlNode
implements VoiceXmlNode

Refer to a rule defined locally or externally.

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_SPECIAL Identifies the rule as being a special rule which is defined to have specific interpretation and processing by a speech recogniser.
static java.lang.String	ATTRIBUTE_TYPE The optional type attribute specifies the media type of the grammar containing the reference.
static java.lang.String	ATTRIBUTE_URI URI of grammar where the rule is defined.
static java.lang.String	SPECIAL_VALUE_GARBAGE special rule - GARBAGE.
static java.lang.String	SPECIAL_VALUE_NULL special rule - NULL.
static java.lang.String	SPECIAL_VALUE_VOID special rule - VOID.
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
Ruleref() Construct a new ruleref 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	getSpecial() Retrieve the special attribute.
java.lang.String	getTagName() Get the name of the tag for the derived node.
java.lang.String	getType() Retrieve the type attribute.
java.lang.String	getUri() Retrieves the URI attribute.
java.net.URI	getUriObject() Retrieves the URI attribute.
boolean	isSpecialGarbage() Tests if this RuleRef is a special GARBAGE rule.
boolean	isSpecialNull() Tests if this RuleRef is a special NULL rule.
boolean	isSpecialVoid() Tests if this RuleRef is a special VOID rule.
XmlNode	newInstance(org.w3c.dom.Node n, XmlNodeFactory<? extends XmlNode> factory) Create a new instance for the given node.
void	setSpecial(java.lang.String special) Set the special attribute.
void	setType(java.lang.String type) Set the type attribute.
void	setUri(Rule rule) Sets the URI attribute to the rule in the same document.
void	setUri(java.lang.String uri) Sets the URI attribute.
void	setUri(java.net.URI uri) Sets the URI 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_URI

public static final java.lang.String ATTRIBUTE_URI

URI of grammar where the rule is defined.

See Also:

Constant Field Values

ATTRIBUTE_TYPE

public static final java.lang.String ATTRIBUTE_TYPE

The optional type attribute specifies the media type of the grammar containing the reference.

See Also:

Constant Field Values

ATTRIBUTE_SPECIAL

public static final java.lang.String ATTRIBUTE_SPECIAL

Identifies the rule as being a special rule which is defined to have specific interpretation and processing by a speech recogniser.

See Also:

Constant Field Values

SPECIAL_VALUE_GARBAGE

public static final java.lang.String SPECIAL_VALUE_GARBAGE

special rule - GARBAGE.

See Also:

Speech Recognition Grammar Specification Version 1.0 - 2.2.3 Special Rules, Constant Field Values

SPECIAL_VALUE_NULL

public static final java.lang.String SPECIAL_VALUE_NULL

special rule - NULL.

See Also:

Speech Recognition Grammar Specification Version 1.0 - 2.2.3 Special Rules, Constant Field Values

SPECIAL_VALUE_VOID

public static final java.lang.String SPECIAL_VALUE_VOID

special rule - VOID.

See Also:

Speech Recognition Grammar Specification Version 1.0 - 2.2.3 Special Rules, Constant Field Values

ATTRIBUTE_NAMES

protected static final java.util.ArrayList<java.lang.String> ATTRIBUTE_NAMES

Supported attribute names for this node.

Constructor Detail

Ruleref

public Ruleref()

Construct a new ruleref object without a node.

This is necessary for the node factory.

See Also:

SrgsNodeFactory

Method Detail

getTagName

public java.lang.String getTagName()

Get the name of the tag for the derived node.

Specified by:

getTagName in interface XmlNode

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.

Specified by:

newInstance in interface XmlNode

Parameters:

n - The node to encapsulate.

factory - the factroy that calls this method.

Returns:

The new instance.

See Also:

XmlNodeFactory

getUri

public java.lang.String getUri()

Retrieves the URI attribute.

Returns:

Value of the URI attribute.

See Also:

ATTRIBUTE_URI

getUriObject

public java.net.URI getUriObject()
                          throws java.net.URISyntaxException

Retrieves the URI attribute.

Returns:

Value of the URI attribute.

Throws:

java.net.URISyntaxException - Value is not a valid URI.

Since:

0.7.1

See Also:

ATTRIBUTE_URI

setUri

public void setUri(java.lang.String uri)

Sets the URI attribute.

Parameters:

uri - Value of the URI attribute.

See Also:

ATTRIBUTE_URI

setUri

public void setUri(java.net.URI uri)

Sets the URI attribute.

Parameters:

uri - Value of the URI attribute.

Since:

0.7.1

See Also:

ATTRIBUTE_URI

setUri

public void setUri(Rule rule)

Sets the URI attribute to the rule in the same document.

Parameters:

rule - the rule to reference

See Also:

ATTRIBUTE_URI

getType

public java.lang.String getType()

Retrieve the type attribute.

Returns:

Value of the type attribute.

See Also:

ATTRIBUTE_TYPE

setType

public void setType(java.lang.String type)

Set the type attribute.

Parameters:

type - Value of the type attribute.

See Also:

ATTRIBUTE_TYPE

getSpecial

public java.lang.String getSpecial()

Retrieve the special attribute.

Returns:

Value of the special attribute.

See Also:

ATTRIBUTE_SPECIAL

setSpecial

public void setSpecial(java.lang.String special)

Set the special attribute.

Parameters:

special - Value of the special attribute.

See Also:

ATTRIBUTE_SPECIAL

isSpecialGarbage

public boolean isSpecialGarbage()

Tests if this RuleRef is a special GARBAGE rule.

Returns:

true if this is a GARBAGE rule

Since:

0.7

See Also:

Speech Recognition Grammar Specification Version 1.0 - 2.2.3 Special Rules

isSpecialVoid

public boolean isSpecialVoid()

Tests if this RuleRef is a special VOID rule.

Returns:

true if this is a VOID rule

Since:

0.7

See Also:

Speech Recognition Grammar Specification Version 1.0 - 2.2.3 Special Rules

isSpecialNull

public boolean isSpecialNull()

Tests if this RuleRef is a special NULL rule.

Returns:

true if this is a NULL rule

Since:

0.7

See Also:

Speech Recognition Grammar Specification Version 1.0 - 2.2.3 Special Rules

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