net.sf.saxon.tree
Class CommentImpl

java.lang.Object
  extended by net.sf.saxon.tree.NodeImpl
      extended by net.sf.saxon.tree.CommentImpl
All Implemented Interfaces:
javax.xml.transform.Source, javax.xml.transform.SourceLocator, FingerprintedNode, Item, NodeInfo, ValueRepresentation

final class CommentImpl
extends NodeImpl

CommentImpl is an implementation of a Comment node

Author:
Michael H. Kay

Field Summary
(package private)  java.lang.String comment
           
 
Fields inherited from class net.sf.saxon.tree.NodeImpl
index, NODE_LETTER, parent
 
Fields inherited from interface net.sf.saxon.om.NodeInfo
ALL_NAMESPACES, EMPTY_NAMESPACE_LIST, IS_DTD_TYPE, IS_NILLED, LOCAL_NAMESPACES, NO_NAMESPACES
 
Fields inherited from interface net.sf.saxon.om.ValueRepresentation
EMPTY_VALUE_ARRAY
 
Constructor Summary
CommentImpl(java.lang.String content)
           
 
Method Summary
 Value atomize()
          Get the typed value of this node.
 void copy(Receiver out, int whichNamespaces, boolean copyAnnotations, int locationId)
          Copy this node to a given outputter
 int getNodeKind()
          Get the kind of node.
 java.lang.String getStringValue()
          Return the string value of the node as defined in the XPath data model.
 SequenceIterator getTypedValue()
          Get the typed value of this node.
 
Methods inherited from class net.sf.saxon.tree.NodeImpl
compareOrder, equals, generateId, getAttributeValue, getBaseURI, getColumnNumber, getConfiguration, getDeclaredNamespaces, getDisplayName, getDocumentNumber, getDocumentRoot, getFingerprint, getFirstChild, getLastChild, getLineNumber, getLocalPart, getNameCode, getNamePool, getNextInDocument, getNextSibling, getParent, getPrefix, getPreviousInDocument, getPreviousSibling, getPublicId, getRoot, getSequenceNumber, getStringValueCS, getSystemId, getTypeAnnotation, getURI, hasChildNodes, hashCode, isSameNodeInfo, iterateAxis, iterateAxis, sendNamespaceDeclarations, setSystemId
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

comment

java.lang.String comment
Constructor Detail

CommentImpl

public CommentImpl(java.lang.String content)
Method Detail

getStringValue

public final java.lang.String getStringValue()
Description copied from interface: NodeInfo
Return the string value of the node as defined in the XPath data model.

The interpretation of this depends on the type of node. For an element it is the accumulated character content of the element, including descendant elements.

This method returns the string value as if the node were untyped. Unlike the string value accessor in the XPath 2.0 data model, it does not report an error if the element has a complex type, instead it returns the concatenation of the descendant text nodes as it would if the element were untyped.

Returns:
the string value of the node
See Also:
Item.getStringValueCS()

getTypedValue

public SequenceIterator getTypedValue()
Get the typed value of this node. Returns the string value, as an instance of xs:string

Specified by:
getTypedValue in interface Item
Overrides:
getTypedValue in class NodeImpl
Returns:
an iterator over the items in the typed value of the node or atomic value. The items returned by this iterator will always be atomic values.

atomize

public Value atomize()
Get the typed value of this node. Returns the string value, as an instance of xs:string

Specified by:
atomize in interface NodeInfo
Overrides:
atomize in class NodeImpl
Returns:
the typed value. If requireSingleton is set to true, the result will always be an AtomicValue. In other cases it may be a Value representing a sequence whose items are atomic values.

getNodeKind

public final int getNodeKind()
Description copied from interface: NodeInfo
Get the kind of node. This will be a value such as Type.ELEMENT or Type.ATTRIBUTE. There are seven kinds of node: documents, elements, attributes, text, comments, processing-instructions, and namespaces.

Returns:
an integer identifying the kind of node. These integer values are the same as those used in the DOM
See Also:
Type

copy

public void copy(Receiver out,
                 int whichNamespaces,
                 boolean copyAnnotations,
                 int locationId)
          throws XPathException
Copy this node to a given outputter

Parameters:
out - the Receiver to which the node should be copied
whichNamespaces - in the case of an element, controls which namespace nodes should be copied. Values are NodeInfo.NO_NAMESPACES, NodeInfo.LOCAL_NAMESPACES, NodeInfo.ALL_NAMESPACES
copyAnnotations - indicates whether the type annotations of element and attribute nodes should be copied
locationId - If non-zero, identifies the location of the instruction that requested this copy. If zero, indicates that the location information for the original node is to be copied; in this case the Receiver must be a LocationCopier
Throws:
XPathException