org.exist.storage
Class DBBroker

java.lang.Object
  java.util.Observable
      org.exist.storage.DBBroker

Direct Known Subclasses:

NativeBroker

public abstract class DBBroker
extends java.util.Observable

This is the base class for all database backends. All the basic database operations like storing, removing or index access are provided by subclasses of this class.

Field Summary

protected boolean	caseSensitive
protected Configuration	config
static java.lang.String	CONFIGURATION_ELEMENT_NAME
protected java.util.List<ContentLoadingObserver>	contentLoadingObservers Observer Design Pattern: List of ContentLoadingObserver objects
protected java.lang.String	id
protected IndexController	indexController
protected static org.apache.log4j.Logger	LOG
static int	MATCH_CONTAINS
static int	MATCH_ENDSWITH
static int	MATCH_EXACT
static int	MATCH_REGEXP
static int	MATCH_STARTSWITH
static int	MATCH_WILDCARDS
protected BrokerPool	pool
static java.lang.String	PROPERTY_XUPDATE_CONSISTENCY_CHECKS
static java.lang.String	PROPERTY_XUPDATE_FRAGMENTATION_FACTOR
static java.lang.String	ROOT_COLLECTION Deprecated.
static java.lang.String	ROOT_COLLECTION_NAME Deprecated.
static java.lang.String	SYSTEM_COLLECTION Deprecated.
static java.lang.String	SYSTEM_COLLECTION_NAME Deprecated.
static java.lang.String	TEMP_COLLECTION Deprecated.
static java.lang.String	TEMP_COLLECTION_NAME Deprecated.
protected XQuery	xqueryService
static java.lang.String	XUPDATE_CONSISTENCY_CHECKS_ATTRIBUTE
static java.lang.String	XUPDATE_FRAGMENTATION_FACTOR_ATTRIBUTE

Constructor Summary

DBBroker()

DBBroker(BrokerPool pool, Configuration config)

Method Summary

