biz.c24.io.api.data.saxon
Class ElementNode

java.lang.Object
  extended by biz.c24.io.api.data.saxon.ElementNode
All Implemented Interfaces:
ComponentNode, DataNode, Node, Source, net.sf.saxon.evpull.PullEvent, net.sf.saxon.om.Item, net.sf.saxon.om.NodeInfo, net.sf.saxon.om.ValueRepresentation
Direct Known Subclasses:
ComplexElementNode, SimpleElementNode

public abstract class ElementNode
extends Object
implements ComponentNode, Node

Implements the Saxon NodeInfo interface as a wrapper around the C24 Integreation Objects representation. This is an abstract class: there are two concrete subclasses, one for elements with a complex type, one for elements with a simple type.


Field Summary
 
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
ElementNode()
           
 
Method Summary
 int compareOrder(net.sf.saxon.om.NodeInfo other)
          Determine the relative position of this node and another node, in document order.
 void copy(net.sf.saxon.event.Receiver out, int whichNamespaces, boolean copyAnnotations, int locationId)
          Copy this node to a given receiver.
 void generateId(net.sf.saxon.om.FastStringBuffer buffer)
          Construct a character string that uniquely identifies this node.
 String getBaseURI()
          Get the Base URI for the node, that is, the URI used for resolving a relative URI contained in the node.
 net.sf.saxon.Configuration getConfiguration()
          Get the configuration used to build the tree containing this node.
 String getDisplayName()
          Get the display name of this node, in the form of a lexical QName.
 int getDocumentNumber()
          Get the document number of the document containing this node.
 net.sf.saxon.om.DocumentInfo getDocumentRoot()
          Get the root node, if it is a document node.
 int getFingerprint()
          Get fingerprint.
 int getLineNumber()
          Get line number.
 int getNameCode()
          Get name code.
 net.sf.saxon.om.NamePool getNamePool()
          Get the NamePool that holds the namecode for this node
 int getNodeKind()
          Get the kind of node.
 int getRelativePosition()
          Get the relative position of this element (relative to its siblings having the same element name)
 net.sf.saxon.om.NodeInfo getRoot()
          Get the root node of the tree containing this node
 String getStringValue()
          Return the string value of the node.
 String getSystemId()
          Get the System ID for the node.
 net.sf.saxon.om.SequenceIterator getTypedValue()
          Get the typed value of the item.
 net.sf.saxon.om.AxisIterator iterateAxis(byte axisNumber)
          Return an iteration over all the nodes reached by the given axis from this node
 void setSystemId(String systemId)
          Set the system identifier for this Source.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface biz.c24.io.api.data.saxon.ComponentNode
getUnderlyingComponent
 
Methods inherited from interface biz.c24.io.api.data.saxon.DataNode
getUnderlyingObject
 
Methods inherited from interface net.sf.saxon.om.NodeInfo
atomize, equals, getAttributeValue, getDeclaredNamespaces, getLocalPart, getParent, getPrefix, getTypeAnnotation, getURI, hasChildNodes, hashCode, isSameNodeInfo, iterateAxis
 
Methods inherited from interface net.sf.saxon.om.Item
getStringValueCS
 

Constructor Detail

ElementNode

public ElementNode()
Method Detail

getRelativePosition

public int getRelativePosition()
Get the relative position of this element (relative to its siblings having the same element name)

Specified by:
getRelativePosition in interface Node
Returns:
the relative position

compareOrder

public int compareOrder(net.sf.saxon.om.NodeInfo other)
Determine the relative position of this node and another node, in document order.

The other node must always be in the same tree; the effect of calling this method when the two nodes are in different trees is undefined. To obtain a global ordering of nodes, the application should first compare the result of getDocumentNumber(), and only if the document number is the same should compareOrder() be called.

Specified by:
compareOrder in interface net.sf.saxon.om.NodeInfo
Parameters:
other - The other node, whose position is to be compared with this node
Returns:
-1 if this node precedes the other node, +1 if it follows the other node, or 0 if they are the same node. (In this case, isSameNode() will always return true, and the two nodes will produce the same result for generateId())
Since:
8.4

copy

