| Package | Description | 
|---|---|
| org.apache.cayenne | Contains persistence APIs directly accessible by users. | 
| org.apache.cayenne.access | Contains classes that make up Cayenne ORM stack. | 
| org.apache.cayenne.configuration | |
| org.apache.cayenne.configuration.rop.client | |
| org.apache.cayenne.configuration.server | |
| org.apache.cayenne.graph | Contains generic graph management tools used in Cayenne. | 
| org.apache.cayenne.query | Defines standard queries supported by Cayenne and extension mechanism to create
custom queries. | 
| org.apache.cayenne.remote | Contains classes an interfaces related to Cayenne remote object persistence features. | 
| org.apache.cayenne.tx | |
| org.apache.cayenne.util | General utility classes. | 
| Modifier and Type | Class and Description | 
|---|---|
| class  | BaseContextA common base superclass for Cayenne ObjectContext implementors. | 
| class  | CayenneContextA default generic implementation of ObjectContext suitable for accessing
 Cayenne from either an ORM or a client tiers. | 
| Modifier and Type | Field and Description | 
|---|---|
| protected ObjectContext | PersistentObject. objectContext | 
| Modifier and Type | Field and Description | 
|---|---|
| protected static ThreadLocal<ObjectContext> | BaseContext. threadObjectContextA holder of a ObjectContext bound to the current thread. | 
| Modifier and Type | Method and Description | 
|---|---|
| ObjectContext | Persistent. getObjectContext() | 
| ObjectContext | PersistentObject. getObjectContext() | 
| static ObjectContext | BaseContext. getThreadObjectContext()Returns the ObjectContext bound to the current thread. | 
| Modifier and Type | Method and Description | 
|---|---|
| static void | BaseContext. bindThreadObjectContext(ObjectContext context)Binds a ObjectContext to the current thread. | 
| static <T> T | Cayenne. objectForPK(ObjectContext context,
           Class<T> dataObjectClass,
           int pk)Returns an object matching an int primary key. | 
| static <T> T | Cayenne. objectForPK(ObjectContext context,
           Class<T> dataObjectClass,
           Map<String,?> pk)Returns an object matching a primary key. | 
| static <T> T | Cayenne. objectForPK(ObjectContext context,
           Class<T> dataObjectClass,
           Object pk)Returns an object matching an Object primary key. | 
| static Object | Cayenne. objectForPK(ObjectContext context,
           ObjectId id)Returns an object matching ObjectId. | 
| static Object | Cayenne. objectForPK(ObjectContext context,
           String objEntityName,
           int pk)Returns an object matching an int primary key. | 
| static Object | Cayenne. objectForPK(ObjectContext context,
           String objEntityName,
           Map<String,?> pk)Returns an object matching a primary key. | 
| static Object | Cayenne. objectForPK(ObjectContext context,
           String objEntityName,
           Object pk)Returns an object matching an Object primary key. | 
| static Object | Cayenne. objectForQuery(ObjectContext context,
              Query query)Returns an object or a DataRow that is a result of a given query. | 
| protected abstract GraphDiff | BaseContext. onContextFlush(ObjectContext originatingContext,
              GraphDiff changes,
              boolean cascade) | 
| protected GraphDiff | CayenneContext. onContextFlush(ObjectContext originatingContext,
              GraphDiff changes,
              boolean cascade) | 
| QueryResponse | CayenneContext. onQuery(ObjectContext context,
       Query query) | 
| QueryResponse | DataChannel. onQuery(ObjectContext originatingContext,
       Query query)Executes a query, using provided context to register persistent objects if
 query returns any objects. | 
| QueryResponse | DataChannelFilterChain. onQuery(ObjectContext originatingContext,
       Query query) | 
| QueryResponse | DataChannelFilter. onQuery(ObjectContext originatingContext,
       Query query,
       DataChannelFilterChain filterChain) | 
| GraphDiff | BaseContext. onSync(ObjectContext originatingContext,
      GraphDiff changes,
      int syncType) | 
| GraphDiff | DataChannel. onSync(ObjectContext originatingContext,
      GraphDiff changes,
      int syncType)Processes synchronization request from a child ObjectContext, returning a GraphDiff
 that describes changes to objects made on the receiving end as a result of
 synchronization. | 
| GraphDiff | DataChannelFilterChain. onSync(ObjectContext originatingContext,
      GraphDiff changes,
      int syncType) | 
| GraphDiff | DataChannelSyncFilterChain. onSync(ObjectContext originatingContext,
      GraphDiff changes,
      int syncType) | 
| GraphDiff | DataChannelFilter. onSync(ObjectContext originatingContext,
      GraphDiff changes,
      int syncType,
      DataChannelFilterChain filterChain) | 