void	addContentLoadingObserver(ContentLoadingObserver observer) Observer Design Pattern: add an observer.
abstract void	backupToArchive(RawDataBackup backup)
abstract void	checkAvailableMemory() Convenience method that allows to check available memory during broker-related processes.
abstract void	checkXMLResourceConsistency(DocumentImpl doc)
abstract void	checkXMLResourceTree(DocumentImpl doc) Perform a consistency check on the specified document.
abstract void	cleanUpTempResources() Clean up temporary resources.
abstract void	cleanUpTempResources(boolean forceRemoval) Clean up temporary resources.
void	clearContentLoadingObservers() Remove all observers
void	closeDocument()
abstract void	copyCollection(Txn transaction, Collection collection, Collection destination, XmldbURI newName) Copy a collection to the destination collection and rename it.
abstract void	copyResource(Txn transaction, DocumentImpl doc, Collection destination, XmldbURI newName) Copy a resource to the destination collection and rename it.
void	decReferenceCount()
abstract void	defragXMLResource(Txn transaction, DocumentImpl doc) Defragment pages of this document.
void	endElement(StoredNode node, NodePath currentPath, java.lang.String content)
abstract void	endElement(StoredNode node, NodePath currentPath, java.lang.String content, boolean remove)
abstract void	endRemove(Txn transaction)
abstract java.util.List<java.lang.String>	findCollectionsMatching(java.lang.String regexp)
void	flush() Flush all data that has not been written before.
abstract MutableDocumentSet	getAllXMLResources(MutableDocumentSet docs) Adds all the documents in the database to the specified DocumentSet.
abstract java.io.InputStream	getBinaryResource(BinaryDocument blob)
abstract long	getBinaryResourceSize(BinaryDocument blob)
BrokerPool	getBrokerPool()
abstract Collection	getCollection(XmldbURI uri) Returns the database collection identified by the specified path.
abstract void	getCollectionResources(Collection collection)
abstract void	getCollectionsFailsafe(BTreeCallback callback)
Configuration	getConfiguration() Returns the configuration object used to initialize the current database instance.
abstract ElementIndex	getElementIndex()
java.lang.String	getId()
abstract IndexSpec	getIndexConfiguration()
IndexController	getIndexController()
abstract int	getNextResourceId(Txn transaction, Collection collection) Get a new document id that does not yet exist within the collection.
java.util.Iterator<StoredNode>	getNodeIterator(StoredNode node) Return a NodeIterator starting at the specified node.
java.lang.String	getNodeValue(StoredNode node, boolean addWhitespace) Get the string value of the specified node.
abstract Collection	getOrCreateCollection(Txn transaction, XmldbURI uri) Returns the database collection identified by the specified path.
int	getReferenceCount()
abstract DocumentImpl	getResource(XmldbURI docURI, int accessType) Return the document stored at the specified path.
abstract void	getResourceMetadata(DocumentImpl doc)
abstract void	getResourcesFailsafe(BTreeCallback callback, boolean fullScan)
abstract Serializer	getSerializer() Get an instance of the Serializer used for converting nodes back to XML.
abstract StructuralIndex	getStructuralIndex()
Subject	getSubject() The subject that is currently using this DBBroker object
abstract TextSearchEngine	getTextEngine() Get the TextSearchEngine associated with this broker.
Subject	getUser() Deprecated. user getSubject
abstract NativeValueIndex	getValueIndex()
abstract org.w3c.dom.Document	getXMLResource(XmldbURI docURI) Return the document stored at the specified path.
abstract DocumentImpl	getXMLResource(XmldbURI docURI, int lockMode) Return the document stored at the specified path.
abstract MutableDocumentSet	getXMLResourcesByDoctype(java.lang.String doctype, MutableDocumentSet result)
abstract EmbeddedXMLStreamReader	getXMLStreamReader(NodeHandle node, boolean reportAttributes)
XQuery	getXQueryService()
void	incReferenceCount()
void	indexNode(Txn transaction, StoredNode node)
abstract void	indexNode(Txn transaction, StoredNode node, NodePath currentPath)
void	initIndexModules()
abstract void	insertNodeAfter(Txn transaction, StoredNode previous, StoredNode node)
boolean	isReadOnly() Is the database running read-only? Returns false by default.
abstract void	moveCollection(Txn transaction, Collection collection, Collection destination, XmldbURI newName) Move a collection and all its subcollections to another collection and rename it.
abstract void	moveResource(Txn transaction, DocumentImpl doc, Collection destination, XmldbURI newName) Move a resource to the destination collection and rename it.
abstract Serializer	newSerializer()
abstract EmbeddedXMLStreamReader	newXMLStreamReader(NodeHandle node, boolean reportAttributes)
abstract StoredNode	objectWith(org.w3c.dom.Document doc, NodeId nodeId) Get a node with given owner document and id from the database.
abstract StoredNode	objectWith(NodeProxy p)
abstract Collection	openCollection(XmldbURI uri, int lockMode) Open a collection for reading or writing.
abstract void	readBinaryResource(BinaryDocument blob, java.io.OutputStream os)
abstract void	reindexCollection(XmldbURI collectionName) Reindex a collection.
abstract void	removeAllNodes(Txn transaction, StoredNode node, NodePath currentPath, StreamListener listener)
abstract void	removeBinaryResource(Txn transaction, BinaryDocument blob) Completely delete this binary document (descriptor and binary data).
abstract boolean	removeCollection(Txn transaction, Collection collection) Remove the collection and all its subcollections from the database.
void	removeContentLoadingObserver(ContentLoadingObserver observer) Observer Design Pattern: remove an observer.
abstract void	removeNode(Txn transaction, StoredNode node, NodePath currentPath, java.lang.String content)
void	removeXMLResource(Txn transaction, DocumentImpl document) Remove a document from the database.
abstract void	removeXMLResource(Txn transaction, DocumentImpl document, boolean freeDocId)
abstract void	repair()
abstract void	saveCollection(Txn transaction, Collection collection) Saves the specified collection to storage.
void	setId(java.lang.String id)
void	setSubject(Subject subject) Set the subject that is currently using this DBBroker object.
void	setUser(Subject user) Deprecated. use setSubject
void	shutdown() Shut down the database instance.
abstract void	storeBinaryResource(Txn transaction, BinaryDocument blob, byte[] data) Stores the given data under the given binary resource descriptor (BinaryDocument).
abstract void	storeBinaryResource(Txn transaction, BinaryDocument blob, java.io.InputStream is) Stores the given data under the given binary resource descriptor (BinaryDocument).
void	storeNode(Txn transaction, StoredNode node, NodePath currentPath, IndexSpec indexSpec)
abstract void	storeNode(Txn transaction, StoredNode node, NodePath currentPath, IndexSpec indexSpec, boolean index) Store a node into the database.
abstract DocumentImpl	storeTempResource(DocumentImpl doc) Create a temporary document in the temp collection and store the supplied data.
abstract void	storeXMLResource(Txn transaction, DocumentImpl doc) Store a document (descriptor) into the database.
abstract void	sync(int syncEvent) Sync dom and collection state data (pages) to disk.
java.lang.String	toString()
abstract void	updateNode(Txn transaction, StoredNode node, boolean reindex) Update a node's data.

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object

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

