org.exist.dom
Class DocumentImpl

java.lang.Object
  org.exist.dom.NodeImpl
      org.exist.dom.DocumentImpl

All Implemented Interfaces:

Comparable, QNameable, Document, Node

Direct Known Subclasses:

BinaryDocument

public class DocumentImpl
extends NodeImpl
implements Document, Comparable

Represents a persistent document object in the database; it can be an XML_FILE , a BINARY_FILE, or Xquery source code.

Author:

Wolfgang Meier

Field Summary

static byte	BINARY_FILE
static int	LENGTH_DOCUMENT_ID
static int	LENGTH_DOCUMENT_TYPE
static int	UNKNOWN_DOCUMENT_ID
static byte	XML_FILE

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

DocumentImpl(DBBroker broker)
Creates a new DocumentImpl instance.

DocumentImpl(DBBroker broker, Collection collection)
Creates a new DocumentImpl instance.

DocumentImpl(DBBroker broker, Collection collection, XmldbURI fileURI)
Creates a new DocumentImpl instance.

DocumentImpl(DBBroker broker, XmldbURI fileURI)
Creates a new DocumentImpl instance.

Method Summary

Node	adoptNode(Node node) The method adoptNode
void	appendChild(StoredNode child) The method appendChild
short	compareDocumentPosition(Node other) ? @see org.w3c.dom.Node#compareDocumentPosition(org.w3c.dom.Node)
int	compareTo(Object other) The method compareTo
void	copyChildren(DocumentImpl other) The method copyChildren
void	copyOf(DocumentImpl other) Copy the relevant internal fields from the specified document object.
Attr	createAttribute(String name) The method createAttribute
Attr	createAttributeNS(String namespaceURI, String qualifiedName) The method createAttributeNS
CDATASection	createCDATASection(String data) The method createCDATASection
Comment	createComment(String data) The method createComment
DocumentFragment	createDocumentFragment() The method createDocumentFragment
Element	createElement(String tagName) The method createElement
Element	createElementNS(String namespaceURI, String qualifiedName) The method createElementNS
EntityReference	createEntityReference(String name) The method createEntityReference
ProcessingInstruction	createProcessingInstruction(String target, String data) The method createProcessingInstruction
Text	createTextNode(String data) The method createTextNode
String	getBaseURI() ? @see org.w3c.dom.Node#getBaseURI()
DBBroker	getBroker() The method getBroker
int	getChildCount() The method getChildCount
NodeList	getChildNodes() The method getChildNodes
Collection	getCollection() The method getCollection
int	getContentLength() Returns the estimated size of the data in this document.
int	getDocId() The method getDocId
DocumentType	getDoctype() The method getDoctype
Element	getDocumentElement() The method getDocumentElement
String	getDocumentURI() ? @see org.w3c.dom.Document#getDocumentURI()
DOMConfiguration	getDomConfig() ? @see org.w3c.dom.Document#getDomConfig()
Element	getElementById(String elementId) The method getElementById
NodeList	getElementsByTagName(String tagname) The method getElementsByTagName
NodeList	getElementsByTagNameNS(String namespaceURI, String localName) The method getElementsByTagNameNS
String	getEncoding() The method getEncoding
Object	getFeature(String feature, String version) ? @see org.w3c.dom.Node#getFeature(java.lang.String, java.lang.String)
XmldbURI	getFileURI() The method getFileURI
Node	getFirstChild()
long	getFirstChildAddress() The method getFirstChildAddress
DOMImplementation	getImplementation() The method getImplementation
String	getInputEncoding() ? @see org.w3c.dom.Document#getInputEncoding()
String	getLocalName() The method getLocalName
DocumentMetadata	getMetadata() The method getMetadata
String	getNamespaceURI() The method getNamespaceURI
Node	getNextSibling() The method getNextSibling
Node	getNode(NodeId nodeId) The method getNode
Node	getNode(NodeProxy p) The method getNode
short	getNodeType() The method getNodeType
Document	getOwnerDocument() The method getOwnerDocument
Node	getParentNode()
Permission	getPermissions() The method getPermissions
Node	getPreviousSibling() The method getPreviousSibling
QName	getQName() The method getQName
byte	getResourceType() Returns the type of this resource, either XML_FILE or BINARY_FILE.
boolean	getStandalone() The method getStandalone
boolean	getStrictErrorChecking() The method getStrictErrorChecking
SymbolTable	getSymbols() The method getSymbols
String	getTextContent() ? @see org.w3c.dom.Node#getTextContent()
Lock	getUpdateLock() Returns the update lock associated with this resource.
XmldbURI	getURI() The method getURI
Object	getUserData(String key) ? @see org.w3c.dom.Node#getUserData(java.lang.String)
User	getUserLock() The method getUserLock
String	getVersion() The method getVersion
String	getXmlEncoding() ? @see org.w3c.dom.Document#getXmlEncoding()
boolean	getXmlStandalone() ? @see org.w3c.dom.Document#getXmlStandalone()
String	getXmlVersion() ? @see org.w3c.dom.Document#getXmlVersion()
Node	importNode(Node importedNode, boolean deep) The method importNode
void	insertAfter(NodeList nodes, Node refChild)
void	insertBefore(NodeList nodes, Node refChild)
boolean	isDefaultNamespace(String namespaceURI) ? @see org.w3c.dom.Node#isDefaultNamespace(java.lang.String)
boolean	isEqualNode(Node arg) ? @see org.w3c.dom.Node#isEqualNode(org.w3c.dom.Node)
boolean	isLockedForWrite() Returns true if the document is currently locked for write.
boolean	isSameNode(Node other) ? @see org.w3c.dom.Node#isSameNode(org.w3c.dom.Node)
boolean	isSupported(String type, String value) The method isSupported
String	lookupNamespaceURI(String prefix) ? @see org.w3c.dom.Node#lookupNamespaceURI(java.lang.String)
String	lookupPrefix(String namespaceURI) ? @see org.w3c.dom.Node#lookupPrefix(java.lang.String)
void	normalizeDocument() ? @see org.w3c.dom.Document#normalizeDocument()
void	read(VariableByteInput istream) The method read
void	readDocumentMeta(VariableByteInput istream) The method readDocumentMeta
Node	renameNode(Node n, String namespaceURI, String qualifiedName) ? @see org.w3c.dom.Document#renameNode(org.w3c.dom.Node, java.lang.String, java.lang.String)
void	setBroker(DBBroker broker) The method setBroker
void	setChildCount(int count) The method setChildCount
void	setCollection(Collection parent) The method setCollection
void	setDocId(int docId) The method setDocId
void	setDocumentType(DocumentType docType) The method setDocumentType
void	setDocumentURI(String documentURI) ? @see org.w3c.dom.Document#setDocumentURI(java.lang.String)
void	setEncoding(String enc) The method setEncoding
void	setFileURI(XmldbURI fileURI) The method setFileURI
void	setMetadata(DocumentMetadata meta) The method setMetadata
void	setOwnerDocument(Document doc) The method setOwnerDocument
void	setPermissions(int mode) The method setPermissions
void	setPermissions(Permission perm) The method setPermissions
void	setPermissions(String mode) The method setPermissions
void	setStandalone(boolean alone) The method setStandalone
void	setStrictErrorChecking(boolean strict) The method setStrictErrorChecking
void	setTextContent(String textContent) ? @see org.w3c.dom.Node#setTextContent(java.lang.String)
Object	setUserData(String key, Object data, UserDataHandler handler) ? @see org.w3c.dom.Node#setUserData(java.lang.String, java.lang.Object, org.w3c.dom.UserDataHandler)
void	setUserLock(User user) The method setUserLock
void	setVersion(String version) The method setVersion
void	setXmlStandalone(boolean xmlStandalone) ? @see org.w3c.dom.Document#setXmlStandalone(boolean)
void	setXmlVersion(String xmlVersion) ? @see org.w3c.dom.Document#setXmlVersion(java.lang.String)
String	toString() The method toString
void	triggerDefrag() The method triggerDefrag
StoredNode	updateChild(Txn transaction, Node oldChild, Node newChild) Update a child node.
void	write(VariableByteOutputStream ostream) The method write

