org.exist.dom
Class BinaryDocument

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

All Implemented Interfaces:

java.lang.Comparable, org.w3c.dom.Document, org.w3c.dom.Node, QNameable

public class BinaryDocument

extends DocumentImpl

Represents a binary resource. Binary resources are just stored as binary data in a single overflow page. However, class BinaryDocument extends DocumentImpl and thus provides the same interface.

Author:

wolf

Field Summary

Fields inherited from class org.exist.dom.DocumentImpl

BINARY_FILE, permissions, UNKNOWN_DOCUMENT_ID, XML_FILE

Fields inherited from class org.exist.dom.NodeImpl

LOG

Fields inherited from interface org.w3c.dom.Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Constructor Summary

BinaryDocument(DBBroker broker)

BinaryDocument(DBBroker broker, Collection collection)

BinaryDocument(DBBroker broker, java.lang.String fileName)

BinaryDocument(DBBroker broker, java.lang.String docName, Collection collection)

Method Summary

long	getPage()
byte	getResourceType() Returns the type of this resource, either DocumentImpl.XML_FILE or DocumentImpl.BINARY_FILE.
void	read(VariableByteInput istream)
void	setPage(long page)
void	write(VariableByteOutputStream ostream)

Methods inherited from class org.exist.dom.DocumentImpl

adoptNode, appendChild, calculateTreeLevelStartPoints, calculateTreeLevelStartPoints, compareDocumentPosition, compareTo, copyChildren, copyOf, createAttribute, createAttributeNS, createCDATASection, createComment, createDocumentFragment, createElement, createElementNS, createEntityReference, createNode, createProcessingInstruction, createTextNode, findElementsByTagName, getBaseURI, getBroker, getChildCount, getChildNodes, getCollection, getContentLength, getDocId, getDoctype, getDocumentElement, getDocumentURI, getDomConfig, getElementById, getElementsByTagName, getElementsByTagNameNS, getEncoding, getFeature, getFileName, getFirstChild, getFirstChildAddress, getFollowingSibling, getImplementation, getInputEncoding, getLevelStartPoint, getMaxDepth, getMetadata, getMetadataLocation, getName, getNextSibling, getNode, getNode, getNodeType, getOwnerDocument, getParentNode, getPermissions, getPreviousSibling, getPreviousSibling, getQName, getRange, getStandalone, getStrictErrorChecking, getSymbols, getTextContent, getTreeLevel, getTreeLevelOrder, getTreeLevelOrder, getUpdateLock, getUserData, getUserLock, getVersion, getXmlEncoding, getXmlStandalone, getXmlVersion, importNode, incMaxDepth, insertAfter, insertBefore, isDefaultNamespace, isEqualNode, isLockedForWrite, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalizeDocument, printTreeLevelOrder, renameNode, setBroker, setChildCount, setCollection, setDocId, setDocumentType, setDocumentURI, setEncoding, setFileName, setMaxDepth, setMetadata, setMetadataLocation, setOwnerDocument, setPermissions, setPermissions, setPermissions, setStandalone, setStrictErrorChecking, setTextContent, setTreeLevelOrder, setUserData, setUserLock, setVersion, setXmlStandalone, setXmlVersion, toString, triggerDefrag, updateChild

Methods inherited from class org.exist.dom.NodeImpl

appendChild, appendChildren, cloneNode, getAttributes, getAttributesCount, getLastChild, getLocalName, getNamespaceURI, 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

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

Methods inherited from interface org.w3c.dom.Node

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

Constructor Detail

BinaryDocument

public BinaryDocument(DBBroker broker)

BinaryDocument

public BinaryDocument(DBBroker broker,
                      Collection collection)

BinaryDocument

public BinaryDocument(DBBroker broker,
                      java.lang.String fileName)

BinaryDocument

public BinaryDocument(DBBroker broker,
                      java.lang.String docName,
                      Collection collection)

Method Detail

getResourceType

public byte getResourceType()

Description copied from class: DocumentImpl

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

Overrides:

getResourceType in class DocumentImpl

Returns:

setPage

public void setPage(long page)

getPage

public long getPage()

write

public void write(VariableByteOutputStream ostream)
           throws java.io.IOException

Overrides:

write in class DocumentImpl

Throws:

java.io.IOException

read

public void read(VariableByteInput istream)
          throws java.io.IOException,
                 java.io.EOFException

Overrides:

read in class DocumentImpl

Throws:

java.io.IOException

java.io.EOFException