com.marklogic.dom

Class NodeImpl

java.lang.Object

com.marklogic.dom.NodeImpl

All Implemented Interfaces:

Node

Direct Known Subclasses:

AttrImpl, CharacterDataImpl, DocumentImpl, DocumentTypeImpl, ElementImpl, ProcessingInstructionImpl

public abstract class NodeImpl
extends Object
implements Node

A read-only W3C DOM Node implementation of MarkLogic's internal representation of a node as stored in the expanded tree cache of a forest on disk.

This interface is effectively read-only: Setters and update methods inherited from org.w3c.Node are not supported and will raise an exception if called.

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.commons.logging.Log	LOG
protected int	node
protected ExpandedTree	tree

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

Method Summary

Modifier and Type	Method and Description
Node	appendChild(Node newChild) Unsupported.
protected String	builtinNSPrefix(String URI)
Node	cloneNode(boolean deep) CloneNode is only supported for document node.
protected Node	cloneNode(Document doc, boolean deep) Given a owner document, clone the node
short	compareDocumentPosition(Node other)
NamedNodeMap	getAttributes()
String	getBaseURI()
NodeList	getChildNodes()
protected NodeList	getElementsByTagNameNSOrNodeName(String namespaceURI, String name, boolean nodeName)
ExpandedTree	getExpandedTree()
Object	getFeature(String feature, String version) Unsupported.
Node	getFirstChild()
Node	getLastChild()
String	getLocalName()
String	getNamespaceURI()
protected Node	getNextChild(int node)
Node	getNextSibling()
abstract String	getNodeName()
short	getNodeType()
String	getNodeValue()
protected int	getNSNodeID(long ordinal)
protected int	getNSNodeID(long ordinal, long minOrdinal)
Document	getOwnerDocument() OwnerDocument of namespace attribute is created artificially, which only contains the attribute only.
Node	getParentNode()
String	getPrefix()
protected int	getPrefixID(int uriAtom)
protected Node	getPreviousChild(int child)
Node	getPreviousSibling()
String	getTextContent() Overwritten by TextImpl, CommentImpl and ProcessingInstructionImpl
Object	getUserData(String key) Unsupported.
boolean	hasAttributes()
boolean	hasChildNodes()
Node	insertBefore(Node newChild, Node refChild) Unsupported.
boolean	isDefaultNamespace(String namespaceURI)
boolean	isEqualNode(Node other)
boolean	isSameNode(Node other)
boolean	isSupported(String feature, String version)
String	lookupNamespaceURI(String prefix)
String	lookupPrefix(String namespaceURI)
protected int	nextNSNodeID(int ns, long minOrdinal)
void	normalize() Unsupported.
Node	removeChild(Node oldChild) Unsupported.
Node	replaceChild(Node newChild, Node oldChild) Unsupported.
void	setNodeValue(String nodeValue) Unsupported.
void	setPrefix(String prefix) Unsupported.
void	setTextContent(String textContent) Unsupported.
Object	setUserData(String key, Object data, UserDataHandler handler) Unsupported.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

public static final org.apache.commons.logging.Log LOG

tree

protected final ExpandedTree tree

node

protected final int node

Method Detail

getExpandedTree

public ExpandedTree getExpandedTree()

appendChild

public Node appendChild(Node newChild)
                 throws DOMException

Unsupported.

Specified by:

appendChild in interface Node

Throws:

DOMException

cloneNode

public Node cloneNode(boolean deep)

CloneNode is only supported for document node.

Specified by:

cloneNode in interface Node

cloneNode

protected Node cloneNode(Document doc,
                         boolean deep)

Given a owner document, clone the node

Parameters:

doc - owner document

deep - the flag to indicate deep clone or not

Returns:

null

compareDocumentPosition

public short compareDocumentPosition(Node other)
                              throws DOMException

Specified by:

compareDocumentPosition in interface Node

Throws:

DOMException

getAttributes

public NamedNodeMap getAttributes()

Specified by:

getAttributes in interface Node

getBaseURI

public String getBaseURI()

Specified by:

getBaseURI in interface Node

getChildNodes

public NodeList getChildNodes()

Specified by:

getChildNodes in interface Node

getFeature

public Object getFeature(String feature,
                         String version)

Unsupported.

Specified by:

getFeature in interface Node

getFirstChild

public Node getFirstChild()

Specified by:

