com.marklogic.dom

Class DocumentImpl

java.lang.Object

com.marklogic.dom.NodeImpl

com.marklogic.dom.DocumentImpl

All Implemented Interfaces:

Document, Node

public class DocumentImpl
extends NodeImpl
implements Document

A read-only W3C DOM Node implementation of MarkLogic's internal representation of an XML or text document 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. To create a modifiable copy of a node for XML document, use cloneNode(boolean). Text document cannot be cloned.

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.commons.logging.Log	LOG

Fields inherited from class com.marklogic.dom.NodeImpl

node, 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

Constructor Summary

Constructors

Constructor and Description
DocumentImpl(ExpandedTree tree, int node)

Method Summary

Modifier and Type	Method and Description
Node	adoptNode(Node arg0) Unsupported.
Node	cloneNode(boolean deep) CloneNode is only supported for document node.
Attr	createAttribute(String arg0) Unsupported.
Attr	createAttributeNS(String arg0, String arg1) Unsupported.
CDATASection	createCDATASection(String arg0) Unsupported.
Comment	createComment(String arg0) Unsupported.
DocumentFragment	createDocumentFragment() Unsupported.
Element	createElement(String arg0) Unsupported.
Element	createElementNS(String arg0, String arg1) Unsupported.
EntityReference	createEntityReference(String arg0) Unsupported.
ProcessingInstruction	createProcessingInstruction(String arg0, String arg1) Unsupported.
Text	createTextNode(String arg0) Unsupported.
NodeList	getChildNodes()
DocumentType	getDoctype() Returns a dummy DocumentTypeImpl object that contains nothing.
Element	getDocumentElement()
String	getDocumentURI()
DOMConfiguration	getDomConfig() Unsupported.
Element	getElementById(String arg0) Unsupported.
NodeList	getElementsByTagName(String localName)
NodeList	getElementsByTagNameNS(String namespaceURI, String name)
Node	getFirstChild()
int	getFirstChildIndex()
DOMImplementation	getImplementation() Unsupported.
String	getInputEncoding() Unsupported.
Node	getLastChild()
protected Node	getNextChild(int child)
String	getNodeName()
protected int	getNumChildren()
Document	getOwnerDocument() OwnerDocument of namespace attribute is created artificially, which only contains the attribute only.
protected Node	getPreviousChild(int node)
boolean	getStrictErrorChecking() Unsupported.
String	getXmlEncoding() Unsupported.
boolean	getXmlStandalone() Unsupported.
String	getXmlVersion()
boolean	hasChildNodes()
Node	importNode(Node arg0, boolean arg1) Unsupported.
protected void	initClonedOwnerDoc()
boolean	isDefaultNamespace(String namespaceURI)
boolean	isXMLDoc() Document can be an XML document or a text document.
String	lookupNamespaceURI(String prefix)
String	lookupPrefix(String namespaceURI)
void	normalizeDocument() Unsupported.
Node	renameNode(Node arg0, String arg1, String arg2) Unsupported.
void	setDocumentURI(String arg0) Unsupported.
void	setStrictErrorChecking(boolean arg0) Unsupported.
void	setXmlStandalone(boolean arg0) Unsupported.
void	setXmlVersion(String arg0) Unsupported.

Methods inherited from class com.marklogic.dom.NodeImpl

appendChild, builtinNSPrefix, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getElementsByTagNameNSOrNodeName, getExpandedTree, getFeature, getLocalName, getNamespaceURI, getNextSibling, getNodeType, getNodeValue, getNSNodeID, getNSNodeID, getParentNode, getPrefix, getPrefixID, getPreviousSibling, getTextContent, getUserData, hasAttributes, insertBefore, isEqualNode, isSameNode, isSupported, nextNSNodeID, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData

Methods 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

appendChild, compareDocumentPosition, getAttributes, getBaseURI, getFeature, getLocalName, getNamespaceURI, getNextSibling, getNodeType, getNodeValue, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, insertBefore, isEqualNode, isSameNode, isSupported, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData

Field Detail

LOG

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

Constructor Detail

DocumentImpl

public DocumentImpl(ExpandedTree tree,
                    int node)

Method Detail

cloneNode

public Node cloneNode(boolean deep)

CloneNode is only supported for document node.

Text documents in MarkLogic cannot be cloned. UnsupportedOperationException will be thrown if cloneNode is call on text document. </>

DocumentType node will not be cloned as it is not part of the Expanded Tree.</>

Specified by:

cloneNode in interface Node

Overrides:

cloneNode in class NodeImpl

initClonedOwnerDoc

protected void initClonedOwnerDoc()
                           throws ParserConfigurationException

Throws:

ParserConfigurationException

isXMLDoc

public boolean isXMLDoc()

Document can be an XML document or a text document.

Returns:

true if XML document; otherwise false.

getNodeName

public String getNodeName()

Description copied from class: NodeImpl

Specified by:

getNodeName in interface Node

Specified by:

getNodeName in class NodeImpl

getOwnerDocument

public Document getOwnerDocument()

Description copied from class: NodeImpl

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

Specified by:

getOwnerDocument in interface Node

Overrides:

getOwnerDocument in class NodeImpl

getNumChildren

protected int getNumChildren()

getFirstChildIndex

public int getFirstChildIndex()

getChildNodes

public NodeList getChildNodes()

Description copied from class: NodeImpl

Specified by:

getChildNodes in interface Node

Overrides:

getChildNodes in class NodeImpl

getFirstChild

public Node getFirstChild()

Description copied from class: NodeImpl

Specified by:

getFirstChild in interface Node

Overrides:

getFirstChild in class NodeImpl

getLastChild

public Node getLastChild()

Description copied from class: NodeImpl

Specified by:

