Package com.qizx.api

API of the embeddable version of the Qizx/db database engine.

See:
Description

Interface Summary

AccessControl	Abstract access control to the members of a Library.
Collection	Collections can contain XML Documents and sub-Collections.
Document	Represents a well-formed XML Document stored in a XML Library.
Expression	Compiled XML Query expression.
Indexing.DateSieve	Pluggable analyzer/converter of date-time values, for custom indexing.
Indexing.NumberSieve	Pluggable analyzer/converter of numeric values, for custom indexing.
Indexing.Sieve	Abstraction of Sieves used for indexing XML data.
Indexing.WordSieve	Pluggable text analyzer for custom full-text indexing and query.
Item	An Item of a Sequence returned by the evaluation of an XQuery Expression.
ItemFactory	Creates Items and related resources (ItemTypes and QNames).
ItemSequence	Sequence of Items returned by the evaluation of a XQuery Expression.
ItemType	The type of an Item as defined in the XML Query language.
Library	Work session on a XML Library.
LibraryManager	Manages a group of XML Libraries.
LibraryMember	Common interface for objects belonging to a Library, namely Collections and Documents.
LibraryMemberFilter	Filter for functions searching Documents or Collections inside a Library.
LibraryMemberIterator	Iterator returned by functions searching Documents or Collections inside a Library.
LibraryMemberObserver	Observes update operations on a XML Library.
LibraryProgressObserver	Monitors the progress of diverse operations on a Library.
ModuleResolver	Resolves a module URI specified by a XQuery 'import module' declaration.
Node	Nodes of the Document Data Model, as defined by XQuery1/XPath2, plus extensions.
Product	Product information.
QName	Qualified name for XML elements and attributes.
SequenceType	Type of an Item sequence.
TraceObserver	Interface for displaying execution traces generated by the XQuery function fn:trace().
User	Models the user of a Library and her/his associated privileges, for use with AccessControl.
XMLPullStream	Streaming input of XML contents, working in 'pull' mode.
XMLPushStream	Streaming output for XML contents, working in 'push' mode.
XQueryContext	Definition of the XQuery Context used for compiling and executing Expressions.
XQuerySession	Simple XQuery session without access to XML Libraries, used in Qizx/open.

Class Summary

EvaluationStackTrace	A level in an evaluation Stack Trace.
Indexing	Specification of rules and parameters used to build indexes in a XML Library.
Indexing.Rule	Indexing properties associated with an element or an attribute (for advanced indexing).
LibraryManagerFactory	Factory used to initialize a LibraryManager, either by opening an existing group of XML Libraries stored in a file-system, or by creating a new group.
Message	Message (error or warning) returned by compilation errors.
XQuerySessionManager	Manager of simple XQuery sessions without access to a XML Library.

Exception Summary

AccessControlException	Exception thrown when an AccessControl denies a User the permission to read or modify information in Library.
CompilationException	Thrown at the end of the compilation of an Expression if there are errors.
DataModelException	Exception raised by operations on XML data.
EvaluationException	Exception thrown by an error in the execution of an XQuery Expression.
LibraryException	A specific class of DataModelException raised by Library operations.
QizxException	Super-class of all exceptions of the API.

Package com.qizx.api Description

API of the embeddable version of the Qizx/db database engine.

This package contains the necessary interfaces and classes for handling databases (called XML Library), open a session, import documents, compile and execute XQuery expressions, and retrieve results.