Methods inherited from class org.exist.dom.NodeImpl

appendChild, appendChildren, cloneNode, getAttributes, getAttributesCount, getLastChild, getNodeName, getNodeValue, getPrefix, hasAttributes, hasChildNodes, insertAfter, insertAfter, insertBefore, insertBefore, normalize, removeChild, removeChild, replaceChild, replaceChild, setAttributes, setNodeName, setNodeValue, setPrefix, supports, updateChild

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.w3c.dom.Node

appendChild, cloneNode, getAttributes, getLastChild, getNodeName, getNodeValue, getPrefix, hasAttributes, hasChildNodes, insertBefore, normalize, removeChild, replaceChild, setNodeValue, setPrefix

Field Detail

UNKNOWN_DOCUMENT_ID

public static final int UNKNOWN_DOCUMENT_ID

See Also:

Constant Field Values

XML_FILE

public static final byte XML_FILE

See Also:

Constant Field Values

BINARY_FILE

public static final byte BINARY_FILE

See Also:

Constant Field Values

LENGTH_DOCUMENT_ID

public static int LENGTH_DOCUMENT_ID

LENGTH_DOCUMENT_TYPE

public static int LENGTH_DOCUMENT_TYPE

Constructor Detail

DocumentImpl

public DocumentImpl(DBBroker broker)

