Package com.sleepycat.dbxml

Berkeley DB XML Java API
[reference guide].

See: Description

Class Summary

Class	Description
XmlArguments	The XmlArguments class is used by implementors of XmlExternalFunction to access function arguments passed to the XmlExternalFunction.execute(com.sleepycat.dbxml.XmlTransaction, com.sleepycat.dbxml.XmlManager, com.sleepycat.dbxml.XmlArguments) method.
XmlCompression	XmlCompression is a base class for implementations of custom compression for a container.
XmlContainer	The XmlContainer class encapsulates a document container and its related indices and statistics.
XmlContainerConfig	Configuration settings for an XmlContainer instance.
XmlData	Used by the functions XmlCompression.compress(com.sleepycat.dbxml.XmlTransaction, com.sleepycat.dbxml.XmlData, com.sleepycat.dbxml.XmlData) and XmlCompression.decompress(com.sleepycat.dbxml.XmlTransaction, com.sleepycat.dbxml.XmlData, com.sleepycat.dbxml.XmlData) to hold the data that is being compressed or decompress.
XmlDebugListener	The XmlDebugListener class allows the user to track the progress of a query as it executes.
XmlDocument	The unit of storage within an XmlContainer.
XmlDocumentConfig	Used to configure operations that operate on XmlDocument objects.
XmlEventReader	Used to read XML as events rather than serialized text.
XmlEventReaderToWriter	Used to connect XmlEventReader and XmlEventWriter objects, pushing the events from XmlEventReader to the writer.
XmlEventWriter	Used to create XML content as events rather than serialized text.
XmlExternalFunction	The XmlExternalFunction class is used to implement XQuery extension functions in Java.
XmlIndexDeclaration	An indexing strategy, returned by XmlIndexSpecification.find(java.lang.String, java.lang.String).
XmlIndexLookup	The XmlIndexLookup class encapsulates the context within which an index lookup operation can be performed on an XmlContainer object.
XmlIndexSpecification	The encapsulation of the indexing specification of a container.
XmlInputStream	Used to read and write XML data.
XmlManager	Provides a high-level object used to manage various aspects of Berkeley DB XML usage.
XmlManagerConfig	Used to configure an XmlManager instance via its constructors.
XmlMetaData	Metadata item returned by XmlMetaDataIterator.next().
XmlMetaDataIterator	Provides an iterator over an XmlDocument's metadata.
XmlQueryContext	The XmlQueryContext class encapsulates the context within which a query is performed against an XmlContainer.
XmlQueryExpression	An XmlQueryExpression represents a parsed XQuery expression.
XmlResolver	Provides an unimplemented base class that is used for file resolution policy.
XmlResults	The XmlResults class encapsulates the results of a query that has been executed.
XmlStackFrame	The XmlStackFrame class provides stack trace information about an executing query to the methods of XmlDebugListener.
XmlStatistics	The XmlStatistics class encapsulates statistical information about the number of keys in existence for a given index.
XmlTransaction	The XmlTransaction class is the handle for a transaction.
XmlUpdateContext	The XmlUpdateContext class encapsulates the context within which update operations are performed against an XmlContainer.
XmlValue	The XmlValue class encapsulates the value of a node in an XML document.

Exception Summary

Exception	Description
XmlException	A represention of an error condition that has occurred within the Berkeley DB XML system.

Package com.sleepycat.dbxml Description

Berkeley DB XML Java API
[reference guide].

This package is a wrapper around the Berkeley DB XML library. It uses JNI to provide access to Berkeley DB XML, which is implemented in C++. That means that a shared library or DLL must be available when applications use this package.

There are also several utilities provided with Berkeley DB XML that make administrative tasks possible from the command line. For more information, see the page Berkeley DB XML Supporting Utilities.