Package io.permazen.core

Core classes for the Permazen Java persistence layer.

The classes in this package implement the Permazen core API. The core API layer can function entirely independently from the annotation-based Permazen Java object model layer; the latter is implemented on top of these classes. In turn, the core API layer is implemented on top of the key/value store layer.

See Also:

io.permazen, io.permazen.kv, The Permazen Project

Interface Summary

Interface	Description
CreateListener	Listener interface for notifications that an object has just been created.
DeleteListener	Listener interface for notifications that an object is about to be deleted.
FieldSwitch<R>	Visitor pattern interface for Fields.
ListFieldChangeListener	Listener interface for notifications of a change in value of a ListField.
MapFieldChangeListener	Listener interface for notifications of a change in value of a MapField.
SetFieldChangeListener	Listener interface for notifications of a change in value of a SetField.
SimpleFieldChangeListener	Listener interface for notifications of a change in value of a SimpleField.
Transaction.Callback	Callback interface for notification of transaction completion events.
VersionChangeListener	Listener interface for notifications that an object's schema version has been changed to match the current transaction.

Class Summary

Class	Description
CollectionField<C extends Collection<E>,E>	Superclass of fields with types assignable to Collection.
ComplexField<T>	A complex Field, such as a collection or map field.
CompositeIndex	Represents a composite index on an ObjType.
CoreIndex<V,T>	Core API Index implementation representing a index on a single field.
CoreIndex2<V1,V2,T>	Core API Index2 implementation representing a composite index on two fields.
CoreIndex3<V1,V2,V3,T>	Core API Index3 implementation representing a composite index on three fields.
CoreIndex4<V1,V2,V3,V4,T>	Core API Index4 implementation representing a composite index on four fields.
CounterField	Counter fields.
Database	Provides an object database abstraction on top of a key/value database.
EnumArrayField	A field that contains an array (having one or more dimensions) of values chosen from an ordered list of unique String identifiers.
EnumField	A field that contains a value chosen from in an ordered list of unique String identifiers.
EnumValue	Holds a non-null Enum value without actually referencing any Java Enum type.
Field<T>	Represents a field in an ObjType or a (simple) sub-field of a ComplexField.
FieldSwitchAdapter<R>	Adapter class for FieldSwitch.
FieldType<T>	Defines the encoding, ordering, and range of possible values for a SimpleField.
FieldTypeRegistry	A registry of FieldTypes.
Layout	Constants and utility methods relating to the encoding and layout of a Database in a key/value store.
ListField<E>	List field.
MapField<K,V>	Map field.
ObjId	Object IDs.
ObjType	Represents a Database object type.
ReferenceField	A field that references another Database object.
Schema	Contains information describing one schema version.
SchemaItem	Superclass for the ObjType, CompositeIndex, and Field classes which make up a Schema version.
Schemas	Contains the set of all Schemas of objects visible in a Transaction.
SetField<E>	Set field.
SimpleField<T>	A simple Field.
SnapshotTransaction	A "snapshot" Transaction that persists indefinitely.
Transaction	A Permazen Database transaction.
Transaction.CallbackAdapter	Adapter class for Transaction.Callback.
Transaction.ListenerSet	A fixed collection of listeners (CreateListeners, DeleteListeners, VersionChangeListeners, SimpleFieldChangeListeners, SetFieldChangeListeners, ListFieldChangeListeners, and MapFieldChangeListeners) that can be efficiently registered on a Transaction all at once.
Version	Contains library version information.

Enum Summary

Enum	Description
DeleteAction	Describes what action to take when an object that is still referred to by some other object is deleted.

Exception Summary

Exception	Description
DatabaseException	Superclass of all unchecked exceptions thrown by a Database.
DeletedObjectException	Thrown when an object is accessed but the object does not exist in its associated transaction.
InconsistentDatabaseException	Thrown when inconsistent content is detected in a Database indicating a corrupted or invalid database, or a buggy underlying key-value store.
InvalidObjectVersionException	Thrown when an object is found to have an invalid schema version.
InvalidReferenceException	Thrown when attempting to set a reference field to a disallowed object type.
InvalidSchemaException	Thrown by Database.createTransaction(io.permazen.schema.SchemaModel, int, boolean) when the provided schema is invalid.
ReferencedObjectException	Thrown on an attempt to delete an object which is still referenced by a ReferenceField configured for DeleteAction.EXCEPTION.
RollbackOnlyTransactionException	Thrown on an attempt to commit() a transaction that has been marked rollback-only.
SchemaMismatchException	Thrown by Database.createTransaction(io.permazen.schema.SchemaModel, int, boolean) when the given schema cannot be matched with the schema of the same version already recorded in the database, or cannot be added to the database because it is incompatible with one or more prior schema versions.
StaleTransactionException	Thrown when a transaction that has been committed, rolled back, or otherwise invalidated is accessed.
TransactionException	Superclass of exceptions associated with a specific Transaction.
TypeNotInSchemaVersionException	Thrown when attempting to update a database object to a schema version in which the object's type is not defined.
UnknownFieldException	Thrown when an unknown field is accessed.
UnknownIndexException	Thrown when an unknown index is accessed.
UnknownTypeException	Thrown when attempting to access an unknown type.