Package com.xerox.bantam

Bantam is an interface to a store of propertied documents with schema enforcement.

See:
Description

Interface Summary

CollectionDocument	An interface for a Document containing other documents.
ContentDocument	An interface for a Document with associated content.
Document	Root Document interface.
DocumentList	A Document container (like java.util.List, with the addition of strongly typed methods).
QueryFactory	Interface for constructing Query objects; the methods enumerate all permitted query predicate types.
Storage	Interface to a property store.
TypeDescriptor	The interface to a type description object for expressing value type constraints in Schemas.

Class Summary

ClassTypeDescriptor	TypeDescriptor for value types identical to Java classes.
DocumentType	Constants for identifying document type.
EnumeratedType	TypeDescriptor for value types that are particular enumerated subsets of values of a Java class.
FieldDescriptor	A FieldDescriptor is an immutable representation of a Bantam property constraint.
Query	Base class for queries.
Schema	A Schema object is an immutable representation of a Bantam schema.
StorageVersion

Exception Summary

StorageException

Exception thrown by methods in the Bantam interfaces.

Package com.xerox.bantam Description

Bantam is an interface to a store of propertied documents with schema enforcement. Bantam primarily consists of Java interfaces, but also includes a classes defining basic data structures and constants required by methods in the interfaces. Outside of these data structure classes there is no implementation code in the Bantam package itself and this is deliberate to ensure that Bantam remains an interface appropriate for diverse document store implementations.

The following implementations exist or are planned:

• Angstrom A very light-weight implementation on top of the filesystem or a relational database intended to support application development and testing.
• Placeless An implementation based on the Placeless Documents prototype infrastructure.
• Harland An experimental prototype of a store built on a relational database intended to offer superior performance by exploiting regularity as described by schemas. Harland is the focus of most work involving Bantam.

Since Bantam is just the interface, it provides no way to initialize a particular implementation. The convenience class com.xerox.bantam.util.StorageFactory offers methods to streamline the process of initializing a Storage implementation.

See Also:

Placeless Documents Project, com.xerox.bantam.util