Package io.permazen.core

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

Related Packages

Package	Description
io.permazen	Abstraction layer allowing access to a Database using normal Java objects.
io.permazen.core.util	Permazen core API utility classes.

Class	Description
AbstractCoreIndex<T>	Support superclass for the various core index classes.
CollectionElementIndex<C extends Collection<E>,E>	A simple index on the elements of a CollectionField.
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.
ComplexSubFieldIndex<C,T>	A simple index on a ComplexField sub-field.
CompositeIndex	A composite index on two or more fields in an ObjType.
CoreIndex1<V,T>	Core API Index1 implementation representing an 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.
CreateListener	Listener interface for notifications that an object has just been created.
Database	Provides an object database abstraction on top of a key/value database.
DatabaseException	Superclass of all unchecked exceptions thrown by a Database.
DeleteAction	Describes what action to take when an object is deleted and a reference to that object from some other object still exists.
DeletedObjectException	Thrown when an object is accessed but the object does not exist in its associated transaction.
DeleteListener	Listener interface for notifications that an object is about to be deleted.
DetachedTransaction	A Transaction that is not actually connected to a persistent database, but instead exists just to hold objects in memory.
Encodings	A few Encodings that are used for various general encoding tasks.
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.
EnumValueEncoding	The Encoding for EnumValue, which is the data type used by EnumField.
Field<T>	A field in an ObjType or a (simple) sub-field of a ComplexField in an ObjType.
FieldSwitch<R>	Visitor pattern interface for Fields.
InconsistentDatabaseException	Thrown when inconsistent content is detected in a Database indicating a corrupted or invalid database, or a buggy underlying key-value store.
Index	A simple or composite index on some field(s) an ObjType.
IndexSwitch<R>	Visitor pattern interface for Indexes.
InvalidObjectVersionException	Thrown when an object is found to have an invalid schema index.
InvalidReferenceException	Thrown when attempting to set a reference field to a disallowed object type.
InvalidSchemaException	Thrown by Database.createTransaction(io.permazen.schema.SchemaModel) when the provided schema is invalid.
Layout	Constants and utility methods relating to the encoding and layout of a Database in a key/value store.
ListElementIndex<E>	An index on the elements of a list field.
ListField<E>	List field.
ListFieldChangeListener	Listener interface for notifications of a change in value of a ListField.
MapField<K,V>	Map field.
MapFieldChangeListener	Listener interface for notifications of a change in value of a MapField.
MapKeyIndex<K,V>	An index on the keys of a map field.
MapValueIndex<K,V>	An index on the values of a map field.
ObjId	Object IDs.
ObjIdEncoding	Non-null encoding for ObjIds.
ObjType	Represents a Database object type.
ReferencedObjectException	Thrown on an attempt to delete an object which is still referenced by a ReferenceField configured for DeleteAction.EXCEPTION.
ReferenceEncoding	The Encoding for ReferenceFields.
ReferenceField	A field that references another Database object.
RollbackOnlyTransactionException	Thrown on an attempt to commit() a transaction that has been marked rollback-only.
Schema	Reflects a SchemaModel as recorded in a Database as seen by a particular Transaction.
SchemaBundle	Reflects the Schema table currently recorded in a Database as seen by a particular Transaction.
SchemaBundle.Encoded	The byte[]-encoded version of a SchemaBundle that is actually stored in a Database.
SchemaChangeListener	Listener interface for notifications that an object's schema has been changed to match the current transaction.
SchemaItem	Superclass for the ObjType, Field, and Index classes which constitute a Schema.
SchemaMismatchException	Thrown by Database.createTransaction(io.permazen.schema.SchemaModel) when the expected schema does not match and of the schemas already recorded in the database.
SetElementIndex<E>	An index on the elements of a set field.
SetField<E>	Set field.
SetFieldChangeListener	Listener interface for notifications of a change in value of a SetField.
SimpleField<T>	A simple Field.
SimpleFieldChangeListener	Listener interface for notifications of a change in value of a SimpleField.
SimpleFieldIndex<T>	An index on a simple field that is not a sub-field of a complex field.
SimpleIndex<T>	An index on a simple field, either a regular simple field or a sub-field of a complex field.
StaleTransactionException	Thrown when a transaction that has been committed, rolled back, or otherwise invalidated is accessed.
Transaction	A Permazen Database transaction.
Transaction.Callback	Callback interface for notification of transaction completion events.
Transaction.CallbackAdapter	Adapter class for Transaction.Callback.
Transaction.ListenerSet	A fixed collection of listeners (CreateListeners, DeleteListeners, SchemaChangeListeners, SimpleFieldChangeListeners, SetFieldChangeListeners, ListFieldChangeListeners, and MapFieldChangeListeners) that can be efficiently registered on a Transaction all at once.
TransactionConfig	Configuration for a Transaction.
TransactionConfig.Builder	Builder for TransactionConfigs.
TransactionConfig.SchemaRemoval	Configures if and when to automatically detect and remove unused schemas from a database.
TransactionException	Superclass of exceptions associated with a specific Transaction.
TypeNotInSchemaException	Thrown when attempting to migrate a database object to a new schema in which the object's type no longer exists.
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.