| void | CayenneDataObject. setObjectContext(ObjectContext objectContext) | 
| void | Persistent. setObjectContext(ObjectContext objectContext) | 
| void | PersistentObject. setObjectContext(ObjectContext objectContext) | 
| Modifier and Type | Class and Description | 
|---|---|
| class  | DataContextThe most common implementation of  ObjectContext. | 
| Modifier and Type | Method and Description | 
|---|---|
| Map<?,?> | OptimisticLockException. getFreshSnapshot(ObjectContext context)Retrieves fresh snapshot for the failed row. | 
| protected GraphDiff | DataContext. onContextFlush(ObjectContext originatingContext,
              GraphDiff changes,
              boolean cascade) | 
| QueryResponse | ClientServerChannel. onQuery(ObjectContext context,
       Query query) | 
| QueryResponse | DataContext. onQuery(ObjectContext context,
       Query query)An implementation of a  DataChannelmethod that is used by child
 contexts to execute queries. | 
| QueryResponse | DataDomain. onQuery(ObjectContext originatingContext,
       Query query)Runs query returning generic QueryResponse. | 
| GraphDiff | ClientServerChannel. onSync(ObjectContext originatingContext,
      GraphDiff changes,
      int syncType) | 
| GraphDiff | DataDomain. onSync(ObjectContext originatingContext,
      GraphDiff changes,
      int syncType)Only handles commit-type synchronization, ignoring any other type. | 
| Modifier and Type | Method and Description | 
|---|---|
| ObjectContext | ObjectContextFactory. createContext()Creates an ObjectContext attached to a default DataChannel. | 
| ObjectContext | ObjectContextFactory. createContext(DataChannel parent)Creates an ObjectContext attached to a provided channel. | 
| ObjectContext | CayenneRuntime. getContext()Deprecated. 
 since 3.1 use better named  CayenneRuntime.newContext()instead. | 
| ObjectContext | CayenneRuntime. getContext(DataChannel parentChannel)Deprecated. 
 since 3.1 use better named  CayenneRuntime.newContext(DataChannel)instead. | 
| ObjectContext | CayenneRuntime. newContext()Returns a new ObjectContext instance based on the runtime's main
 DataChannel. | 
| ObjectContext | CayenneRuntime. newContext(DataChannel parentChannel)Returns a new ObjectContext which is a child of the specified
 DataChannel. | 
| Modifier and Type | Method and Description | 
|---|---|
| ObjectContext | CayenneContextFactory. createContext() | 
| ObjectContext | CayenneContextFactory. createContext(DataChannel parent) | 
| Modifier and Type | Method and Description | 
|---|---|
| ObjectContext | DataContextFactory. createContext() | 
| ObjectContext | DataContextFactory. createContext(DataChannel parent) | 
| protected ObjectContext | DataContextFactory. createdFromDataDomain(DataDomain parent) | 
| protected ObjectContext | DataContextFactory. createFromDataContext(DataContext parent) | 
| protected ObjectContext | DataContextFactory. createFromGenericChannel(DataChannel parent) | 
| Modifier and Type | Field and Description | 
|---|---|
| protected ObjectContext | ChildDiffLoader. context | 
| Constructor and Description | 
|---|
| ChildDiffLoader(ObjectContext context) | 
| Modifier and Type | Method and Description | 
|---|---|
| ResultBatchIterator<T> | FluentSelect. batchIterator(ObjectContext context,
             int size) | 
| ResultBatchIterator<T> | MappedSelect. batchIterator(ObjectContext context,
             int size) | 
| ResultBatchIterator<T> | Select. batchIterator(ObjectContext context,
             int size)Creates a ResultBatchIterator based on the provided context and batch
 size. | 
| ResultBatchIterator<T> | SelectById. batchIterator(ObjectContext context,
             int size) | 
| ResultBatchIterator<T> | SelectQuery. batchIterator(ObjectContext context,
             int size) | 
| ResultBatchIterator<T> | SQLSelect. batchIterator(ObjectContext context,
             int size) | 
| int[] | ProcedureCall. batchUpdate(ObjectContext context) | 
| ProcedureResult<T> | ProcedureCall. call(ObjectContext context) | 
| QueryResult | MappedExec. execute(ObjectContext context) | 
| QueryResult | SQLExec. execute(ObjectContext context) | 
| void | FluentSelect. iterate(ObjectContext context,
       ResultIteratorCallback<T> callback) | 
| void | MappedSelect. iterate(ObjectContext context,
       ResultIteratorCallback<T> callback) | 
