Contains persistence APIs directly accessible by users.
Interface Summary Interface Description DataChannelDataChannel is an abstraction used by ObjectContexts to obtain mapping metadata and access a persistent store. DataChannelFilter Deprecated. DataChannelFilterChain Deprecated. DataChannelListenerA listener of
DataChannelQueryFilterAn interface of a filter that allows to intercept DataChannel query operations. DataChannelQueryFilterChainInterface for chain of query filters DataChannelSyncFilterAn interface of a filter that allows to intercept DataChannel sync operations. DataChannelSyncFilterChainInterface for chain of sync filters DataObjectDefines basic methods for a persistent object in Cayenne. EmbeddableObject ExtendedEnumerationAn interface that Enum classes may implement to map enum instances to arbitrary DB values that do not match the enum names or positions. LifecycleListenerA callback interface to listen to persistent object lifecycle events. ObjectContextA Cayenne object facade to a persistent store. ObjectIdA portable global identifier for persistent objects. PersistentDefines minimal API of an object that can be persisted via Cayenne. QueryResponseRepresents a result of query execution. QueryResult<T>Represents a collection of items which are results of a multipart query execution. QueryResultItem<T>Represents a single item in a multipart query execution. ResultIterator<T>Defines API of an iterator over the records returned as a result of Select queries execution. ResultIteratorCallback<T>A callback interface invoked on each row when iterating over
ValidatingDefines a number of callback methods that allow an object to be validated before safe. ValueHolder<E>Provides a level of indirection for property value access, most often used for deferred faulting of to-one relationships.
Class Summary Class Description BaseContextA common base superclass for Cayenne ObjectContext implementors. BaseDataObjectBase implementation of
DataObject, have no assumption about how data is actually stored.
CayenneVarious utils for processing persistent objects and their properties CayenneDataObject DataChannelSyncCallbackAction DataRowDataRow a map that holds values retrieved from the database for a given query row. FaultRepresents a placeholder for an unresolved relationship from a source object. HybridDataObject PersistenceStateDefines a set of object states from the point of view of persistence. PersistentObjectA convenience base superclass for concrete Persistent objects. ProcedureResult<T>Result of procedure call. ResultBatchIterator<T>Defines API of a batch iterator over the ResultIterator returned as a result of Select queries execution.
Exception Summary Exception Description CayenneException Deprecated.since 4.1 use
CayenneRuntimeExceptionA generic unchecked exception that may be thrown by Cayenne framework. ConfigurationExceptionA runtime exception thrown on failures in Cayenne configuration. DeleteDenyExceptionAn exception thrown during an attempt to delete an object that has a relationship to a non-null related object, that has a DENY delete rule. FaultFailureExceptionA runtime exception thrown when during lazy object initialization Cayenne finds that no matching row exists in the database for a given ObjectId.