Creates a new DocumentImpl instance.

Parameters:

broker - a DBBroker value

DocumentImpl

public DocumentImpl(DBBroker broker,
                    Collection collection)

Creates a new DocumentImpl instance.

Parameters:

broker - a DBBroker value

collection - a Collection value

DocumentImpl

public DocumentImpl(DBBroker broker,
                    XmldbURI fileURI)

Creates a new DocumentImpl instance.

Parameters:

broker - a DBBroker value

fileURI - a XmldbURI value

DocumentImpl

public DocumentImpl(DBBroker broker,
                    Collection collection,
                    XmldbURI fileURI)

Creates a new DocumentImpl instance.

Parameters:

broker - a DBBroker value

collection - a Collection value

fileURI - a XmldbURI value

Method Detail

getLocalName

public String getLocalName()

The method getLocalName

Specified by:

getLocalName in interface Node

Overrides:

getLocalName in class NodeImpl

Returns:

a String value

See Also:

Node.getLocalName()

getNamespaceURI

public String getNamespaceURI()

The method getNamespaceURI

Specified by:

getNamespaceURI in interface Node

Overrides:

getNamespaceURI in class NodeImpl

Returns:

a String value

See Also:

Node.getNamespaceURI()

getCollection

public Collection getCollection()

The method getCollection

Returns:

a Collection value

setCollection

public void setCollection(Collection parent)

The method setCollection

Parameters:

parent - a Collection value

getDocId

public int getDocId()

The method getDocId

Returns:

an int value

setDocId

public void setDocId(int docId)

The method setDocId

Parameters:

docId - an int value

getResourceType

public byte getResourceType()

Returns the type of this resource, either XML_FILE or BINARY_FILE.

getFileURI

public XmldbURI getFileURI()

The method getFileURI

Returns:

a XmldbURI value

setFileURI

public void setFileURI(XmldbURI fileURI)

The method setFileURI

Parameters:

fileURI - a XmldbURI value

getURI

public XmldbURI getURI()

The method getURI

Returns:

a XmldbURI value

getPermissions

public Permission getPermissions()

The method getPermissions

Returns:

a Permission value

setPermissions

public void setPermissions(int mode)

The method setPermissions

Parameters:

mode - an int value

setPermissions

public void setPermissions(String mode)
                    throws SyntaxException

The method setPermissions

Parameters:

mode - a String value

Throws:

SyntaxException - if an error occurs

setPermissions

public void setPermissions(Permission perm)

The method setPermissions

Parameters:

perm - a Permission value

setMetadata

public void setMetadata(DocumentMetadata meta)

