Xindice API
version 1.2m1

Apache Xindice API, version 1.2m1
API specification

This document is the API specification for the Apache Xindice XML Database.


Core packages
org.apache.xindice.core This is the top-level package for all Xindice Core functionality.
org.apache.xindice.core.cache Defines and Implements several basic data types and container interfaces, including Key, Value, DocumentSet and NodeSet.
org.apache.xindice.core.filer Defines the Xindice Filer interface and implements several Filers, including BTreeFiler and HashFiler.
org.apache.xindice.core.indexer Defines the Xindice Indexer interface and implements the IndexManager, and NodeIndexer classes.
org.apache.xindice.core.indexer.helpers Implements several optimized Helper classes for Xindice IndexQuery usage.
org.apache.xindice.core.meta Defines and implements the Xindice MetaData storage and retrieval.
org.apache.xindice.core.query Implements the Xindice QueryEngine and XPathQueryResolver.
org.apache.xindice.core.request Implements several interfaces for extending Xindice resources into the standard Java URLConnection system.
org.apache.xindice.core.xupdate Defines several classes for Xindice XUpdate query processing.
org.apache.xindice.util This package contains many of the utility classes required by Xindice
org.apache.xindice.xml Top level package for Xindice XML support, including DOM, SAX, Compression, and JAXP drivers.
org.apache.xindice.xml.dom Implements the Xindice Compressed DOM and DOMParser.
org.apache.xindice.xml.dom.traversal Implements the Xindice Compressed DOM Traversal classes.
org.apache.xindice.xml.jaxp Implements the factories necessary to provide JAXP support from Xindice.
org.apache.xindice.xml.sax Implements the Xindice SAX Event Generator and defines an extension interface for intercepting compression events.


Server packages
org.apache.xindice.server This package contains all of the classes that comprise the Xindice server framework.


Client packages
org.apache.xindice.client This is a top-level package for client-connectivity implementations, such as the XML:DB API.
org.apache.xindice.client.xmldb Implements the XML:DB API for use with Xindice data stores.
org.apache.xindice.client.xmldb.embed Xindice Embedded Driver implements the XML:DB client API.
org.apache.xindice.client.xmldb.managed Xindice Managed Driver implements the XML:DB client API.
org.apache.xindice.client.xmldb.resources Implements the XMLResource and BinaryResource interfaces from the XML:DB API. Implements several XML:DB Services, including standard and extension services.
org.apache.xindice.client.xmldb.xmlrpc Xindice XML-RPC Driver implements the XML:DB client API.


Tools packages Implements the Xindice command-line tools system for server administration and database access. Implements the commands that are available via the Command Line Tools.


Other Packages
org.apache.xindice Not much here except for a Stopwatch debugger class.


This document is the API specification for the Apache Xindice XML Database. Further information can be found on

Xindice API
version 1.2m1

Copyright (c) 1999-2007 The Apache Software Foundation. All Rights Reserved.