org.jvoicexml.xml.ccxml
Class Meta

java.lang.Object
  extended by org.jvoicexml.xml.AbstractXmlNode
      extended by org.jvoicexml.xml.ccxml.Meta
All Implemented Interfaces:
CcxmlNode, XmlNode, XmlWritable, Node

public final class Meta
extends AbstractXmlNode

The <metadata> and <meta> are containers in which information about the document can be placed. The <metadata> provides more general and powerful treatment of metadata information than <meta> by using a metadata schema.

Version:
$Revision: 154 $

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

Author:
Steve Doyle

Field Summary
static String ATTRIBUTE_CONTENT
          The value of the metadata property.
static String ATTRIBUTE_HTTP_EQUIV
          The NAME of an HTTP response header.
static String ATTRIBUTE_NAME
          The NAME of the metadata property.
protected static ArrayList<String> ATTRIBUTE_NAMES
          Supported attribute names for this node.
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
Meta()
          Construct a new meta 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 getContent()
          Retrieve the content attribute.
 String getHttpEquiv()
          Retrieve the httpEquiv attribute.
 String getName()
          Retrieve the name attribute.
 String getTagName()
          Get the name of the tag for the derived node.
 XmlNode newInstance(Node n)
          Create a new instance for the given node.
 void setContent(String content)
          Set the content attribute.
 void setHttpEquiv(String httpEquiv)
          Set the httpEquiv attribute.
 void setName(String name)
          Set the name 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, 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_CONTENT

public static final String ATTRIBUTE_CONTENT
The value of the metadata property.

See Also:
Constant Field Values

ATTRIBUTE_HTTP_EQUIV

public static final String ATTRIBUTE_HTTP_EQUIV
The NAME of an HTTP response header. This attribute has special significance when documents are retrieved via HTTP. The http-equiv content may be used in situations where the CCXML document author is unable to configure HTTP header fields associated with their document on the origin server. Either the name or the http-equiv attribute has to be specified. If neither of them is specified, or if both are specified, an error.fetch event will be thrown.

See Also:
Constant Field Values

ATTRIBUTE_NAME

public static final String ATTRIBUTE_NAME
The NAME of the metadata property. The seeAlso property is used to specify a resource that might provide additional metadata information about the content. Either the name or the http-equiv attribute has to be specified. If neither of them is specified, or if both are specified, an error.fetch event will be thrown.

See Also:
Constant Field Values

ATTRIBUTE_NAMES

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

getTagName

public String getTagName()
Get the name of the tag for the derived node.

Returns:
name of the tag.

newInstance

public XmlNode newInstance(Node n)
Create a new instance for the given node.

Parameters:
n - The node to encapsulate.
Returns:
The new instance.
See Also:
XmlNodeFactory

getContent

public String getContent()
Retrieve the content attribute.

Returns:
Value of the content attribute.
See Also:
ATTRIBUTE_CONTENT

setContent

public void setContent(String content)
Set the content attribute.

Parameters:
content - Value of the content attribute.
See Also:
ATTRIBUTE_CONTENT

getHttpEquiv

public String getHttpEquiv()
Retrieve the httpEquiv attribute.

Returns:
Value of the httpEquiv attribute.
See Also:
ATTRIBUTE_HTTP_EQUIV

setHttpEquiv

public void setHttpEquiv(String httpEquiv)
Set the httpEquiv attribute.

Parameters:
httpEquiv - Value of the httpEquiv attribute.
See Also:
ATTRIBUTE_HTTP_EQUIV

getName

public String getName()
Retrieve the name attribute.

Returns:
Value of the name attribute.
See Also:
ATTRIBUTE_NAME

setName

public void setName(String name)
Set the name attribute.

Parameters:
name - Value of the name attribute.
See Also:
ATTRIBUTE_NAME

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


Copyright © 2005-2007 JVoiceXML group.