Field Detail

MATCH_EXACT

public static final int MATCH_EXACT

See Also:

Constant Field Values

MATCH_REGEXP

public static final int MATCH_REGEXP

See Also:

Constant Field Values

MATCH_WILDCARDS

public static final int MATCH_WILDCARDS

See Also:

Constant Field Values

MATCH_CONTAINS

public static final int MATCH_CONTAINS

See Also:

Constant Field Values

MATCH_STARTSWITH

public static final int MATCH_STARTSWITH

See Also:

Constant Field Values

MATCH_ENDSWITH

public static final int MATCH_ENDSWITH

See Also:

Constant Field Values

ROOT_COLLECTION_NAME

@Deprecated
public static final java.lang.String ROOT_COLLECTION_NAME

Deprecated.

See Also:

Constant Field Values

ROOT_COLLECTION

@Deprecated
public static final java.lang.String ROOT_COLLECTION

Deprecated.

See Also:

Constant Field Values

SYSTEM_COLLECTION_NAME

@Deprecated
public static final java.lang.String SYSTEM_COLLECTION_NAME

Deprecated.

See Also:

Constant Field Values

SYSTEM_COLLECTION

@Deprecated
public static final java.lang.String SYSTEM_COLLECTION

Deprecated.

See Also:

Constant Field Values

TEMP_COLLECTION_NAME

@Deprecated
public static final java.lang.String TEMP_COLLECTION_NAME

Deprecated.

See Also:

Constant Field Values

TEMP_COLLECTION

@Deprecated
public static final java.lang.String TEMP_COLLECTION

Deprecated.

See Also:

Constant Field Values

CONFIGURATION_ELEMENT_NAME

public static final java.lang.String CONFIGURATION_ELEMENT_NAME

See Also:

Constant Field Values

XUPDATE_FRAGMENTATION_FACTOR_ATTRIBUTE

public static final java.lang.String XUPDATE_FRAGMENTATION_FACTOR_ATTRIBUTE

See Also:

Constant Field Values

PROPERTY_XUPDATE_FRAGMENTATION_FACTOR

public static final java.lang.String PROPERTY_XUPDATE_FRAGMENTATION_FACTOR

See Also:

Constant Field Values

XUPDATE_CONSISTENCY_CHECKS_ATTRIBUTE

public static final java.lang.String XUPDATE_CONSISTENCY_CHECKS_ATTRIBUTE

See Also:

Constant Field Values

PROPERTY_XUPDATE_CONSISTENCY_CHECKS

public static final java.lang.String PROPERTY_XUPDATE_CONSISTENCY_CHECKS

See Also:

Constant Field Values

LOG

protected static final org.apache.log4j.Logger LOG

caseSensitive

protected boolean caseSensitive

config

protected Configuration config

pool

protected BrokerPool pool

xqueryService

protected XQuery xqueryService

id

protected java.lang.String id

indexController

protected IndexController indexController

contentLoadingObservers

protected java.util.List<ContentLoadingObserver> contentLoadingObservers

Observer Design Pattern: List of ContentLoadingObserver objects

Constructor Detail

DBBroker

public DBBroker()

DBBroker

public DBBroker(BrokerPool pool,
                Configuration config)