The method setMetadata

Parameters:

meta - a DocumentMetadata value

getMetadata

public DocumentMetadata getMetadata()

The method getMetadata

Returns:

a DocumentMetadata value

copyOf

public void copyOf(DocumentImpl other)

Copy the relevant internal fields from the specified document object. This is called by Collection when replacing a document.

Parameters:

other - a DocumentImpl value

copyChildren

public void copyChildren(DocumentImpl other)

The method copyChildren

Parameters:

other - a DocumentImpl value

isLockedForWrite

public boolean isLockedForWrite()

Returns true if the document is currently locked for write.

getUpdateLock

public final Lock getUpdateLock()

Returns the update lock associated with this resource.

setUserLock

public void setUserLock(User user)

The method setUserLock

Parameters:

user - an User value

getUserLock

public User getUserLock()

The method getUserLock

Returns:

an User value

getContentLength

public int getContentLength()

Returns the estimated size of the data in this document. As an estimation, the number of pages occupied by the document is multiplied with the current page size.

triggerDefrag

public void triggerDefrag()

The method triggerDefrag

getSymbols

public SymbolTable getSymbols()

The method getSymbols

Returns:

a SymbolTable value

getNode

public Node getNode(NodeId nodeId)

The method getNode

Parameters:

nodeId - a NodeId value

Returns:

a Node value

getNode

public Node getNode(NodeProxy p)

The method getNode

Parameters:

p - a NodeProxy value

Returns:

a Node value

appendChild

public void appendChild(StoredNode child)
                 throws DOMException

The method appendChild

Parameters:

child - a StoredNode value

Throws:

DOMException - if an error occurs

write

public void write(VariableByteOutputStream ostream)
           throws IOException

The method write

Parameters:

ostream - a VariableByteOutputStream value

Throws:

IOException - if an error occurs

read

public void read(VariableByteInput istream)
          throws IOException,
                 EOFException

The method read

Parameters:

istream - a VariableByteInput value

Throws:

IOException - if an error occurs

EOFException - if an error occurs

readDocumentMeta

public void readDocumentMeta(VariableByteInput istream)

The method readDocumentMeta

Parameters:

istream - a VariableByteInput value

compareTo

public final int compareTo(Object other)

The method compareTo

Specified by:

compareTo in interface Comparable

Parameters:

other - an Object value

Returns:

an int value

getBroker

public DBBroker getBroker()

The method getBroker

Returns:

a DBBroker value

setBroker

public void setBroker(DBBroker broker)

The method setBroker

Parameters:

broker - a DBBroker value

updateChild

public StoredNode updateChild(Txn transaction,
                              Node oldChild,
                              Node newChild)
                       throws DOMException

Description copied from class: NodeImpl

Update a child node. This method will only update the child node but not its potential descendant nodes.

Overrides:

updateChild in class NodeImpl

Throws:

DOMException

insertBefore

public void insertBefore(NodeList nodes,
                         Node refChild)
                  throws DOMException

Throws:

DOMException

insertAfter

public void insertAfter(NodeList nodes,
                        Node refChild)
                 throws DOMException

Throws:

DOMException

getFirstChild

public Node getFirstChild()

Specified by:

getFirstChild in interface Node

Overrides:

getFirstChild in class NodeImpl

See Also:

Node.getFirstChild()

getFirstChildAddress

public long getFirstChildAddress()

The method getFirstChildAddress

Returns:

a long value

getChildNodes

public NodeList getChildNodes()

The method getChildNodes

Specified by:

getChildNodes in interface Node

Overrides:

getChildNodes in class NodeImpl

Returns:

a NodeList value

getDoctype

public DocumentType getDoctype()

The method getDoctype

Specified by:

getDoctype in interface Document

Returns:

a DocumentType value

setDocumentType

public void setDocumentType(DocumentType docType)

The method setDocumentType

Parameters:

docType - a DocumentType value

getOwnerDocument

public Document getOwnerDocument()

The method getOwnerDocument

Specified by:

getOwnerDocument in interface Node

Returns:

