Sans Pareil Technologies, Inc.
Object Database API

API documentation for the SPT Object Database.

See:
Description

Packages

com.sptci.prevayler	Core classes for the database engine built around Prevayler.
com.sptci.prevayler.annotations	Annotations used to automate handling of prevalent objects by the prevalent system.
com.sptci.prevayler.query	Queries defined for the prevalent system.
com.sptci.prevayler.transaction	Note: Users do not normally need to directly use these classes.

API documentation for the SPT Object Database. The database engine is implemented using Prevayler as the transactional serialisation engine. The database engine attempts to provide features that are normal for an object database over and above the features made available by Prevayler.

The following are core features provided by the database:

1. Transparent persistence of complex object graphs.
2. Persistence by reachability on preavlent objects in the object graph that have not yet been persisted. Note that persistence by reachability applies both to prevayler.transaction.Add and prevayler.transaction.Update transactions.
3. Annotations based indexing and constraints.
4. Managed relationships to automatically manage references when persistent objects are deleted from the prevalent system.
5. Configurable snapshot intervals and mechanism (XML or Java serialisation).

The primary classes exposed by the database are:

1. PrevalentObject - The base class for all objects that can be managed using the database engine.
2. PrevalentManager - A facade around the prevalent system. Similar to JDO PersistenceManager. Provides a much more natural interface than that provided by prevayler.
3. PrevalentSystemFactory - The factory class used to bootstrap the prevalent system. Not be use used if using PrevalentManager.
4. PrevalentSystem - The primary class wrapped by Prevayler instance. Users may chose to sub-class this implementation for custom management of their prevalent objects.
5. com.sptci.prevayler.annotations - Package under which the annotations used to configure indices, foreign keys, constraints etc for the prevalent objects are available.