Method Detail

initIndexModules

public void initIndexModules()

setUser

public void setUser(Subject user)

Deprecated. use setSubject

Set the user that is currently using this DBBroker object.

Parameters:

user -

getUser

@Deprecated
public Subject getUser()

Deprecated. user getSubject

Returns:

The user that is currently using this DBBroker object

setSubject

public void setSubject(Subject subject)

Set the subject that is currently using this DBBroker object.

Parameters:

subject -

getSubject

public Subject getSubject()

The subject that is currently using this DBBroker object

Returns:

Subject

getIndexController

public IndexController getIndexController()

getXQueryService

public XQuery getXQueryService()

Returns:

A reference to the global XQuery service.

getElementIndex

public abstract ElementIndex getElementIndex()

getStructuralIndex

public abstract StructuralIndex getStructuralIndex()

flush

public void flush()

Flush all data that has not been written before.

clearContentLoadingObservers

public void clearContentLoadingObservers()

Remove all observers

addContentLoadingObserver

public void addContentLoadingObserver(ContentLoadingObserver observer)

Observer Design Pattern: add an observer.

removeContentLoadingObserver

public void removeContentLoadingObserver(ContentLoadingObserver observer)

Observer Design Pattern: remove an observer.

getAllXMLResources

public abstract MutableDocumentSet getAllXMLResources(MutableDocumentSet docs)

Adds all the documents in the database to the specified DocumentSet.

Parameters:

docs - a (possibly empty) document set to which the found documents are added.

getResourcesFailsafe

public abstract void getResourcesFailsafe(BTreeCallback callback,
                                          boolean fullScan)
                                   throws TerminatedException

Throws:

TerminatedException

getCollectionsFailsafe

public abstract void getCollectionsFailsafe(BTreeCallback callback)
                                     throws TerminatedException

Throws:

TerminatedException

getCollection

public abstract Collection getCollection(XmldbURI uri)

Returns the database collection identified by the specified path. The path should be absolute, e.g. /db/shakespeare.

Returns:

collection or null if no collection matches the path

openCollection

public abstract Collection openCollection(XmldbURI uri,
                                          int lockMode)

Open a collection for reading or writing. The collection is identified by its absolute path, e.g. /db/shakespeare. It will be loaded and locked according to the lockMode argument. The caller should take care to release the collection lock properly.

Parameters:

uri - The collection path

lockMode - one of the modes specified in class Lock

Returns:

collection or null if no collection matches the path

findCollectionsMatching

public abstract java.util.List<java.lang.String> findCollectionsMatching(java.lang.String regexp)

getOrCreateCollection

public abstract Collection getOrCreateCollection(Txn transaction,
                                                 XmldbURI uri)
                                          throws PermissionDeniedException,
                                                 java.io.IOException,
                                                 TriggerException

Returns the database collection identified by the specified path. If the collection does not yet exist, it is created - including all ancestors. The path should be absolute, e.g. /db/shakespeare.

Parameters:

transaction - The transaction, which registers the acquired write locks. The locks should be released on commit/abort.

uri - The collection's URI

Returns:

The collection or null if no collection matches the path

Throws:

PermissionDeniedException

java.io.IOException

TriggerException

getConfiguration

public Configuration getConfiguration()

Returns the configuration object used to initialize the current database instance.

getNodeIterator

public java.util.Iterator<StoredNode> getNodeIterator(StoredNode node)

Return a NodeIterator starting at the specified node.

Parameters:

node -

Returns:

NodeIterator of node.

getXMLResource

public abstract org.w3c.dom.Document getXMLResource(XmldbURI docURI)
                                             throws PermissionDeniedException

Return the document stored at the specified path. The path should be absolute, e.g. /db/shakespeare/plays/hamlet.xml.

Returns:

the document or null if no document could be found at the specified location. deprecated Use XmldbURI instead! public abstract Document getXMLResource(String path) throws PermissionDeniedException;

Throws:

PermissionDeniedException

getResource

public abstract DocumentImpl getResource(XmldbURI docURI,
                                         int accessType)
                                  throws PermissionDeniedException