a Document value

setOwnerDocument

public void setOwnerDocument(Document doc)

The method setOwnerDocument

Parameters:

doc - a Document value

getQName

public QName getQName()

The method getQName

Specified by:

getQName in interface QNameable

Returns:

a QName value

getNodeType

public short getNodeType()

The method getNodeType

Specified by:

getNodeType in interface Node

Returns:

a short value

getPreviousSibling

public Node getPreviousSibling()

The method getPreviousSibling

Specified by:

getPreviousSibling in interface Node

Returns:

a Node value

getNextSibling

public Node getNextSibling()

The method getNextSibling

Specified by:

getNextSibling in interface Node

Returns:

a Node value

createAttribute

public Attr createAttribute(String name)
                     throws DOMException

The method createAttribute

Specified by:

createAttribute in interface Document

Parameters:

name - a String value

Returns:

an Attr value

Throws:

DOMException - if an error occurs

createAttributeNS

public Attr createAttributeNS(String namespaceURI,
                              String qualifiedName)
                       throws DOMException

The method createAttributeNS

Specified by:

createAttributeNS in interface Document

Parameters:

namespaceURI - a String value

qualifiedName - a String value

Returns:

an Attr value

Throws:

DOMException - if an error occurs

createElement

public Element createElement(String tagName)
                      throws DOMException

The method createElement

Specified by:

createElement in interface Document

Parameters:

tagName - a String value

Returns:

an Element value

Throws:

DOMException - if an error occurs

createElementNS

public Element createElementNS(String namespaceURI,
                               String qualifiedName)
                        throws DOMException

The method createElementNS

Specified by:

createElementNS in interface Document

Parameters:

namespaceURI - a String value

qualifiedName - a String value

Returns:

an Element value

Throws:

DOMException - if an error occurs

createTextNode

public Text createTextNode(String data)

The method createTextNode

Specified by:

createTextNode in interface Document

Parameters:

data - a String value

Returns:

a Text value

getDocumentElement

public Element getDocumentElement()

The method getDocumentElement

Specified by:

getDocumentElement in interface Document

Returns:

an Element value

getElementsByTagName

public NodeList getElementsByTagName(String tagname)

The method getElementsByTagName

Specified by:

getElementsByTagName in interface Document

Parameters:

tagname - a String value

Returns:

a NodeList value

getElementsByTagNameNS

public NodeList getElementsByTagNameNS(String namespaceURI,
                                       String localName)

The method getElementsByTagNameNS

Specified by:

getElementsByTagNameNS in interface Document

Parameters:

namespaceURI - a String value

localName - a String value

Returns:

a NodeList value

getParentNode

public Node getParentNode()

Specified by:

getParentNode in interface Node

getChildCount

public int getChildCount()

The method getChildCount

Overrides:

getChildCount in class NodeImpl

Returns:

an int value

setChildCount

public void setChildCount(int count)

The method setChildCount

Parameters:

count - an int value

getEncoding

public String getEncoding()

The method getEncoding

Returns:

a String value

setEncoding

public void setEncoding(String enc)

The method setEncoding

Parameters:

enc - a String value

getVersion

public String getVersion()

The method getVersion

Returns:

a String value

setVersion

public void setVersion(String version)

The method setVersion

Parameters:

version - a String value

getStandalone

public boolean getStandalone()

The method getStandalone

Returns:

a boolean value

setStandalone

public void setStandalone(boolean alone)

The method setStandalone

Parameters:

alone - a boolean value

createCDATASection

public CDATASection createCDATASection(String data)
                                throws DOMException

The method createCDATASection

Specified by:

createCDATASection in interface Document

Parameters:

data - a String value

Returns:

a CDATASection value

Throws:

DOMException - if an error occurs

createComment

public Comment createComment(String data)

The method createComment

Specified by:

createComment in interface Document

Parameters:

data - a String value

Returns:

a Comment value

createDocumentFragment

public DocumentFragment createDocumentFragment()
                                        throws DOMException

The method createDocumentFragment

Specified by:

createDocumentFragment in interface Document