Interface XNode

Devguide

Index

Methods' Summary

Attributes' Summary

Methods' Details

Attributes' Details

:: com :: sun :: star :: xml :: dom ::

unpublished

interface XNode

Usage Restrictions

not published

Description

The primary dom datatype

The Node interface is the primary datatype for the entire Document Object Model. It represents a single node in the document tree. While all objects implementing the Node interface expose methods for dealing with children, not all objects #implementing the Node interface may have children. For example, Text nodes may not have children, and adding children to such nodes results in a DOMException being raised.

The attributes nodeName, nodeValue and attributes are included as a mechanism to get at node information without casting down to the specific derived interface. In cases where there is no obvious mapping of these attributes for a specific nodeType (e.g., nodeValue for an Element or attributes for a Comment ), this returns null. Note that the specialized interfaces may contain additional and more convenient mechanisms to get and set the relevant information.

The values of nodeName, nodeValue, and attributes vary according to the node type as follows:

Interface	nodeName	nodeValue	attributes
Attr	name of attribute	value of attribute	null
CDATASection	"#cdata-section"	content of the CDATA Section	null
Comment	"#comment"	content of the comment	null
Document	"#document"	null	null
DocumentFragment	"#document-fragment"	null	null
DocumentType	document type name	null	null
Element	tag name	null	NamedNodeMap
Entity	entity name	null	null
EntityReference	name of entity referenced	null	null
Notation	notation name	null	null
ProcessingInstruction	target	entire content excluding the target	null
Text	"#text"	content of the text node	null

Since

OOo 2.0

See also

? (no identifier found)
Document Object Model (DOM) Level 2 Core Specification

Methods' Summary
appendChild	Adds the node newChild to the end of the list of children of this node.
cloneNode	Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes.
getAttributes	A NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise.
getChildNodes	A NodeList that contains all children of this node.
getFirstChild	The first child of this node.
getLastChild	The last child of this node.
getLocalName	Returns the local part of the qualified name of this node.
getNamespaceURI	The namespace URI of this node, or null if it is unspecified.
getNextSibling	The node immediately following this node.
getNodeName	The name of this node, depending on its type; see the table above.
getNodeType	A code representing the type of the underlying object, as defined above.
getNodeValue	The value of this node, depending on its type; see the table above.
getOwnerDocument	The Document object associated with this node.
getParentNode	The parent of this node.
getPrefix	The namespace prefix of this node, or null if it is unspecified.
getPreviousSibling	The node immediately preceding this node.
hasAttributes	Returns whether this node (if it is an element) has any attributes.
hasChildNodes	Returns whether this node has any children.
insertBefore	Inserts the node newChild before the existing child node refChild.
isSupported	Tests whether the DOM implementation implements a specific feature and that feature is supported by this node.
normalize	Puts all Text nodes in the full depth of the sub-tree underneath this Node, including attribute nodes, into a "normal" form where only structure (e.g., elements, comments, processing instructions, CDATA sections, and entity references) separates Text nodes, i.e., there are neither adjacent Text nodes nor empty Text nodes.
removeChild	Removes the child node indicated by oldChild from the list of children, and returns it.
replaceChild	Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node.
setNodeValue	The value of this node, depending on its type; see the table above.
setPrefix	The namespace prefix of this node, or null if it is unspecified.

Methods' Details

appendChild

XNode
appendChild(	[in] XNode	newChild )
raises(	DOMException );

Description

Adds the node newChild to the end of the list of children of this node.

Parameter newChild

the new child node

Throws

com::sun::star::xml::dom::DOMException

HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of the newChild node, or if the node to append is one of this node's ancestors or this node itself.

WRONG_DOCUMENT_ERR: Raised if newChild was created from a different document than the one that created this node.

NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly or if the previous parent of the node being inserted is readonly.

cloneNode

XNode
cloneNode(	[in] boolean	deep );

Description: Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes.
Parameter deep: true: clone node together with any children
false: clone without children
Returns: the cloned node

getAttributes

XNamedNodeMap
getAttributes();

Description: A NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise.

getChildNodes

XNodeList
getChildNodes();

Description: A NodeList that contains all children of this node.

getFirstChild

XNode
getFirstChild();

Description: The first child of this node.