Return the document stored at the specified path. The path should be absolute, e.g. /db/shakespeare/plays/hamlet.xml.

Returns:

the document or null if no document could be found at the specified location.

Throws:

PermissionDeniedException

getXMLResource

public abstract DocumentImpl getXMLResource(XmldbURI docURI,
                                            int lockMode)
                                     throws PermissionDeniedException

Return the document stored at the specified path. The path should be absolute, e.g. /db/shakespeare/plays/hamlet.xml, with the specified lock.

Returns:

the document or null if no document could be found at the specified location.

Throws:

PermissionDeniedException

getNextResourceId

public abstract int getNextResourceId(Txn transaction,
                                      Collection collection)
                               throws EXistException

Get a new document id that does not yet exist within the collection.

Throws:

EXistException

getNodeValue

public java.lang.String getNodeValue(StoredNode node,
                                     boolean addWhitespace)

Get the string value of the specified node. If addWhitespace is set to true, an extra space character will be added between adjacent elements in mixed content nodes.

getSerializer

public abstract Serializer getSerializer()

Get an instance of the Serializer used for converting nodes back to XML. Subclasses of DBBroker may have specialized subclasses of Serializer to convert a node into an XML-string

getTextEngine

public abstract TextSearchEngine getTextEngine()

Get the TextSearchEngine associated with this broker. Every subclass of DBBroker will have it's own implementation of TextSearchEngine.

getValueIndex

public abstract NativeValueIndex getValueIndex()

newSerializer

public abstract Serializer newSerializer()

objectWith

public abstract StoredNode objectWith(org.w3c.dom.Document doc,
                                      NodeId nodeId)

Get a node with given owner document and id from the database.

Parameters:

doc - the document the node belongs to

nodeId - the node's unique identifier

objectWith

public abstract StoredNode objectWith(NodeProxy p)

removeCollection

public abstract boolean removeCollection(Txn transaction,
                                         Collection collection)
                                  throws PermissionDeniedException,
                                         java.io.IOException,
                                         TriggerException

Remove the collection and all its subcollections from the database.

Throws:

PermissionDeniedException

java.io.IOException

TriggerException

removeXMLResource

public void removeXMLResource(Txn transaction,
                              DocumentImpl document)
                       throws PermissionDeniedException

Remove a document from the database.

Throws:

PermissionDeniedException

removeXMLResource

public abstract void removeXMLResource(Txn transaction,
                                       DocumentImpl document,
                                       boolean freeDocId)
                                throws PermissionDeniedException

Throws:

PermissionDeniedException

reindexCollection

public abstract void reindexCollection(XmldbURI collectionName)
                                throws PermissionDeniedException

Reindex a collection.

Parameters:

collectionName -

Throws:

PermissionDeniedException - public abstract void reindexCollection(String collectionName) throws PermissionDeniedException;

repair

public abstract void repair()
                     throws PermissionDeniedException

Throws:

PermissionDeniedException

saveCollection

public abstract void saveCollection(Txn transaction,
                                    Collection collection)
                             throws PermissionDeniedException,
                                    java.io.IOException,
                                    TriggerException

Saves the specified collection to storage. Collections are usually cached in memory. If a collection is modified, this method needs to be called to make the changes persistent. Note: appending a new document to a collection does not require a save.

Parameters:

transaction -

collection - Collection to store

Throws:

PermissionDeniedException

java.io.IOException

TriggerException

closeDocument

public void closeDocument()

shutdown

public void shutdown()

Shut down the database instance. All open files, jdbc connections etc. should be closed.

storeNode

public abstract void storeNode(Txn transaction,
                               StoredNode node,
                               NodePath currentPath,
                               IndexSpec indexSpec,
                               boolean index)

Store a node into the database. This method is called by the parser to write a node to the storage backend.

Parameters:

node - the node to be stored

currentPath - path expression which points to this node's element-parent or to itself if it is an element (currently used by the Broker to determine if a node's content should be fulltext-indexed).

storeNode

public void storeNode(Txn transaction,
                      StoredNode node,
                      NodePath currentPath,
                      IndexSpec indexSpec)

endElement

public void endElement(StoredNode node,
                       NodePath currentPath,
                       java.lang.String content)

