org.jvoicexml.xml.srgs
Class Ruleref

java.lang.Object
  org.jvoicexml.xml.AbstractXmlNode
      org.jvoicexml.xml.srgs.Ruleref

All Implemented Interfaces:

SrgsNode, VoiceXmlNode, XmlNode, XmlWritable, Node

public final class Ruleref
extends AbstractXmlNode
implements VoiceXmlNode

Refer to a rule defined locally or externally.

Version:

$Revision: 197 $

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

Author:

Steve Doyle

Field Summary

protected static ArrayList<String>	ATTRIBUTE_NAMES Supported attribute names for this node.
static 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 String	ATTRIBUTE_TYPE The optional type attribute specifies the media type of the grammar containing the reference.
static String	ATTRIBUTE_URI URI of grammar where the rule is defined.
static 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

Ruleref()
Construct a new ruleref object without a node.

Method Summary

protected boolean	canContainChild(String tagName) Can the specified sub-tag be contained within this node?
Collection<String>	getAttributeNames() Returns a collection of permitted attribute names for the node.
NodeList	getChildNodes() A NodeList that contains all children of this node.
String	getSpecial() Retrieve the special attribute.
String	getTagName() Get the name of the tag for the derived node.
String	getType() Retrieve the type attribute.
String	getUri() Retrieve the uri attribute.
VoiceXmlNode	newInstance(Node n) Create a new instance for the given node.
void	setSpecial(String special) Set the special attribute.
void	setType(String type) Set the type attribute.
void	setUri(String uri) Set the uri attribute.

Methods inherited from class org.jvoicexml.xml.AbstractXmlNode

addChild, addChild, appendChild, cloneNode, compareDocumentPosition, getAttribute, 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, writeXml

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, getChildNodes, getNode, setAttribute

Methods inherited from interface org.jvoicexml.xml.XmlWritable

writeChildrenXml, writeXml

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 String TAG_NAME

Name of the tag.

See Also:

Constant Field Values

ATTRIBUTE_URI

public static final String ATTRIBUTE_URI

URI of grammar where the rule is defined.

See Also:

Constant Field Values

ATTRIBUTE_TYPE

public static final 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 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

ATTRIBUTE_NAMES

protected static final ArrayList<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:

VoiceXmlNodeFactory

Method Detail

getTagName

public 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 VoiceXmlNode newInstance(Node n)

Create a new instance for the given node.

Specified by:

newInstance in interface XmlNode

Parameters:

n - The node to encapsulate.

Returns:

The new instance.

See Also:

XmlNodeFactory

getUri

public String getUri()

Retrieve the uri attribute.

Returns:

Value of the uri attribute.

See Also:

ATTRIBUTE_URI

setUri

public void setUri(String uri)

Set the uri attribute.

Parameters:

uri - Value of the uri attribute.

See Also:

ATTRIBUTE_URI

getType

public String getType()

Retrieve the type attribute.

Returns:

Value of the type attribute.

See Also:

ATTRIBUTE_TYPE

setType

public void setType(String type)

Set the type attribute.

Parameters:

type - Value of the type attribute.

See Also:

ATTRIBUTE_TYPE

getSpecial

public String getSpecial()

Retrieve the special attribute.

Returns:

Value of the special attribute.

See Also:

ATTRIBUTE_SPECIAL

setSpecial

public void setSpecial(String special)

Set the special attribute.

Parameters:

special - Value of the special attribute.

See Also:

ATTRIBUTE_SPECIAL

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:

True if the sub-tag is allowed on this node.

getAttributeNames

public Collection<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

getChildNodes

public final NodeList getChildNodes()

A NodeList that contains all children of this node.

Specified by:

getChildNodes in interface Node

Returns:

NodeList