public void copy(net.sf.saxon.event.Receiver out,
                 int whichNamespaces,
                 boolean copyAnnotations,
                 int locationId)
          throws net.sf.saxon.trans.XPathException
Copy this node to a given receiver.

This method is primarily for internal use. It should not be considered a stable part of the Saxon API.

Specified by:
copy in interface net.sf.saxon.om.NodeInfo
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:
net.sf.saxon.trans.XPathException

generateId

public void generateId(net.sf.saxon.om.FastStringBuffer buffer)
Construct a character string that uniquely identifies this node. Note: a.isSameNode(b) if and only if generateId(a)==generateId(b)

Specified by:
generateId in interface net.sf.saxon.om.NodeInfo
Parameters:
buffer - a buffer which will be updated to hold a string that uniquely identifies this node, across all documents.
Since:
8.7

Changed in Saxon 8.7 to generate the ID value in a client-supplied buffer


getBaseURI

public String getBaseURI()
Get the Base URI for the node, that is, the URI used for resolving a relative URI contained in the node. This will be the same as the System ID unless xml:base has been used. Where the node does not have a base URI of its own, the base URI of its parent node is returned.

Specified by:
getBaseURI in interface net.sf.saxon.om.NodeInfo
Returns:
the base URI of the node. This may be null if the base URI is unknown.
Since:
8.4

getConfiguration

public net.sf.saxon.Configuration getConfiguration()
Get the configuration used to build the tree containing this node.

Specified by:
getConfiguration in interface net.sf.saxon.om.NodeInfo
Returns:
the Configuration
Since:
8.4

getDisplayName

public String getDisplayName()
Get the display name of this node, in the form of a lexical QName. For elements and attributes this is [prefix:]localname. For unnamed nodes, it is an empty string.

Specified by:
getDisplayName in interface net.sf.saxon.om.NodeInfo
Returns:
The display name of this node. For a node with no name, returns an empty string.
Since:
8.4

getDocumentNumber

public int getDocumentNumber()
Get the document number of the document containing this node. For a free-standing orphan node, just return the hashcode.

Specified by:
getDocumentNumber in interface net.sf.saxon.om.NodeInfo
Since:
8.4

getDocumentRoot

public net.sf.saxon.om.DocumentInfo getDocumentRoot()
Get the root node, if it is a document node.

Specified by:
getDocumentRoot in interface net.sf.saxon.om.NodeInfo
Returns:
the DocumentInfo representing the containing document. If this node is part of a tree that does not have a document node as its root, returns null.
Since:
8.4

getFingerprint

public int getFingerprint()
Get fingerprint. The fingerprint is a coded form of the expanded name of the node: two nodes with the same name code have the same namespace URI and the same local name. The fingerprint contains no information about the namespace prefix. For a name in the null namespace, the fingerprint is the same as the name code.

Specified by:
getFingerprint in interface net.sf.saxon.om.NodeInfo
Returns:
an integer fingerprint; two nodes with the same fingerprint have the same expanded QName. For unnamed nodes (text nodes, comments, document nodes, and namespace nodes for the default namespace), returns -1.
Since:
8.4

getLineNumber

public int getLineNumber()
Get line number. Line numbers are not maintained by default, except for stylesheets and schema documents. Line numbering can be requested using the -l option on the command line, or by setting options on the TransformerFactory or the Configuration before the source document is built.

The granularity of line numbering is normally the element level: for other nodes such as text nodes and attributes, the line number of the parent element will normally be returned.

In the case of a tree constructed by taking input from a SAX parser, the line number will reflect the SAX rules: that is, the line number of an element is the line number where the start tag ends. This may be a little confusing where elements have many attributes spread over multiple lines, or where single attributes (as can easily happen with XSLT 2.0 stylesheets) occupy several lines.

In the case of a tree constructed by a stylesheet or query, the line number may reflect the line in the stylesheet or query that caused the node to be constructed.

The line number can be read from within an XPath expression using the Saxon extension function saxon:line-number()

Specified by:
getLineNumber in interface net.sf.saxon.om.NodeInfo
Returns:
the line number of the node in its original source document; or -1 if not available
Since:
8.4

getNameCode