endElement

public abstract void endElement(StoredNode node,
                                NodePath currentPath,
                                java.lang.String content,
                                boolean remove)

storeXMLResource

public abstract void storeXMLResource(Txn transaction,
                                      DocumentImpl doc)

Store a document (descriptor) into the database.

Parameters:

doc - the document's metadata to store.

storeBinaryResource

public abstract void storeBinaryResource(Txn transaction,
                                         BinaryDocument blob,
                                         byte[] data)
                                  throws java.io.IOException

Stores the given data under the given binary resource descriptor (BinaryDocument).

Parameters:

blob - the binary document descriptor

data - the document binary data

Throws:

java.io.IOException

storeBinaryResource

public abstract void storeBinaryResource(Txn transaction,
                                         BinaryDocument blob,
                                         java.io.InputStream is)
                                  throws java.io.IOException

Stores the given data under the given binary resource descriptor (BinaryDocument).

Parameters:

blob - the binary document descriptor

is - the document binary data as input stream

Throws:

java.io.IOException

getCollectionResources

public abstract void getCollectionResources(Collection collection)

readBinaryResource

public abstract void readBinaryResource(BinaryDocument blob,
                                        java.io.OutputStream os)
                                 throws java.io.IOException

Throws:

java.io.IOException

getBinaryResource

public abstract java.io.InputStream getBinaryResource(BinaryDocument blob)
                                               throws java.io.IOException

Throws:

java.io.IOException

getBinaryResourceSize

public abstract long getBinaryResourceSize(BinaryDocument blob)
                                    throws java.io.IOException

Throws:

java.io.IOException

getResourceMetadata

public abstract void getResourceMetadata(DocumentImpl doc)

removeBinaryResource

public abstract void removeBinaryResource(Txn transaction,
                                          BinaryDocument blob)
                                   throws PermissionDeniedException,
                                          java.io.IOException

Completely delete this binary document (descriptor and binary data).

Parameters:

blob - the binary document descriptor

Throws:

PermissionDeniedException - if you don't have the right to do this

java.io.IOException

moveCollection

public abstract void moveCollection(Txn transaction,
                                    Collection collection,
                                    Collection destination,
                                    XmldbURI newName)
                             throws PermissionDeniedException,
                                    LockException,
                                    java.io.IOException,
                                    TriggerException

Move a collection and all its subcollections to another collection and rename it. Moving a collection just modifies the collection path and all resource paths. The data itself remains in place.

Parameters:

collection - the collection to move

destination - the destination collection

newName - the new name the collection should have in the destination collection

Throws:

PermissionDeniedException

LockException

java.io.IOException

TriggerException

moveResource

public abstract void moveResource(Txn transaction,
                                  DocumentImpl doc,
                                  Collection destination,
                                  XmldbURI newName)
                           throws PermissionDeniedException,
                                  LockException,
                                  java.io.IOException,
                                  TriggerException

Move a resource to the destination collection and rename it.

Parameters:

doc - the resource to move

destination - the destination collection

newName - the new name the resource should have in the destination collection

Throws:

PermissionDeniedException

LockException

java.io.IOException

TriggerException

copyCollection

public abstract void copyCollection(Txn transaction,
                                    Collection collection,
                                    Collection destination,
                                    XmldbURI newName)
                             throws PermissionDeniedException,
                                    LockException,
                                    java.io.IOException,
                                    TriggerException,
                                    EXistException

Copy a collection to the destination collection and rename it.

Parameters:

transaction - The transaction, which registers the acquired write locks. The locks should be released on commit/abort.

collection - The origin collection

destination - The destination parent collection

newName - The new name of the collection

Throws:

PermissionDeniedException

LockException

java.io.IOException

TriggerException

EXistException

copyResource

public abstract void copyResource(Txn transaction,
                                  DocumentImpl doc,
                                  Collection destination,
                                  XmldbURI newName)
                           throws PermissionDeniedException,
                                  LockException,
                                  EXistException

Copy a resource to the destination collection and rename it.

Parameters:

doc - the resource to copy

destination - the destination collection

newName - the new name the resource should have in the destination collection

Throws:

