org.jvoicexml.xml.ccxml
Class Log

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

public final class Log
extends CcxmlNode

A list of one or more whitespace separated CCXML unqualified variable names to be returned. These variable names and their associated values will be set as properties of the exit event.

Version:
$Revision: 1.4 $

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

Author:
Steve Doyle

Field Summary
static String ATTRIBUTE_EXPR
          An ECMAScript expression evaluating to a string to be logged.
static String ATTRIBUTE_LABEL
          An ECMAScript expression which returns a character string which may be used, for example, to indicate the purpose of the log.
protected static ArrayList<String> ATTRIBUTE_NAMES
          Supported attribute names for this node.
private static Set<String> CHILD_TAGS
          Valid child tags for this node.
static String TAG_NAME
          Name of the tag.
 
Fields inherited from class org.jvoicexml.xml.XmlNode
node
 
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
Log()
          Construct a new log object without a node.
Log(Node node)
          Construct a new log object.
 
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.
 String getExpr()
          Retrieve the expr attribute.
 String getLabel()
          Retrieve the label 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 setExpr(String expr)
          Set the expr attribute.
 void setLabel(String label)
          Set the label attribute.
 
Methods inherited from class org.jvoicexml.xml.ccxml.CcxmlNode
getChildNodes, getFirstChild, getLastChild, getNextSibling, getParentNode, getPreviousSibling
 
Methods inherited from class org.jvoicexml.xml.XmlNode
addChild, appendChild, cloneNode, compareDocumentPosition, getAttribute, getAttributes, getBaseURI, getChildNodes, getFeature, getLocalName, getNamespaceURI, getNode, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getPrefix, 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
 

Field Detail

TAG_NAME

public static final String TAG_NAME
Name of the tag.

See Also:
Constant Field Values

ATTRIBUTE_EXPR

public static final String ATTRIBUTE_EXPR
An ECMAScript expression evaluating to a string to be logged.

See Also:
Constant Field Values

ATTRIBUTE_LABEL

public static final String ATTRIBUTE_LABEL
An ECMAScript expression which returns a character string which may be used, for example, to indicate the purpose of the log.

See Also:
Constant Field Values

ATTRIBUTE_NAMES

protected static final ArrayList<String> ATTRIBUTE_NAMES
Supported attribute names for this node.


CHILD_TAGS

private static final Set<String> CHILD_TAGS
Valid child tags for this node.

Constructor Detail

Log

public Log()
Construct a new log object without a node.

This is necessary for the node factory.

See Also:
VoiceXmlNodeFactory

Log

Log(Node node)
Construct a new log object.

Parameters:
node - The encapsulated node.
Method Detail

getTagName

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

Specified by:
getTagName in class XmlNode
Returns:
name of the tag.

newInstance

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

Specified by:
newInstance in class XmlNode
Parameters:
n - The node to encapsulate.
Returns:
The new instance.

getExpr

public String getExpr()
Retrieve the expr attribute.

Returns:
Value of the expr attribute.
See Also:
ATTRIBUTE_EXPR

setExpr

public void setExpr(String expr)
Set the expr attribute.

Parameters:
expr - Value of the expr attribute.
See Also:
ATTRIBUTE_EXPR

getLabel

public String getLabel()
Retrieve the label attribute.

Returns:
Value of the label attribute.
See Also:
ATTRIBUTE_LABEL

setLabel

public void setLabel(String label)
Set the label attribute.

Parameters:
label - Value of the label attribute.
See Also:
ATTRIBUTE_LABEL

canContainChild

protected boolean canContainChild(String tagName)
Can the specified sub-tag be contained within this node?

Specified by:
canContainChild in class XmlNode
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.

Overrides:
getAttributeNames in class XmlNode
Returns:
A collection of attribute names that are allowed for the node


Copyright © 2005 JVoiceXML group.