public int getNameCode()
Get name code. The name code is a coded form of the node name: two nodes with the same name code have the same namespace URI, the same local name, and the same prefix. By masking the name code with NamePool.FP_MASK, you get a fingerprint: two nodes with the same fingerprint have the same local name and namespace URI.

Specified by:
getNameCode in interface net.sf.saxon.om.NodeInfo
Returns:
an integer name code, which may be used to obtain the actual node name from the name pool. For unnamed nodes (text nodes, comments, document nodes, and namespace nodes for the default namespace), returns -1.
Since:
8.4
See Also:
allocate, getFingerprint

getNamePool

public net.sf.saxon.om.NamePool getNamePool()
Get the NamePool that holds the namecode for this node

Specified by:
getNamePool in interface net.sf.saxon.om.NodeInfo
Returns:
the namepool
Since:
8.4

getNodeKind

public int getNodeKind()
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.

Specified by:
getNodeKind in interface net.sf.saxon.om.NodeInfo
Returns:
an integer identifying the kind of node. These integer values are the same as those used in the DOM
Since:
8.4
See Also:
Type

getRoot

public net.sf.saxon.om.NodeInfo getRoot()
Get the root node of the tree containing this node

Specified by:
getRoot in interface net.sf.saxon.om.NodeInfo
Returns:
the NodeInfo representing the top-level ancestor of this node. This will not necessarily be a document node. If this node has no parent, then the method returns this node.
Since:
8.4

getStringValue

public String getStringValue()
Return the string value of the node. This is normally the string value as defined in the XPath data model, except that no distinction is made between strings and untyped atomic values.

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.

Specified by:
getStringValue in interface net.sf.saxon.om.Item
Specified by:
getStringValue in interface net.sf.saxon.om.NodeInfo
Specified by:
getStringValue in interface net.sf.saxon.om.ValueRepresentation
Returns:
the string value of the node
Since:
8.4

getSystemId

public String getSystemId()
Get the System ID for the node. Note this is not the same as the base URI: the base URI can be modified by xml:base, but the system ID cannot. The base URI is used primarily for resolving relative URIs within the content of the document. The system ID is used primarily in conjunction with a line number, for identifying the location of elements within the source XML, in particular when errors are found.

Specified by:
getSystemId in interface Source
Specified by:
getSystemId in interface net.sf.saxon.om.NodeInfo
Returns:
the System Identifier of the entity in the source document containing the node, or null if not known.
Since:
8.4

iterateAxis

public net.sf.saxon.om.AxisIterator iterateAxis(byte axisNumber)
Return an iteration over all the nodes reached by the given axis from this node

Specified by:
iterateAxis in interface net.sf.saxon.om.NodeInfo
Parameters:
axisNumber - an integer identifying the axis; one of the constants defined in class Axis
Returns:
an AxisIterator that scans the nodes reached by the axis in turn.
Throws:
UnsupportedOperationException - if the namespace axis is requested and this axis is not supported for this implementation.
Since:
8.4
See Also:
Axis

setSystemId

public void setSystemId(String systemId)
Set the system identifier for this Source.

The system identifier is optional if the source does not get its data from a URL, but it may still be useful to provide one. The application can use a system identifier, for example, to resolve relative URIs and to include in error messages and warnings.

Specified by:
setSystemId in interface Source
Parameters:
systemId - The system identifier as a URL string.

getTypedValue

public net.sf.saxon.om.SequenceIterator getTypedValue()
                                               throws net.sf.saxon.trans.XPathException
Get the typed value of the item.

For a node, this is the typed value as defined in the XPath 2.0 data model. Since a node may have a list-valued data type, the typed value is in general a sequence, and it is returned in the form of a SequenceIterator.

If the node has not been validated against a schema, the typed value will be the same as the string value, either as an instance of xs:string or as an instance of xdt:untypedAtomic, depending on the node kind.

For an atomic value, this method returns an iterator over a singleton sequence containing the atomic value itself.

Specified by:
getTypedValue in interface net.sf.saxon.om.Item
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.
Throws:
net.sf.saxon.trans.XPathException - where no typed value is available, for example in the case of an element with complex content
Since:
8.4


C24 Technologies © 2002-2012: All Rights Reserved.