PermissionDeniedException

LockException

EXistException

defragXMLResource

public abstract void defragXMLResource(Txn transaction,
                                       DocumentImpl doc)

Defragment pages of this document. This will minimize the number of split pages.

Parameters:

doc - to defrag

checkXMLResourceTree

public abstract void checkXMLResourceTree(DocumentImpl doc)

Perform a consistency check on the specified document. This checks if the DOM tree is consistent.

Parameters:

doc -

checkXMLResourceConsistency

public abstract void checkXMLResourceConsistency(DocumentImpl doc)
                                          throws EXistException

Throws:

EXistException

sync

public abstract void sync(int syncEvent)

Sync dom and collection state data (pages) to disk. In case of Sync.MAJOR_SYNC, sync all states (dom, collection, text and element) to disk.

Parameters:

syncEvent - Sync.MAJOR_SYNC or Sync.MINOR_SYNC

updateNode

public abstract void updateNode(Txn transaction,
                                StoredNode node,
                                boolean reindex)

Update a node's data. To keep nodes in a correct sequential order, it is sometimes necessary to update a previous written node. Warning: don't use it for other purposes.

Parameters:

node - Description of the Parameter

isReadOnly

public boolean isReadOnly()

Is the database running read-only? Returns false by default. Storage backends should override this if they support read-only mode.

Returns:

boolean

getBrokerPool

public BrokerPool getBrokerPool()

insertNodeAfter

public abstract void insertNodeAfter(Txn transaction,
                                     StoredNode previous,
                                     StoredNode node)

indexNode

public abstract void indexNode(Txn transaction,
                               StoredNode node,
                               NodePath currentPath)

indexNode

public void indexNode(Txn transaction,
                      StoredNode node)

removeNode

public abstract void removeNode(Txn transaction,
                                StoredNode node,
                                NodePath currentPath,
                                java.lang.String content)

removeAllNodes

public abstract void removeAllNodes(Txn transaction,
                                    StoredNode node,
                                    NodePath currentPath,
                                    StreamListener listener)

endRemove

public abstract void endRemove(Txn transaction)

storeTempResource

public abstract DocumentImpl storeTempResource(DocumentImpl doc)
                                        throws EXistException,
                                               PermissionDeniedException,
                                               LockException

Create a temporary document in the temp collection and store the supplied data.

Parameters:

doc -

Throws:

EXistException

PermissionDeniedException

LockException

cleanUpTempResources

public abstract void cleanUpTempResources()

Clean up temporary resources. Called by the sync daemon.

cleanUpTempResources

public abstract void cleanUpTempResources(boolean forceRemoval)

Clean up temporary resources. Called by the sync daemon.

Parameters:

forceRemoval - Should temporary resources be forcefully removed

checkAvailableMemory

public abstract void checkAvailableMemory()

Convenience method that allows to check available memory during broker-related processes. This method should eventually trigger flush() events.

getXMLResourcesByDoctype

public abstract MutableDocumentSet getXMLResourcesByDoctype(java.lang.String doctype,
                                                            MutableDocumentSet result)

getReferenceCount

public int getReferenceCount()

incReferenceCount

public void incReferenceCount()

decReferenceCount

public void decReferenceCount()

getIndexConfiguration

public abstract IndexSpec getIndexConfiguration()

setId

public void setId(java.lang.String id)

getId

public java.lang.String getId()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getXMLStreamReader

public abstract EmbeddedXMLStreamReader getXMLStreamReader(NodeHandle node,
                                                           boolean reportAttributes)
                                                    throws java.io.IOException,
                                                           javax.xml.stream.XMLStreamException

Throws:

java.io.IOException

javax.xml.stream.XMLStreamException

newXMLStreamReader

public abstract EmbeddedXMLStreamReader newXMLStreamReader(NodeHandle node,
                                                           boolean reportAttributes)
                                                    throws java.io.IOException,
                                                           javax.xml.stream.XMLStreamException

Throws:

java.io.IOException

javax.xml.stream.XMLStreamException

backupToArchive

public abstract void backupToArchive(RawDataBackup backup)
                              throws java.io.IOException

Throws:

java.io.IOException