getFirstChild in interface Node

getLastChild

public Node getLastChild()

Specified by:

getLastChild in interface Node

getLocalName

public String getLocalName()

Specified by:

getLocalName in interface Node

getNamespaceURI

public String getNamespaceURI()

Specified by:

getNamespaceURI in interface Node

getNextChild

protected Node getNextChild(int node)

getNextSibling

public Node getNextSibling()

Specified by:

getNextSibling in interface Node

getNodeName

public abstract String getNodeName()

Specified by:

getNodeName in interface Node

getNodeType

public short getNodeType()

Specified by:

getNodeType in interface Node

getNodeValue

public String getNodeValue()
                    throws DOMException

Specified by:

getNodeValue in interface Node

Throws:

DOMException

getOwnerDocument

public Document getOwnerDocument()

OwnerDocument of namespace attribute is created artificially, which only contains the attribute only.

Specified by:

getOwnerDocument in interface Node

getParentNode

public Node getParentNode()

Specified by:

getParentNode in interface Node

getPrefixID

protected int getPrefixID(int uriAtom)

getPrefix

public String getPrefix()

Specified by:

getPrefix in interface Node

getPreviousChild

protected Node getPreviousChild(int child)

getPreviousSibling

public Node getPreviousSibling()

Specified by:

getPreviousSibling in interface Node

getTextContent

public String getTextContent()
                      throws DOMException

Overwritten by TextImpl, CommentImpl and ProcessingInstructionImpl

Specified by:

getTextContent in interface Node

Throws:

DOMException

getUserData

public Object getUserData(String key)

Unsupported.

Specified by:

getUserData in interface Node

hasAttributes

public boolean hasAttributes()

Specified by:

hasAttributes in interface Node

hasChildNodes

public boolean hasChildNodes()

Specified by:

hasChildNodes in interface Node

insertBefore

public Node insertBefore(Node newChild,
                         Node refChild)
                  throws DOMException

Unsupported.

Specified by:

insertBefore in interface Node

Throws:

DOMException

isDefaultNamespace

public boolean isDefaultNamespace(String namespaceURI)

Not supported for namespace declaration. Overrided by DocumentImpl and ElementImpl

Specified by:

isDefaultNamespace in interface Node

isEqualNode

public boolean isEqualNode(Node other)

Specified by:

isEqualNode in interface Node

isSameNode

public boolean isSameNode(Node other)

Specified by:

isSameNode in interface Node

isSupported

public boolean isSupported(String feature,
                           String version)

Specified by:

isSupported in interface Node

getNSNodeID

protected int getNSNodeID(long ordinal,
                          long minOrdinal)

getNSNodeID

protected int getNSNodeID(long ordinal)

nextNSNodeID

protected int nextNSNodeID(int ns,
                           long minOrdinal)

lookupNamespaceURI

public String lookupNamespaceURI(String prefix)

Specified by:

lookupNamespaceURI in interface Node

lookupPrefix

public String lookupPrefix(String namespaceURI)

Specified by:

lookupPrefix in interface Node

normalize

public void normalize()

Unsupported.

Specified by:

normalize in interface Node

removeChild

public Node removeChild(Node oldChild)
                 throws DOMException

Unsupported.

Specified by:

removeChild in interface Node

Throws:

DOMException

replaceChild

public Node replaceChild(Node newChild,
                         Node oldChild)
                  throws DOMException

Unsupported.

Specified by:

replaceChild in interface Node

Throws:

DOMException

setNodeValue

public void setNodeValue(String nodeValue)
                  throws DOMException

Unsupported.

Specified by:

setNodeValue in interface Node

Throws:

DOMException

setPrefix

public void setPrefix(String prefix)
               throws DOMException

Unsupported.

Specified by:

setPrefix in interface Node

Throws:

DOMException

setTextContent

public void setTextContent(String textContent)
                    throws DOMException

Unsupported.

Specified by:

setTextContent in interface Node

Throws:

DOMException

setUserData

public Object setUserData(String key,
                          Object data,
                          UserDataHandler handler)

Unsupported.

Specified by:

setUserData in interface Node

getElementsByTagNameNSOrNodeName

protected NodeList getElementsByTagNameNSOrNodeName(String namespaceURI,
                                                    String name,
                                                    boolean nodeName)

builtinNSPrefix

protected String builtinNSPrefix(String URI)