getLastChild

XNode
getLastChild();

Description: The last child of this node.

getLocalName

string
getLocalName();

Description: Returns the local part of the qualified name of this node.

getNamespaceURI

string
getNamespaceURI();

Description: The namespace URI of this node, or null if it is unspecified.

getNextSibling

XNode
getNextSibling();

Description: The node immediately following this node.

getNodeName

string
getNodeName();

Description: The name of this node, depending on its type; see the table above.

getNodeType

NodeType
getNodeType();

Description: A code representing the type of the underlying object, as defined above.

getNodeValue

string
getNodeValue()
raises(	DOMException );

Description: The value of this node, depending on its type; see the table above.
Throws: com::sun::star::xml::dom::DOMException
DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a DOMString variable on the implementation platform.

getOwnerDocument

XDocument
getOwnerDocument();

Description: The Document object associated with this node.

getParentNode

XNode
getParentNode();

Description: The parent of this node.

getPrefix

string
getPrefix();

Description: The namespace prefix of this node, or null if it is unspecified.

getPreviousSibling

XNode
getPreviousSibling();

Description: The node immediately preceding this node.

hasAttributes

boolean
hasAttributes();

Description: Returns whether this node (if it is an element) has any attributes.

hasChildNodes

boolean
hasChildNodes();

Description: Returns whether this node has any children.

insertBefore

XNode
insertBefore(	[in] XNode	newChild,
	[in] XNode	refChild )
raises(	DOMException );

Description

Inserts the node newChild before the existing child node refChild.

Throws

DOMException

HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of the newChild node, or if the node to insert is one of this node's ancestors or this node itself.

WRONG_DOCUMENT_ERR: Raised if newChild was created from a different document than the one that created this node.

NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly or if the parent of the node being inserted is readonly.

NOT_FOUND_ERR: Raised if refChild is not a child of this node.

isSupported

boolean
isSupported(	[in] string	feature,
	[in] string	ver );

Description: Tests whether the DOM implementation implements a specific feature and that feature is supported by this node.

normalize

void
normalize();

Description: Puts all Text nodes in the full depth of the sub-tree underneath this Node, including attribute nodes, into a "normal" form where only structure (e.g., elements, comments, processing instructions, CDATA sections, and entity references) separates Text nodes, i.e., there are neither adjacent Text nodes nor empty Text nodes.

removeChild

XNode
removeChild(	[in] XNode	oldChild )
raises(	DOMException );

Description

Removes the child node indicated by oldChild from the list of children, and returns it.

Throws

DOMException

NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

NOT_FOUND_ERR: Raised if oldChild is not a child of this node.

replaceChild

XNode
replaceChild(	[in] XNode	newChild,
	[in] XNode	oldChild )
raises(	DOMException );

Description

Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node.

Throws

DOMException

HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of the newChild node, or if the node to put in is one of this node's ancestors or this node itself.

WRONG_DOCUMENT_ERR: Raised if newChild was created from a different document than the one that created this node.

NO_MODIFICATION_ALLOWED_ERR: Raised if this node or the parent of the new node is readonly.

NOT_FOUND_ERR: Raised if oldChild is not a child of this node.

setNodeValue

void
setNodeValue(	[in] string	nodeValue )
raises(	DOMException );

Description

The value of this node, depending on its type; see the table above.

Throws

DOMException

NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.

DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a DOMString variable on the implementation platform.

setPrefix

void
setPrefix(	[in] string	prefix )
raises(	DOMException );

Description

The namespace prefix of this node, or null if it is unspecified.

Throws

DOMException

INVALID_CHARACTER_ERR: Raised if the specified prefix contains an illegal character, per the XML 1.0 specification .

NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

NAMESPACE_ERR: Raised if the specified prefix is malformed per the Namespaces in XML specification, if the namespaceURI of this node is null, if the specified prefix is "xml" and the namespaceURI of this node is different from "http://www.w3.org/XML/1998/namespace", if this node is an attribute and the specified prefix is "xmlns" and the namespaceURI of this node is different from " http://www.w3.org/2000/xmlns/", or if this node is an attribute and the qualifiedName of this node is "xmlns" .

Top of Page

Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.

API

SDK

Tips ‘n’ Tricks

Miscellaneous