getLastChild in interface Node

Overrides:

getLastChild in class NodeImpl

hasChildNodes

public boolean hasChildNodes()

Description copied from class: NodeImpl

Specified by:

hasChildNodes in interface Node

Overrides:

hasChildNodes in class NodeImpl

getNextChild

protected Node getNextChild(int child)

Overrides:

getNextChild in class NodeImpl

getPreviousChild

protected Node getPreviousChild(int node)

Overrides:

getPreviousChild in class NodeImpl

adoptNode

public Node adoptNode(Node arg0)
               throws DOMException

Unsupported.

Specified by:

adoptNode in interface Document

Throws:

DOMException

createAttribute

public Attr createAttribute(String arg0)
                     throws DOMException

Unsupported.

Specified by:

createAttribute in interface Document

Throws:

DOMException

createAttributeNS

public Attr createAttributeNS(String arg0,
                              String arg1)
                       throws DOMException

Unsupported.

Specified by:

createAttributeNS in interface Document

Throws:

DOMException

createCDATASection

public CDATASection createCDATASection(String arg0)
                                throws DOMException

Unsupported.

Specified by:

createCDATASection in interface Document

Throws:

DOMException

createComment

public Comment createComment(String arg0)

Unsupported.

Specified by:

createComment in interface Document

createDocumentFragment

public DocumentFragment createDocumentFragment()

Unsupported.

Specified by:

createDocumentFragment in interface Document

createElement

public Element createElement(String arg0)
                      throws DOMException

Unsupported.

Specified by:

createElement in interface Document

Throws:

DOMException

createElementNS

public Element createElementNS(String arg0,
                               String arg1)
                        throws DOMException

Unsupported.

Specified by:

createElementNS in interface Document

Throws:

DOMException

createEntityReference

public EntityReference createEntityReference(String arg0)
                                      throws DOMException

Unsupported.

Specified by:

createEntityReference in interface Document

Throws:

DOMException

createProcessingInstruction

public ProcessingInstruction createProcessingInstruction(String arg0,
                                                         String arg1)
                                                  throws DOMException

Unsupported.

Specified by:

createProcessingInstruction in interface Document

Throws:

DOMException

createTextNode

public Text createTextNode(String arg0)

Unsupported.

Specified by:

createTextNode in interface Document

getDoctype

public DocumentType getDoctype()

Returns a dummy DocumentTypeImpl object that contains nothing. It is not expected to do anything with the returned object.

Specified by:

getDoctype in interface Document

getDocumentElement

public Element getDocumentElement()

Specified by:

getDocumentElement in interface Document

isDefaultNamespace

public boolean isDefaultNamespace(String namespaceURI)

Description copied from class: NodeImpl

Not supported for namespace declaration. Overrided by DocumentImpl and ElementImpl

Specified by:

isDefaultNamespace in interface Node

Overrides:

isDefaultNamespace in class NodeImpl

getDocumentURI

public String getDocumentURI()

Specified by:

getDocumentURI in interface Document

getDomConfig

public DOMConfiguration getDomConfig()

Unsupported.

Specified by:

getDomConfig in interface Document

getElementById

public Element getElementById(String arg0)

Unsupported.

Specified by:

getElementById in interface Document

getElementsByTagNameNS

public NodeList getElementsByTagNameNS(String namespaceURI,
                                       String name)

Specified by:

getElementsByTagNameNS in interface Document

getElementsByTagName

public NodeList getElementsByTagName(String localName)

Specified by:

getElementsByTagName in interface Document

getImplementation

public DOMImplementation getImplementation()

Unsupported.

Specified by:

getImplementation in interface Document

getInputEncoding

public String getInputEncoding()

Unsupported.

Specified by:

getInputEncoding in interface Document

getStrictErrorChecking

public boolean getStrictErrorChecking()

Unsupported.

Specified by:

getStrictErrorChecking in interface Document

getXmlEncoding

public String getXmlEncoding()

Unsupported.

Specified by:

getXmlEncoding in interface Document

getXmlStandalone

public boolean getXmlStandalone()

Unsupported.

Specified by:

getXmlStandalone in interface Document

getXmlVersion

public String getXmlVersion()

Specified by:

getXmlVersion in interface Document

importNode

public Node importNode(Node arg0,
                       boolean arg1)
                throws DOMException

Unsupported.

Specified by:

importNode in interface Document

Throws:

DOMException

lookupNamespaceURI

public String lookupNamespaceURI(String prefix)

Description copied from class: NodeImpl

Specified by:

lookupNamespaceURI in interface Node

Overrides:

lookupNamespaceURI in class NodeImpl

lookupPrefix

public String lookupPrefix(String namespaceURI)

Description copied from class: NodeImpl

Specified by:

lookupPrefix in interface Node

Overrides:

lookupPrefix in class NodeImpl

normalizeDocument

public void normalizeDocument()

Unsupported.

Specified by:

normalizeDocument in interface Document

renameNode

public Node renameNode(Node arg0,
                       String arg1,
                       String arg2)
                throws DOMException

Unsupported.

Specified by:

renameNode in interface Document

Throws:

DOMException

setDocumentURI

public void setDocumentURI(String arg0)

Unsupported.

Specified by:

setDocumentURI in interface Document

setStrictErrorChecking

public void setStrictErrorChecking(boolean arg0)

Unsupported.

Specified by:

setStrictErrorChecking in interface Document

setXmlStandalone

public void setXmlStandalone(boolean arg0)
                      throws DOMException

Unsupported.

Specified by:

setXmlStandalone in interface Document

Throws:

DOMException

setXmlVersion

public void setXmlVersion(String arg0)
                   throws DOMException

Unsupported.

Specified by:

setXmlVersion in interface Document

Throws:

DOMException