| void | Select. iterate(ObjectContext context,
       ResultIteratorCallback<T> callback)Creates a ResultIterator based on the provided context and passes it to a
 callback for processing. | 
| void | SelectById. iterate(ObjectContext context,
       ResultIteratorCallback<T> callback) | 
| void | SelectQuery. iterate(ObjectContext context,
       ResultIteratorCallback<T> callback) | 
| void | SQLSelect. iterate(ObjectContext context,
       ResultIteratorCallback<T> callback) | 
| ResultIterator<T> | FluentSelect. iterator(ObjectContext context) | 
| ResultIterator<T> | MappedSelect. iterator(ObjectContext context) | 
| ResultIterator<T> | Select. iterator(ObjectContext context)Creates a ResultIterator based on the provided context. | 
| ResultIterator<T> | SelectById. iterator(ObjectContext context) | 
| ResultIterator<T> | SelectQuery. iterator(ObjectContext context) | 
| ResultIterator<T> | SQLSelect. iterator(ObjectContext context) | 
| List<T> | FluentSelect. select(ObjectContext context) | 
| List<T> | MappedSelect. select(ObjectContext context) | 
| List<T> | ProcedureCall. select(ObjectContext context) | 
| List<T> | Select. select(ObjectContext context)Selects objects using provided context. | 
| List<T> | SelectById. select(ObjectContext context) | 
| List<T> | SelectQuery. select(ObjectContext context) | 
| List<T> | SQLSelect. select(ObjectContext context) | 
| long | ObjectSelect. selectCount(ObjectContext context)Quick way to select count of records | 
| T | ColumnSelect. selectFirst(ObjectContext context) | 
| T | MappedSelect. selectFirst(ObjectContext context) | 
| T | ObjectSelect. selectFirst(ObjectContext context) | 
| T | Select. selectFirst(ObjectContext context)Selects a single object using provided context. | 
| T | SelectById. selectFirst(ObjectContext context) | 
| T | SelectQuery. selectFirst(ObjectContext context) | 
| T | SQLSelect. selectFirst(ObjectContext context) | 
| T | FluentSelect. selectOne(ObjectContext context) | 
| T | MappedSelect. selectOne(ObjectContext context) | 
| T | Select. selectOne(ObjectContext context)Selects a single object using provided context. | 
| T | SelectById. selectOne(ObjectContext context) | 
| T | SelectQuery. selectOne(ObjectContext context) | 
| T | SQLSelect. selectOne(ObjectContext context) | 
| int[] | MappedExec. update(ObjectContext context) | 
| int | ProcedureCall. update(ObjectContext context) | 
| int | SQLExec. update(ObjectContext context) | 
| int[] | SQLExec. updateBatch(ObjectContext context) | 
| Modifier and Type | Field and Description | 
|---|---|
| protected ObjectContext | RemoteIncrementalFaultList. context | 
| protected ObjectContext | SyncMessage. source | 
| Modifier and Type | Method and Description | 
|---|---|
| ObjectContext | RemoteIncrementalFaultList. getContext()Returns ObjectContext associated with this list. | 
| ObjectContext | SyncMessage. getSource()Returns a source of SyncMessage. | 
| Modifier and Type | Method and Description | 
|---|---|
| QueryResponse | ClientChannel. onQuery(ObjectContext context,
       Query query) | 
| GraphDiff | ClientChannel. onSync(ObjectContext originatingContext,
      GraphDiff changes,
      int syncType) | 
| Constructor and Description | 
|---|
| RemoteIncrementalFaultList(ObjectContext context,
                          Query paginatedQuery) | 
| SyncMessage(ObjectContext source,
           int syncType,
           GraphDiff senderChanges) | 
| Modifier and Type | Method and Description | 
|---|---|
| QueryResponse | TransactionFilter. onQuery(ObjectContext originatingContext,
       Query query,
       DataChannelFilterChain filterChain) | 
| GraphDiff | TransactionFilter. onSync(ObjectContext originatingContext,
      GraphDiff changes,
      int syncType,
      DataChannelFilterChain filterChain) | 
| Modifier and Type | Field and Description | 
|---|---|
| protected ObjectContext | ObjectContextQueryAction. actingContext | 
| protected ObjectContext | ObjectContextGraphAction. context | 
| protected ObjectContext | ObjectContextQueryAction. targetContext | 
| Constructor and Description | 
|---|
| DeepMergeOperation(ObjectContext context) | 
| ObjectContextGraphAction(ObjectContext context) | 
| ObjectContextQueryAction(ObjectContext actingContext,
                        ObjectContext targetContext,
                        Query query) | 
| ShallowMergeOperation(ObjectContext context) | 
Copyright © 2001–2023 Apache Cayenne. All rights reserved.