Package com.icl.saxon.om
Class AbstractNode
java.lang.Object
com.icl.saxon.om.AbstractNode
- All Implemented Interfaces:
NodeInfo
,DOMLocator
,Source
,SourceLocator
,Node
- Direct Known Subclasses:
NodeImpl
,TinyNodeImpl
public abstract class AbstractNode
extends Object
implements Node, NodeInfo, SourceLocator, DOMLocator
This class is an abstract implementation of the Saxon NodeInfo interface;
it also contains concrete implementations of most of the DOM methods in terms
of the NodeInfo methods. These include all the methods defined on the DOM Node
class itself, and most of those defined on subclasses such as Document, Text,
and Comment: because
of the absence of multiple inheritance, this is the only way of making these
methods reusable by multiple implementations.
The class contains no data, and can be used as a common
superclass for different implementations of Node and NodeInfo.
- Author:
- Michael H. Kay
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final char[]
Chararacteristic letters to identify each type of node, indexed using the node type values.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
Constructors -
Method Summary
Modifier and TypeMethodDescriptionappendChild
(Node newChild) Adds the nodenewChild
to the end of the list of children of this node.void
appendData
(String arg) Append the string to the end of the character data of the node.cloneNode
(boolean deep) Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes.short
compareDocumentPosition
(Node other) Compares the reference node, i.e.abstract int
compareOrder
(NodeInfo other) Determine the relative position of this node and another node, in document order.void
copyStringValue
(Outputter out) Copy the string-value of this node to a given outputter.createAttribute
(String name) Create anAttr
of the given name.createAttributeNS
(String namespaceURI, String qualifiedName) Create an attribute of the given qualified name and namespace URI.createCDATASection
(String data) Create aCDATASection
node whose value is the specified string.createComment
(String data) Create aComment
node given the specified string.Creates an emptyDocumentFragment
object.createElement
(String tagName) Creates an element of the type specified.createElementNS
(String namespaceURI, String qualifiedName) Create an element of the given qualified name and namespace URI.createEntityReference
(String name) Create anEntityReference
object.createProcessingInstruction
(String target, String data) Create aProcessingInstruction
node given the specified name and data strings.createTextNode
(String data) Create aText
node given the specified string.void
deleteData
(int offset, int count) Remove a range of 16-bit units from the node.protected void
Internal method used to indicate that update operations are not allowedabstract String
Get a character string that uniquely identifies this nodegetAttribute
(String name) Retrieves an attribute value by name.getAttributeNode
(String name) Retrieves an attribute node by name.getAttributeNodeNS
(String namespaceURI, String localName) Retrieves anAttr
node by local name and namespace URI.getAttributeNS
(String namespaceURI, String localName) Retrieves an attribute value by local name and namespace URI.Return aNamedNodeMap
containing the attributes of this node (if it is anElement
) ornull
otherwise.abstract String
getAttributeValue
(int fingerprint) Get the value of a given attribute of this nodeabstract String
getAttributeValue
(String uri, String localName) Find the value of a given attribute of this node.abstract String
Get the base URI for the node.Return aNodeList
that contains all children of this node.int
Get the column number of the node.getData()
Get the character data of a Text or Comment node.Get the display name of this node.Get the Document Type Declaration (seeDocumentType
) associated with this document.Get the outermost element.Get the root (document) nodegetElementById
(String elementId) Return theElement
whoseID
is given byelementId
.getElementsByTagName
(String tagname) Return aNodeList
of all theElements
with a given tag name in the order in which they are encountered in a preorder traversal of theDocument
tree.getElementsByTagNameNS
(String namespaceURI, String localName) Return aNodeList
of all theElements
with a given local name and namespace URI in the order in which they are encountered in a preorder traversal of theDocument
tree.abstract AxisEnumeration
getEnumeration
(byte axisNumber, NodeTest nodeTest) Return an enumeration over the nodes reached by the given axis from this nodegetFeature
(String feature, String version) This method returns a specialized object which implements the specialized APIs of the specified feature and version, as specified in .abstract int
Get the fingerprint of the node, used for matching namesGet first child (DOM method)Get aDOMImplementation
object that handles this document.Get last child (DOM method)int
Get the length of a Text or Comment node.int
Get the line number of the node within its source document entity.abstract String
Get the local name of this node.getName()
Get the name of an attribute node (the QName) (DOM method)abstract int
Get the name code of the node, used for displaying namesThe namespace URI of this node, ornull
if it is unspecified.Get next sibling node (DOM method)Get the name of this node, following the DOM rulesGet the node value as defined in the DOM.Get the node corresponding to this javax.xml.transform.dom.DOMLocatorReturn theDocument
object associated with this node.TheElement
node this attribute is attached to ornull
if this attribute is not in use.abstract NodeInfo
Find the parent node of this node.Find the parent node of this node (DOM method).abstract String
Get the prefix part of the name of this node.Get the previous sibling of the node (DOM method)Get the public identifier of the document entity containing this node.The type information associated with this attribute.boolean
If this attribute was explicitly given a value in the original document, this istrue
; otherwise, it isfalse
.abstract String
Get the system ID for the entity containing the node.The name of the element (DOM interface).This attribute returns the text content of this node and its descendants.abstract String
getURI()
Get the URI part of the name of this node.getUserData
(String key) Retrieves the object associated to a key on a this node.getValue()
Return the character value of an attribute node (DOM method)Returns all text ofText
nodes logically-adjacent text nodes to this node, concatenated in document order.boolean
hasAttribute
(String name) Returnstrue
when an attribute with a given name is specified on this element or has a default value,false
otherwise.boolean
hasAttributeNS
(String namespaceURI, String localName) Returnstrue
when an attribute with a given local name and namespace URI is specified on this element or has a default value,false
otherwise.abstract boolean
Returns whether this node has any attributes.abstract boolean
Determine whether the node has any children.importNode
(Node importedNode, boolean deep) Import a node from another document to this document.insertBefore
(Node newChild, Node refChild) Insert the nodenewChild
before the existing child noderefChild
.void
insertData
(int offset, String arg) Insert a string at the specified character offset.boolean
isDefaultNamespace
(String namespaceURI) This method checks if the specifiednamespaceURI
is the default namespace or not.boolean
Returns whether this text node contains element content whitespace, often abusively called "ignorable whitespace".boolean
isEqualNode
(Node arg) Tests whether two nodes are equal.boolean
isId()
Returns whether this attribute is known to be of type ID (i.e.boolean
isSameNode
(Node other) Returns whether this node is the same node as the given one.abstract boolean
isSameNodeInfo
(NodeInfo other) Determine whether this is the same node as another nodeboolean
isSupported
(String feature, String version) Tests whether the DOM implementation implements a specific feature and that feature is supported by this node.lookupNamespaceURI
(String prefix) Look up the namespace URI associated to the given prefix, starting from this node.lookupPrefix
(String namespaceURI) Look up the prefix associated to the given namespace URI, starting from this node.void
Puts allText
nodes in the full depth of the sub-tree underneath thisNode
, including attribute nodes, into a "normal" form where only structure (e.g., elements, comments, processing instructions, CDATA sections, and entity references) separatesText
nodes, i.e., there are neither adjacentText
nodes nor emptyText
nodes.void
outputNamespaceNodes
(Outputter out, boolean includeAncestors) Output all namespace nodes associated with this element.void
removeAttribute
(String oldAttr) Removes the specified attribute.removeAttributeNode
(Attr oldAttr) Removes the specified attribute node.void
removeAttributeNS
(String namespaceURI, String localName) Removes an attribute by local name and namespace URI.removeChild
(Node oldChild) Remove the child node indicated byoldChild
from the list of children, and returns it.replaceChild
(Node newChild, Node oldChild) Replace the child nodeoldChild
withnewChild
in the list of children, and returns theoldChild
node.void
replaceData
(int offset, int count, String arg) Replace the characters starting at the specified 16-bit unit offset with the specified string.replaceWholeText
(String content) Replaces the text of the current node and all logically-adjacent text nodes with the specified text.setAttributeNode
(Attr newAttr) Adds a new attribute node.setAttributeNodeNS
(Attr newAttr) Add a new attribute.void
setAttributeNS
(String namespaceURI, String qualifiedName, String value) Adds a new attribute.void
Set the character data of a Text or Comment node.void
setIdAttribute
(String name, boolean isId) If the parameterisId
istrue
, this method declares the specified attribute to be a user-determined ID attribute .void
setIdAttributeNode
(Attr idAttr, boolean isId) If the parameterisId
istrue
, this method declares the specified attribute to be a user-determined ID attribute .void
setIdAttributeNS
(String namespaceURI, String localName, boolean isId) If the parameterisId
istrue
, this method declares the specified attribute to be a user-determined ID attribute .void
setNodeValue
(String nodeValue) Set the node value.void
Set the namespace prefix of this node.void
setTextContent
(String textContent) This attribute returns the text content of this node and its descendants.setUserData
(String key, Object data, UserDataHandler handler) Associate an object to a key on this node.void
Set the value of an attribute node.splitText
(int offset) Break this node into two nodes at the specified offset, keeping both in the tree as siblings.substringData
(int offset, int count) Extract a range of data from a Text or Comment node.boolean
Alternative to isSupported(), defined in a draft DOM specMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.w3c.dom.Node
getNodeType
Methods inherited from interface com.icl.saxon.om.NodeInfo
copy, getNodeType, getStringValue
Methods inherited from interface javax.xml.transform.Source
isEmpty, setSystemId
-
Field Details
-
NODE_LETTER
public static final char[] NODE_LETTERChararacteristic letters to identify each type of node, indexed using the node type values. These are used as the initial letter of the result of generate-id()
-
-
Constructor Details
-
AbstractNode
public AbstractNode()
-
-
Method Details
-
isSameNodeInfo
Determine whether this is the same node as another node- Specified by:
isSameNodeInfo
in interfaceNodeInfo
- Returns:
- true if this Node object and the supplied Node object represent the same node in the tree.
-
generateId
Get a character string that uniquely identifies this node- Specified by:
generateId
in interfaceNodeInfo
- Returns:
- a string.
-
getSystemId
Get the system ID for the entity containing the node.- Specified by:
getSystemId
in interfaceNodeInfo
- Specified by:
getSystemId
in interfaceSource
- Specified by:
getSystemId
in interfaceSourceLocator
- Returns:
- the System Identifier of the entity in the source document containing the node, or null if not known. Note this is not the same as the base URI: the base URI can be modified by xml:base, but the system ID cannot.
-
getBaseURI
Get the base URI for the node. Default implementation for child nodes gets the base URI of the parent node.- Specified by:
getBaseURI
in interfaceNode
- Specified by:
getBaseURI
in interfaceNodeInfo
-
getOriginatingNode
Get the node corresponding to this javax.xml.transform.dom.DOMLocator- Specified by:
getOriginatingNode
in interfaceDOMLocator
-
compareOrder
Determine the relative position of this node and another node, in document order. The other node will always be in the same document.- Specified by:
compareOrder
in interfaceNodeInfo
- 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())
-
getNameCode
public abstract int getNameCode()Get the name code of the node, used for displaying names- Specified by:
getNameCode
in interfaceNodeInfo
- See Also:
-
getFingerprint
public abstract int getFingerprint()Get the fingerprint of the node, used for matching names- Specified by:
getFingerprint
in interfaceNodeInfo
-
getNodeName
Get the name of this node, following the DOM rules- Specified by:
getNodeName
in interfaceNode
- Returns:
- The name of the node. For an element this is the element name, for an attribute it is the attribute name, as a QName. Other node types return conventional names such as "#text" or "#comment"
-
getPrefix
Get the prefix part of the name of this node. This is the name before the ":" if any. -
getURI
Get the URI part of the name of this node. This is the URI corresponding to the prefix, or the URI of the default namespace if appropriate. -
getDisplayName
Get the display name of this node. For elements and attributes this is [prefix:]localname. For unnamed nodes, it is an empty string.- Specified by:
getDisplayName
in interfaceNodeInfo
- Returns:
- The display name of this node. For a node with no name, return an empty string.
-
getLocalName
Get the local name of this node.- Specified by:
getLocalName
in interfaceNode
- Specified by:
getLocalName
in interfaceNodeInfo
- Returns:
- The local name of this node. For a node with no name, return an empty string.
-
hasChildNodes
public abstract boolean hasChildNodes()Determine whether the node has any children.- Specified by:
hasChildNodes
in interfaceNode
- Specified by:
hasChildNodes
in interfaceNodeInfo
- Returns:
true
if this node has any attributes,false
otherwise.
-
hasAttributes
public abstract boolean hasAttributes()Returns whether this node has any attributes.- Specified by:
hasAttributes
in interfaceNode
- Returns:
true
if this node has any attributes,false
otherwise.- Since:
- DOM Level 2
-
getAttributeValue
Find the value of a given attribute of this node.
This method is defined on all nodes to meet XSL requirements, but for nodes other than elements it will always return null.- Specified by:
getAttributeValue
in interfaceNodeInfo
- Parameters:
uri
- the namespace uri of an attributelocalName
- the local name of an attribute- Returns:
- the value of the attribute, if it exists, otherwise null
-
getAttributeValue
Get the value of a given attribute of this node- Specified by:
getAttributeValue
in interfaceNodeInfo
- Parameters:
fingerprint
- The fingerprint of the attribute name- Returns:
- the attribute value if it exists or null if not
-
getLineNumber
public int getLineNumber()Get the line number of the node within its source document entity. The default implementation returns -1, meaning unknown- Specified by:
getLineNumber
in interfaceNodeInfo
- Specified by:
getLineNumber
in interfaceSourceLocator
- Returns:
- the line number of the node in its original source document; or -1 if not available
-
getColumnNumber
public int getColumnNumber()Get the column number of the node. The default implementation returns -1, meaning unknown- Specified by:
getColumnNumber
in interfaceSourceLocator
-
getPublicId
Get the public identifier of the document entity containing this node. The default implementation returns null, meaning unknown- Specified by:
getPublicId
in interfaceSourceLocator
-
getEnumeration
Return an enumeration over the nodes reached by the given axis from this node- Specified by:
getEnumeration
in interfaceNodeInfo
- Parameters:
axisNumber
- The axis to be used (a constant in classAxis
)nodeTest
- A pattern to be matched by the returned nodes- Returns:
- a AxisEnumeration that scans the nodes reached by the axis in turn.
-
getParent
Find the parent node of this node. -
getDocumentRoot
Get the root (document) node- Specified by:
getDocumentRoot
in interfaceNodeInfo
- Returns:
- the DocumentInfo representing the containing document
-
getParentNode
Find the parent node of this node (DOM method).- Specified by:
getParentNode
in interfaceNode
- Returns:
- The Node object describing the containing element or root node.
-
getPreviousSibling
Get the previous sibling of the node (DOM method)- Specified by:
getPreviousSibling
in interfaceNode
- Returns:
- The previous sibling node. Returns null if the current node is the first child of its parent.
-
getNextSibling
Get next sibling node (DOM method)- Specified by:
getNextSibling
in interfaceNode
- Returns:
- The next sibling node. Returns null if the current node is the last child of its parent.
-
getFirstChild
Get first child (DOM method)- Specified by:
getFirstChild
in interfaceNode
- Returns:
- the first child node of this node, or null if it has no children
-
getLastChild
Get last child (DOM method)- Specified by:
getLastChild
in interfaceNode
- Returns:
- last child of this node, or null if it has no children
-
getDocumentElement
Get the outermost element. (DOM method)- Returns:
- the Element for the outermost element of the document. If the document is not well-formed, this returns the last element child of the root if there is one, otherwise null.
-
copyStringValue
Copy the string-value of this node to a given outputter. Default implementation does "out.writeContent(getStringValue());" but it is useful to provide an optimized implementation.- Specified by:
copyStringValue
in interfaceNodeInfo
- Throws:
TransformerException
-
outputNamespaceNodes
public void outputNamespaceNodes(Outputter out, boolean includeAncestors) throws TransformerException Output all namespace nodes associated with this element. Does nothing if the node is not an element.- Specified by:
outputNamespaceNodes
in interfaceNodeInfo
- Parameters:
out
- The relevant outputterincludeAncestors
- True if namespaces declared on ancestor elements must be output; false if it is known that these are already on the result tree- Throws:
TransformerException
-
getNodeValue
Get the node value as defined in the DOM. This is not necessarily the same as the XPath string-value.- Specified by:
getNodeValue
in interfaceNode
-
setNodeValue
Set the node value. DOM method: always fails- Specified by:
setNodeValue
in interfaceNode
- Throws:
DOMException
-
getChildNodes
Return aNodeList
that contains all children of this node. If there are no children, this is aNodeList
containing no nodes. DOM Method.- Specified by:
getChildNodes
in interfaceNode
-
getAttributes
Return aNamedNodeMap
containing the attributes of this node (if it is anElement
) ornull
otherwise. (DOM method)- Specified by:
getAttributes
in interfaceNode
-
getOwnerDocument
Return theDocument
object associated with this node. (DOM method)- Specified by:
getOwnerDocument
in interfaceNode
-
insertBefore
Insert the nodenewChild
before the existing child noderefChild
. DOM method: always fails.- Specified by:
insertBefore
in interfaceNode
- Parameters:
newChild
- The node to insert.refChild
- The reference node, i.e., the node before which the new node must be inserted.- Returns:
- The node being inserted.
- Throws:
DOMException
- NO_MODIFICATION_ALLOWED_ERR: Always raised.
-
replaceChild
Replace the child nodeoldChild
withnewChild
in the list of children, and returns theoldChild
node. Always fails.- Specified by:
replaceChild
in interfaceNode
- Parameters:
newChild
- The new node to put in the child list.oldChild
- The node being replaced in the list.- Returns:
- The node replaced.
- Throws:
DOMException
- NO_MODIFICATION_ALLOWED_ERR: Always raised.
-
removeChild
Remove the child node indicated byoldChild
from the list of children, and returns it. DOM method: always fails.- Specified by:
removeChild
in interfaceNode
- Parameters:
oldChild
- The node being removed.- Returns:
- The node removed.
- Throws:
DOMException
- NO_MODIFICATION_ALLOWED_ERR: Always raised.
-
appendChild
Adds the nodenewChild
to the end of the list of children of this node. DOM method: always fails.- Specified by:
appendChild
in interfaceNode
- Parameters:
newChild
- The node to add.- Returns:
- The node added.
- Throws:
DOMException
-
NO_MODIFICATION_ALLOWED_ERR: Always raised.
-
cloneNode
Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes. The duplicate node has no parent. Not implemented: always returns null. (Because trees are read-only, there would be no way of using the resulting node.) -
normalize
public void normalize()Puts allText
nodes in the full depth of the sub-tree underneath thisNode
, including attribute nodes, into a "normal" form where only structure (e.g., elements, comments, processing instructions, CDATA sections, and entity references) separatesText
nodes, i.e., there are neither adjacentText
nodes nor emptyText
nodes. -
isSupported
Tests whether the DOM implementation implements a specific feature and that feature is supported by this node.- Specified by:
isSupported
in interfaceNode
- Parameters:
feature
- The name of the feature to test. This is the same name which can be passed to the methodhasFeature
onDOMImplementation
.version
- This is the version number of the feature to test. In Level 2, version 1, this is the string "2.0". If the version is not specified, supporting any version of the feature will cause the method to returntrue
.- Returns:
- Returns
true
if the specified feature is supported on this node,false
otherwise. - Since:
- DOM Level 2
-
supports
Alternative to isSupported(), defined in a draft DOM spec -
getNamespaceURI
The namespace URI of this node, ornull
if it is unspecified. DOM method.
This is not a computed value that is the result of a namespace lookup based on an examination of the namespace declarations in scope. It is merely the namespace URI given at creation time.
For nodes of any type other thanELEMENT_NODE
andATTRIBUTE_NODE
and nodes created with a DOM Level 1 method, such ascreateElement
from theDocument
interface, this is alwaysnull
. Per the Namespaces in XML Specification an attribute does not inherit its namespace from the element it is attached to. If an attribute is not explicitly given a namespace, it simply has no namespace.- Specified by:
getNamespaceURI
in interfaceNode
- Since:
- DOM Level 2
-
setPrefix
Set the namespace prefix of this node. Always fails.- Specified by:
setPrefix
in interfaceNode
- Throws:
DOMException
-
disallowUpdate
Internal method used to indicate that update operations are not allowed- Throws:
DOMException
-
getDoctype
Get the Document Type Declaration (seeDocumentType
) associated with this document. For HTML documents as well as XML documents without a document type declaration this returnsnull
. DOM method.- Returns:
- null: The Saxon tree model does not include the document type information.
-
getImplementation
Get aDOMImplementation
object that handles this document. A DOM application may use objects from multiple implementations. DOM method. -
createElement
Creates an element of the type specified. DOM method: always fails, because the Saxon tree is not updateable.- Throws:
DOMException
-
createDocumentFragment
Creates an emptyDocumentFragment
object.- Returns:
- A new
DocumentFragment
. DOM method: returns null, because the Saxon tree is not updateable.
-
createTextNode
Create aText
node given the specified string. DOM method: returns null, because the Saxon tree is not updateable.- Parameters:
data
- The data for the node.- Returns:
- The new
Text
object.
-
createComment
Create aComment
node given the specified string. DOM method: returns null, because the Saxon tree is not updateable.- Parameters:
data
- The data for the node.- Returns:
- The new
Comment
object.
-
createCDATASection
Create aCDATASection
node whose value is the specified string. DOM method: always fails, because the Saxon tree is not updateable.- Parameters:
data
- The data for theCDATASection
contents.- Returns:
- The new
CDATASection
object. - Throws:
DOMException
- NOT_SUPPORTED_ERR: Raised if this document is an HTML document.
-
createProcessingInstruction
public ProcessingInstruction createProcessingInstruction(String target, String data) throws DOMException Create aProcessingInstruction
node given the specified name and data strings. DOM method: returns null, because the Saxon tree is not updateable.- Parameters:
target
- The target part of the processing instruction.data
- The data for the node.- Returns:
- The new
ProcessingInstruction
object. - Throws:
DOMException
- INVALID_CHARACTER_ERR: Raised if the specified target contains an illegal character.
NOT_SUPPORTED_ERR: Raised if this document is an HTML document.
-
createAttribute
Create anAttr
of the given name. DOM method: always fails, because the Saxon tree is not updateable.- Parameters:
name
- The name of the attribute.- Returns:
- A new
Attr
object with thenodeName
attribute set toname
, andlocalName
,prefix
, andnamespaceURI
set tonull
. - Throws:
DOMException
- INVALID_CHARACTER_ERR: Raised if the specified name contains an illegal character.
-
createEntityReference
Create anEntityReference
object. DOM method: returns null, because the Saxon tree is not updateable.- Parameters:
name
- The name of the entity to reference.- Returns:
- The new
EntityReference
object. - Throws:
DOMException
- INVALID_CHARACTER_ERR: Raised if the specified name contains an illegal character.
NOT_SUPPORTED_ERR: Raised if this document is an HTML document.
-
getElementsByTagName
Return aNodeList
of all theElements
with a given tag name in the order in which they are encountered in a preorder traversal of theDocument
tree.- Parameters:
tagname
- The name of the tag to match on. The special value "*" matches all tags.- Returns:
- A new
NodeList
object containing all the matchedElements
.
-
importNode
Import a node from another document to this document. DOM method: always fails, because the Saxon tree is not updateable.- Throws:
DOMException
- Since:
- DOM Level 2
-
createElementNS
Create an element of the given qualified name and namespace URI. HTML-only DOM implementations do not need to implement this method. DOM method: always fails, because the Saxon tree is not updateable.- Parameters:
namespaceURI
- The namespace URI of the element to create.qualifiedName
- The qualified name of the element type to instantiate.- Returns:
- A new
Element
object - Throws:
DOMException
-
createAttributeNS
Create an attribute of the given qualified name and namespace URI. HTML-only DOM implementations do not need to implement this method. DOM method: returns null, because the Saxon tree is not updateable.- Parameters:
namespaceURI
- The namespace URI of the attribute to create.qualifiedName
- The qualified name of the attribute to instantiate.- Returns:
- A new
Attr
object. - Throws:
DOMException
-
getElementsByTagNameNS
Return aNodeList
of all theElements
with a given local name and namespace URI in the order in which they are encountered in a preorder traversal of theDocument
tree. DOM method.- Parameters:
namespaceURI
- The namespace URI of the elements to match on. The special value "*" matches all namespaces.localName
- The local name of the elements to match on. The special value "*" matches all local names.- Returns:
- A new
NodeList
object containing all the matchedElements
. - Since:
- DOM Level 2
-
getElementById
Return theElement
whoseID
is given byelementId
. If no such element exists, returnsnull
. Behavior is not defined if more than one element has thisID
. The DOM implementation must have information that says which attributes are of type ID. Attributes with the name "ID" are not of type ID unless so defined. Implementations that do not know whether attributes are of type ID or not are expected to returnnull
.- Parameters:
elementId
- The uniqueid
value for an element.- Returns:
- The matching element, or null if there is none.
- Since:
- DOM Level 2
-
getTagName
The name of the element (DOM interface). -
getAttribute
Retrieves an attribute value by name. Namespace declarations will not be retrieved. DOM interface.- Parameters:
name
- The QName of the attribute to retrieve.- Returns:
- The
Attr
value as a string, or the empty string if that attribute does not have a specified or default value.
-
getAttributeNode
Retrieves an attribute node by name. Namespace declarations will not be retrieved.
To retrieve an attribute node by qualified name and namespace URI, use thegetAttributeNodeNS
method.- Parameters:
name
- The name (nodeName
) of the attribute to retrieve.- Returns:
- The
Attr
node with the specified name (nodeName
) ornull
if there is no such attribute.
-
setAttributeNode
Adds a new attribute node. Always fails- Throws:
DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
-
removeAttribute
Removes the specified attribute. Always fails- Throws:
DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
-
removeAttributeNode
Removes the specified attribute node. Always fails- Throws:
DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
-
getAttributeNS
Retrieves an attribute value by local name and namespace URI. HTML-only DOM implementations do not need to implement this method.- Parameters:
namespaceURI
- The namespace URI of the attribute to retrieve.localName
- The local name of the attribute to retrieve.- Returns:
- The
Attr
value as a string, or the empty string if that attribute does not have a specified or default value. - Since:
- DOM Level 2
-
setAttributeNS
public void setAttributeNS(String namespaceURI, String qualifiedName, String value) throws DOMException Adds a new attribute. Always fails.- Parameters:
namespaceURI
- The namespace URI of the attribute to create or alter.qualifiedName
- The qualified name of the attribute to create or alter.value
- The value to set in string form.- Throws:
DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
-
removeAttributeNS
Removes an attribute by local name and namespace URI. Always fails- Throws:
DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.- Since:
- DOM Level 2
-
getAttributeNodeNS
Retrieves anAttr
node by local name and namespace URI. DOM method, so namespace declarations count as attributes.- Parameters:
namespaceURI
- The namespace URI of the attribute to retrieve.localName
- The local name of the attribute to retrieve.- Returns:
- The
Attr
node with the specified attribute local name and namespace URI ornull
if there is no such attribute. - Since:
- DOM Level 2
-
setAttributeNodeNS
Add a new attribute. Always fails.- Parameters:
newAttr
- TheAttr
node to add to the attribute list.- Returns:
- If the
newAttr
attribute replaces an existing attribute with the same local name and namespace URI , the replacedAttr
node is returned, otherwisenull
is returned. - Throws:
DOMException
-
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.- Since:
- DOM Level 2
-
hasAttribute
Returnstrue
when an attribute with a given name is specified on this element or has a default value,false
otherwise. Namespace declarations will not be retrieved.- Parameters:
name
- The name of the attribute to look for.- Returns:
true
if an attribute with the given name is specified on this element or has a default value,false
otherwise.- Since:
- DOM Level 2
-
hasAttributeNS
Returnstrue
when an attribute with a given local name and namespace URI is specified on this element or has a default value,false
otherwise. Namespace declarations will not be retrieved.- Parameters:
namespaceURI
- The namespace URI of the attribute to look for.localName
- The local name of the attribute to look for.- Returns:
true
if an attribute with the given local name and namespace URI is specified or has a default value on this element,false
otherwise.- Since:
- DOM Level 2
-
getData
Get the character data of a Text or Comment node. DOM method. -
setData
Set the character data of a Text or Comment node. DOM method: always fails, Saxon tree is immutable.- Throws:
DOMException
-
getLength
public int getLength()Get the length of a Text or Comment node. DOM method. -
substringData
Extract a range of data from a Text or Comment node. DOM method.- Parameters:
offset
- Start offset of substring to extract.count
- The number of 16-bit units to extract.- Returns:
- The specified substring. If the sum of
offset
andcount
exceeds thelength
, then all 16-bit units to the end of the data are returned. - Throws:
DOMException
- INDEX_SIZE_ERR: Raised if the specifiedoffset
is negative or greater than the number of 16-bit units indata
, or if the specifiedcount
is negative.
-
appendData
Append the string to the end of the character data of the node. DOM method: always fails.- Parameters:
arg
- TheDOMString
to append.- Throws:
DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
-
insertData
Insert a string at the specified character offset. DOM method: always fails.- Parameters:
offset
- The character offset at which to insert.arg
- TheDOMString
to insert.- Throws:
DOMException
-
deleteData
Remove a range of 16-bit units from the node. DOM method: always fails.- Parameters:
offset
- The offset from which to start removing.count
- The number of 16-bit units to delete.- Throws:
DOMException
-
replaceData
Replace the characters starting at the specified 16-bit unit offset with the specified string. DOM method: always fails.- Parameters:
offset
- The offset from which to start replacing.count
- The number of 16-bit units to replace.arg
- TheDOMString
with which the range must be replaced.- Throws:
DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
-
splitText
Break this node into two nodes at the specified offset, keeping both in the tree as siblings. DOM method, always fails.- Parameters:
offset
- The 16-bit unit offset at which to split, starting from 0.- Returns:
- The new node, of the same type as this node.
- Throws:
DOMException
-
getName
Get the name of an attribute node (the QName) (DOM method) -
getValue
Return the character value of an attribute node (DOM method)- Returns:
- the attribute value
-
getSpecified
public boolean getSpecified()If this attribute was explicitly given a value in the original document, this istrue
; otherwise, it isfalse
. (DOM method)- Returns:
- Always true in this implementation.
-
setValue
Set the value of an attribute node. (DOM method). Always fails (because tree is readonly)- Throws:
DOMException
-
getOwnerElement
TheElement
node this attribute is attached to ornull
if this attribute is not in use.- Since:
- DOM Level 2
-
getSchemaTypeInfo
The type information associated with this attribute. While the type information contained in this attribute is guarantee to be correct after loading the document or invokingDocument.normalizeDocument()
,schemaTypeInfo
may not be reliable if the node was moved.This implementation always returns null;
- Since:
- DOM Level 3
-
isId
public boolean isId()Returns whether this attribute is known to be of type ID (i.e. to contain an identifier for its owner element) or not.This implementation always returns false.
- Since:
- DOM Level 3
-
compareDocumentPosition
Compares the reference node, i.e. the node on which this method is being called, with a node, i.e. the one passed as a parameter, with regard to their position in the document and according to the document order.- Specified by:
compareDocumentPosition
in interfaceNode
- Parameters:
other
- The node to compare against the reference node.- Returns:
- Returns how the node is positioned relatively to the reference node.
- Throws:
DOMException
- NOT_SUPPORTED_ERR: when the compared nodes are from different DOM implementations that do not coordinate to return consistent implementation-specific results.- Since:
- DOM Level 3
-
getFeature
This method returns a specialized object which implements the specialized APIs of the specified feature and version, as specified in . The specialized object may also be obtained by using binding-specific casting methods but is not necessarily expected to, as discussed in . This method also allow the implementation to provide specialized objects which do not support theNode
interface.- Specified by:
getFeature
in interfaceNode
- Parameters:
feature
- The name of the feature requested. Note that any plus sign "+" prepended to the name of the feature will be ignored since it is not significant in the context of this method.version
- This is the version number of the feature to test.- Returns:
- Returns an object which implements the specialized APIs of
the specified feature and version, if any, or
null
if there is no object which implements interfaces associated with that feature. If theDOMObject
returned by this method implements theNode
interface, it must delegate to the primary coreNode
and not return results inconsistent with the primary coreNode
such as attributes, childNodes, etc.The Saxon implementation of this method always returns null
- Since:
- DOM Level 3
-
getTextContent
This attribute returns the text content of this node and its descendants. When it is defined to benull
, setting it has no effect. On setting, any possible children this node may have are removed and, if it the new string is not empty ornull
, replaced by a singleText
node containing the string this attribute is set to.
On getting, no serialization is performed, the returned string does not contain any markup. No whitespace normalization is performed and the returned string does not contain the white spaces in element content (see the attributeText.isElementContentWhitespace
). Similarly, on setting, no parsing is performed either, the input string is taken as pure textual content.
The string returned is made of the text content of this node depending on its type, as defined below:Node type Content ELEMENT_NODE, ATTRIBUTE_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, DOCUMENT_FRAGMENT_NODE concatenation of the textContent
attribute value of every child node, excluding COMMENT_NODE and PROCESSING_INSTRUCTION_NODE nodes. This is the empty string if the node has no children.TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE, PROCESSING_INSTRUCTION_NODE nodeValue
DOCUMENT_NODE, DOCUMENT_TYPE_NODE, NOTATION_NODE null The Saxon implementation returns the same result as getStringValue()
- Specified by:
getTextContent
in interfaceNode
- Throws:
DOMException
- DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in aDOMString
variable on the implementation platform.- Since:
- DOM Level 3
-
getUserData
Retrieves the object associated to a key on a this node. The object must first have been set to this node by callingsetUserData
with the same key.The Saxon implementation always returns null.
- Specified by:
getUserData
in interfaceNode
- Parameters:
key
- The key the object is associated to.- Returns:
- Returns the
DOMUserData
associated to the given key on this node, ornull
if there was none. - Since:
- DOM Level 3
-
isDefaultNamespace
This method checks if the specifiednamespaceURI
is the default namespace or not.- Specified by:
isDefaultNamespace
in interfaceNode
- Parameters:
namespaceURI
- The namespace URI to look for.- Returns:
- Returns
true
if the specifiednamespaceURI
is the default namespace,false
otherwise. - Since:
- DOM Level 3
-
isEqualNode
Tests whether two nodes are equal.
This method tests for equality of nodes, not sameness (i.e., whether the two nodes are references to the same object) which can be tested withNode.isSameNode()
. All nodes that are the same will also be equal, though the reverse may not be true.
Two nodes are equal if and only if the following conditions are satisfied:- The two nodes are of the same type.
- The following string
attributes are equal:
nodeName
,localName
,namespaceURI
,prefix
,nodeValue
. This is: they are bothnull
, or they have the same length and are character for character identical. - The
attributes
NamedNodeMaps
are equal. This is: they are bothnull
, or they have the same length and for each node that exists in one map there is a node that exists in the other map and is equal, although not necessarily at the same index. - The
childNodes
NodeLists
are equal. This is: they are bothnull
, or they have the same length and contain equal nodes at the same index. Note that normalization can affect equality; to avoid this, nodes should be normalized before being compared.
For twoDocumentType
nodes to be equal, the following conditions must also be satisfied:- The following string attributes
are equal:
publicId
,systemId
,internalSubset
. - The
entities
NamedNodeMaps
are equal. - The
notations
NamedNodeMaps
are equal.
On the other hand, the following do not affect equality: theownerDocument
,baseURI
, andparentNode
attributes, thespecified
attribute forAttr
nodes, theschemaTypeInfo
attribute forAttr
andElement
nodes, theText.isElementContentWhitespace
attribute forText
nodes, as well as any user data or event listeners registered on the nodes.Note: As a general rule, anything not mentioned in the description above is not significant in consideration of equality checking. Note that future versions of this specification may take into account more attributes and implementations conform to this specification are expected to be updated accordingly.
- Specified by:
isEqualNode
in interfaceNode
- Parameters:
arg
- The node to compare equality with.- Returns:
- Returns
true
if the nodes are equal,false
otherwise. - Since:
- DOM Level 3
-
isSameNode
Returns whether this node is the same node as the given one.
This method provides a way to determine whether twoNode
references returned by the implementation reference the same object. When twoNode
references are references to the same object, even if through a proxy, the references may be used completely interchangeably, such that all attributes have the same values and calling the same DOM method on either reference always has exactly the same effect.- Specified by:
isSameNode
in interfaceNode
- Parameters:
other
- The node to test against.- Returns:
- Returns
true
if the nodes are the same,false
otherwise. - Since:
- DOM Level 3
-
lookupNamespaceURI
Look up the namespace URI associated to the given prefix, starting from this node.
See for details on the algorithm used by this method.- Specified by:
lookupNamespaceURI
in interfaceNode
- Parameters:
prefix
- The prefix to look for. If this parameter isnull
, the method will return the default namespace URI if any.- Returns:
- Returns the associated namespace URI or
null
if none is found. - Since:
- DOM Level 3
-
lookupPrefix
Look up the prefix associated to the given namespace URI, starting from this node. The default namespace declarations are ignored by this method.
See for details on the algorithm used by this method.- Specified by:
lookupPrefix
in interfaceNode
- Parameters:
namespaceURI
- The namespace URI to look for.- Returns:
- Returns an associated namespace prefix if found or
null
if none is found. If more than one prefix are associated to the namespace prefix, the returned namespace prefix is implementation dependent. - Since:
- DOM Level 3
-
setTextContent
This attribute returns the text content of this node and its descendants. When it is defined to benull
, setting it has no effect. On setting, any possible children this node may have are removed and, if it the new string is not empty ornull
, replaced by a singleText
node containing the string this attribute is set to.
On getting, no serialization is performed, the returned string does not contain any markup. No whitespace normalization is performed and the returned string does not contain the white spaces in element content (see the attributeText.isElementContentWhitespace
). Similarly, on setting, no parsing is performed either, the input string is taken as pure textual content.
The string returned is made of the text content of this node depending on its type, as defined below:Node type Content ELEMENT_NODE, ATTRIBUTE_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, DOCUMENT_FRAGMENT_NODE concatenation of the textContent
attribute value of every child node, excluding COMMENT_NODE and PROCESSING_INSTRUCTION_NODE nodes. This is the empty string if the node has no children.TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE, PROCESSING_INSTRUCTION_NODE nodeValue
DOCUMENT_NODE, DOCUMENT_TYPE_NODE, NOTATION_NODE null - Specified by:
setTextContent
in interfaceNode
- Throws:
DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.- Since:
- DOM Level 3
-
setUserData
Associate an object to a key on this node. The object can later be retrieved from this node by callinggetUserData
with the same key.- Specified by:
setUserData
in interfaceNode
- Parameters:
key
- The key to associate the object to.data
- The object to associate to the given key, ornull
to remove any existing association to that key.handler
- The handler to associate to that key, ornull
.- Returns:
- Returns the
DOMUserData
previously associated to the given key on this node, ornull
if there was none. - Since:
- DOM Level 3
-
getWholeText
Returns all text ofText
nodes logically-adjacent text nodes to this node, concatenated in document order.
For instance, in the example belowwholeText
on theText
node that contains "bar" returns "barfoo", while on theText
node that contains "foo" it returns "barfoo".- Since:
- DOM Level 3
-
isElementContentWhitespace
public boolean isElementContentWhitespace()Returns whether this text node contains element content whitespace, often abusively called "ignorable whitespace". The text node is determined to contain whitespace in element content during the load of the document or if validation occurs while usingDocument.normalizeDocument()
.The Saxon implementation always returns false.
- Since:
- DOM Level 3
-
replaceWholeText
Replaces the text of the current node and all logically-adjacent text nodes with the specified text. All logically-adjacent text nodes are removed including the current node unless it was the recipient of the replacement text.
This method returns the node which received the replacement text. The returned node is:null
, when the replacement text is the empty string;- the current node, except when the current node is read-only;
- a new
Text
node of the same type (Text
orCDATASection
) as the current node inserted at the location of the replacement.
For instance, in the above example callingreplaceWholeText
on theText
node that contains "bar" with "yo" in argument results in the following:
Where the nodes to be removed are read-only descendants of anEntityReference
, theEntityReference
must be removed instead of the read-only nodes. If anyEntityReference
to be removed has descendants that are notEntityReference
,Text
, orCDATASection
nodes, thereplaceWholeText
method must fail before performing any modification of the document, raising aDOMException
with the codeNO_MODIFICATION_ALLOWED_ERR
.
For instance, in the example below callingreplaceWholeText
on theText
node that contains "bar" fails, because theEntityReference
node "ent" contains anElement
node which cannot be removed.- Parameters:
content
- The content of the replacingText
node.- Returns:
- The
Text
node created with the specified content. - Throws:
DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised if one of theText
nodes being replaced is readonly.- Since:
- DOM Level 3
-
setIdAttribute
If the parameterisId
istrue
, this method declares the specified attribute to be a user-determined ID attribute . This affects the value ofAttr.isId
and the behavior ofDocument.getElementById
, but does not change any schema that may be in use, in particular this does not affect theAttr.schemaTypeInfo
of the specifiedAttr
node. Use the valuefalse
for the parameterisId
to undeclare an attribute for being a user-determined ID attribute.
To specify an attribute by local name and namespace URI, use thesetIdAttributeNS
method.- Parameters:
name
- The name of the attribute.isId
- Whether the attribute is a of type ID.- Throws:
DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NOT_FOUND_ERR: Raised if the specified node is not an attribute of this element.- Since:
- DOM Level 3
-
setIdAttributeNode
If the parameterisId
istrue
, this method declares the specified attribute to be a user-determined ID attribute . This affects the value ofAttr.isId
and the behavior ofDocument.getElementById
, but does not change any schema that may be in use, in particular this does not affect theAttr.schemaTypeInfo
of the specifiedAttr
node. Use the valuefalse
for the parameterisId
to undeclare an attribute for being a user-determined ID attribute.- Parameters:
idAttr
- The attribute node.isId
- Whether the attribute is a of type ID.- Throws:
DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NOT_FOUND_ERR: Raised if the specified node is not an attribute of this element.- Since:
- DOM Level 3
-
setIdAttributeNS
public void setIdAttributeNS(String namespaceURI, String localName, boolean isId) throws DOMException If the parameterisId
istrue
, this method declares the specified attribute to be a user-determined ID attribute . This affects the value ofAttr.isId
and the behavior ofDocument.getElementById
, but does not change any schema that may be in use, in particular this does not affect theAttr.schemaTypeInfo
of the specifiedAttr
node. Use the valuefalse
for the parameterisId
to undeclare an attribute for being a user-determined ID attribute.- Parameters:
namespaceURI
- The namespace URI of the attribute.localName
- The local name of the attribute.isId
- Whether the attribute is a of type ID.- Throws:
DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NOT_FOUND_ERR: Raised if the specified node is not an attribute of this element.- Since:
- DOM Level 3
-