org.jvoicexml.xml.srgs

Class Meta

java.lang.Object

org.jvoicexml.xml.AbstractXmlNode

org.jvoicexml.xml.srgs.Meta

All Implemented Interfaces:

SrgsNode, XmlNode, org.w3c.dom.Node

public final class Meta
extends AbstractXmlNode

Define a metadata item as a name/value pair.

The <meta> element specifies meta information. There are two types of <meta>.

The first type specifies a metadata property of the document as a whole and is expressed by the pair of attributes, name and content.

The second type of <meta> specifies HTTP response headers and is expressed by the pair of attributes http-equiv and content.

Since:

0.6

See Also:

Metadata

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTRIBUTE_CONTENT The value of the metadata property.
static java.lang.String	ATTRIBUTE_HTTP_EQUIV The name of an HTTP response header.
static java.lang.String	ATTRIBUTE_NAME The name of the metadata property.
protected static java.util.ArrayList<java.lang.String>	ATTRIBUTE_NAMES Supported attribute names for this node.
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
Meta() Construct a new meta 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	getContent() Retrieve the content attribute.
java.lang.String	getHttpEquiv() Retrieve the http-equiv attribute.
java.lang.String	getName() Retrieve the name 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	setContent(java.lang.String content) Set the content attribute.
void	setHttpEquiv(java.lang.String httpEquiv) Set the http-equiv attribute.
void	setName(java.lang.String name) Set the name 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_NAME

public static final java.lang.String ATTRIBUTE_NAME

The name of the metadata property.

See Also:

Constant Field Values

ATTRIBUTE_CONTENT

public static final java.lang.String ATTRIBUTE_CONTENT

The value of the metadata property.

See Also:

Constant Field Values

ATTRIBUTE_HTTP_EQUIV

public static final java.lang.String ATTRIBUTE_HTTP_EQUIV

The name of an HTTP response header.

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

Meta

public Meta()

Construct a new meta 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.

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

getName

public java.lang.String getName()

Retrieve the name attribute.

Returns:

Value of the name attribute.

See Also:

ATTRIBUTE_NAME

setName

public void setName(java.lang.String name)

Set the name attribute.

Parameters:

name - Value of the name attribute.

See Also:

ATTRIBUTE_NAME

getContent

public java.lang.String getContent()

Retrieve the content attribute.

Returns:

Value of the content attribute.

See Also:

ATTRIBUTE_CONTENT

setContent

public void setContent(java.lang.String content)

Set the content attribute.

Parameters:

content - Value of the content attribute.

See Also:

ATTRIBUTE_CONTENT

getHttpEquiv

public java.lang.String getHttpEquiv()

Retrieve the http-equiv attribute.

Returns:

Value of the http-equiv attribute.

See Also:

ATTRIBUTE_HTTP_EQUIV

setHttpEquiv

public void setHttpEquiv(java.lang.String httpEquiv)

Set the http-equiv attribute.

Parameters:

httpEquiv - Value of the http-equiv attribute.

See Also:

ATTRIBUTE_HTTP_EQUIV

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