net.sf.saxon.tree.linked

Class CommentImpl

java.lang.Object

net.sf.saxon.tree.linked.NodeImpl

net.sf.saxon.tree.linked.CommentImpl

All Implemented Interfaces:

javax.xml.transform.Source, javax.xml.transform.SourceLocator, ActiveSource, GroundedValue, Item, MutableNodeInfo, NodeInfo, Sequence, Location, SteppingNode, SiblingCountingNode, org.xml.sax.Locator

public class CommentImpl
extends NodeImpl

CommentImpl is an implementation of a Comment node

Field Summary

Fields inherited from class net.sf.saxon.tree.linked.NodeImpl

NODE_LETTER

Constructor Summary

Constructors

Constructor and Description
CommentImpl(UnicodeString content)

Method Summary

Modifier and Type	Method and Description
AtomicSequence	atomize() Get the typed value of this node.
void	copy(Receiver out, int copyOptions, Location locationId) Copy this node to a given outputter
int	getColumnNumber() Get the column number of the node within its source entity
int	getLineNumber() Get the line number of the node within its source entity
int	getNodeKind() Get the kind of node.
java.lang.String	getSystemId() Get the system ID for the entity containing this node.
UnicodeString	getUnicodeStringValue() Get the string value of this sequence, as an instance of UnicodeString.
void	replaceStringValue(UnicodeString stringValue) Replace the string-value of this node
void	setLocation(java.lang.String uri, int lineNumber, int columnNumber) Set the system ID and line number

Methods inherited from class net.sf.saxon.tree.linked.NodeImpl

addAttribute, addNamespace, attributes, compareOrder, delete, effectiveBooleanValue, equals, generateId, getAllNamespaces, getAttributeValue, getBaseURI, getConfiguration, getDeclaredNamespaces, getDisplayName, getFingerprint, getFirstChild, getLastChild, getLocalPart, getNamePool, getNextInDocument, getNextSibling, getNodeName, getParent, getPhysicalRoot, getPrefix, getPreviousInDocument, getPreviousSibling, getRawParent, getRoot, getSchemaType, getSequenceNumber, getSiblingPosition, getSuccessorElement, getTreeInfo, getURI, hasChildNodes, hasFingerprint, hashCode, head, insertChildren, insertSiblings, isDeleted, iterateAxis, iterateAxis, newBuilder, removeAttribute, removeTypeAnnotation, rename, replace, saveLocation, setAttributes, setRawParent, setSiblingPosition, setSystemId, setTypeAnnotation

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.sf.saxon.om.MutableNodeInfo

addNamespace, removeNamespace

Methods inherited from interface net.sf.saxon.om.NodeInfo

asActiveSource, children, children, deliver, getGenre, getPublicId, isId, isIdref, isNilled, isSameNodeInfo, isStreamed, toShortString

Methods inherited from interface net.sf.saxon.om.Item

getLength, getStringValue, itemAt, iterate, reduce, subsequence

Methods inherited from interface net.sf.saxon.om.GroundedValue

asIterable, concatenate, containsNode, materialize

Methods inherited from interface net.sf.saxon.om.Sequence

makeRepeatable

Constructor Detail

CommentImpl

public CommentImpl(UnicodeString content)

Method Detail

getUnicodeStringValue

public final UnicodeString getUnicodeStringValue()

Description copied from interface: GroundedValue

Get the string value of this sequence, as an instance of UnicodeString. The string value of an item is the result of applying the XPath string() function. The string value of a sequence is the space-separated result of applying the string-join() function using a single space as the separator

The result of this method is always equivalent to the result of the GroundedValue.getStringValue() method. Use this method in preference either (a) if you need to use the value in a context where a UnicodeString is required, or (b) if the underlying value is held as a UnicodeString, or in a form that is readily converted to a UnicodeString. This is typically the case (i) when the value is a text or element node in a TinyTree, and (ii) when the value is a StringItem: that is, an atomic value of type xs:string.

Returns:

the string value of the sequence.

atomize

public AtomicSequence atomize()

Get the typed value of this node. Returns the string value, as an instance of xs:string

Specified by:

atomize in interface Item

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 copyOptions,
                 Location locationId)
          throws XPathException

Copy this node to a given outputter

Parameters:

out - the Receiver to which the node should be copied. It is the caller's responsibility to ensure that this Receiver is open before the method is called (or that it is self-opening), and that it is closed after use.

copyOptions - a selection of the options defined in CopyOptions

locationId - If non-null, identifies the location of the instruction that requested this copy. If null, indicates that the location information is not available

Throws:

XPathException - if any downstream error occurs

replaceStringValue

public void replaceStringValue(UnicodeString stringValue)

Replace the string-value of this node

Parameters:

stringValue - the new string value

setLocation

public void setLocation(java.lang.String uri,
                        int lineNumber,
                        int columnNumber)

Set the system ID and line number

Parameters:

uri - the system identifier

lineNumber - the line number

columnNumber - the column number

getSystemId

public java.lang.String getSystemId()

Get the system ID for the entity containing this node.

Specified by:

getSystemId in interface javax.xml.transform.Source

Specified by:

getSystemId in interface javax.xml.transform.SourceLocator

Specified by:

getSystemId in interface NodeInfo

Specified by:

getSystemId in interface Location

Specified by:

getSystemId in interface org.xml.sax.Locator

Overrides:

getSystemId in class NodeImpl

Returns:

the system identifier

getLineNumber

public int getLineNumber()

Get the line number of the node within its source entity

Specified by:

getLineNumber in interface javax.xml.transform.SourceLocator

Specified by:

getLineNumber in interface NodeInfo

Specified by:

getLineNumber in interface Location

Specified by:

getLineNumber in interface org.xml.sax.Locator

Overrides:

getLineNumber in class NodeImpl

Returns:

the line number of the node in its original source document; or -1 if not available. The default implementation returns -1.

getColumnNumber

public int getColumnNumber()

Get the column number of the node within its source entity

Specified by:

getColumnNumber in interface javax.xml.transform.SourceLocator

Specified by:

getColumnNumber in interface NodeInfo

Specified by:

getColumnNumber in interface Location

Specified by:

getColumnNumber in interface org.xml.sax.Locator

Overrides:

getColumnNumber in class NodeImpl

Returns:

the column number of the node in its original source document; or -1 if not available. The default implementation returns -1.