| 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.access.translator.select | |
| org.apache.cayenne.ashwood | |
| org.apache.cayenne.exp | Cayenne data expression classes. | 
| org.apache.cayenne.graph | Contains generic graph management tools used in Cayenne. | 
| org.apache.cayenne.map | Contains O/R mapping classes that store relational database 
metadata information and map it to Java classes. | 
| org.apache.cayenne.query | Defines standard queries supported by Cayenne and extension mechanism to create
custom queries. | 
| org.apache.cayenne.reflect | |
| org.apache.cayenne.util | General utility classes. | 
| Modifier and Type | Interface and Description | 
|---|---|
| interface  | DataObjectDefines basic methods for a persistent object in Cayenne. | 
| Modifier and Type | Class and Description | 
|---|---|
| class  | CayenneDataObjectA default implementation of DataObject interface. | 
| class  | PersistentObjectA convenience base superclass for concrete Persistent objects. | 
| Modifier and Type | Field and Description | 
|---|---|
| protected Persistent | DeleteDenyException. object | 
| Modifier and Type | Method and Description | 
|---|---|
| <T extends Persistent> | BaseContext. localObject(T objectFromAnotherContext) | 
| <T extends Persistent> | ObjectContext. localObject(T objectFromAnotherContext)Returns a local copy of 'objectFromAnotherContext' object. | 
| Modifier and Type | Method and Description | 
|---|---|
| Persistent | DeleteDenyException. getObject() | 
| Modifier and Type | Method and Description | 
|---|---|
| static Map<String,Object> | Cayenne. compoundPKForObject(Persistent dataObject)Returns a primary key map for a persistent object. | 
| static ClassDescriptor | Cayenne. getClassDescriptor(Persistent object)Returns class descriptor for the object or null if the object is not
 registered with an ObjectContext or descriptor was not found. | 
| static ObjEntity | Cayenne. getObjEntity(Persistent p)Returns mapped ObjEntity for object. | 
| static PropertyDescriptor | Cayenne. getProperty(Persistent object,
           String properyName)Returns property descriptor for specified property. | 
| static int | Cayenne. intPKForObject(Persistent dataObject)Returns an int primary key value for a persistent object. | 
| static long | Cayenne. longPKForObject(Persistent dataObject)Returns an int primary key value for a persistent object. | 
| static Object | Cayenne. pkForObject(Persistent dataObject)Returns a primary key value for a persistent object. | 
| void | BaseContext. prepareForAccess(Persistent object,
                String property,
                boolean lazyFaulting) | 
| void | ObjectContext. prepareForAccess(Persistent object,
                String property,
                boolean lazyFaulting)A callback method that child Persistent objects are expected to call
 before accessing property values. | 
| void | BaseContext. propertyChanged(Persistent object,
               String property,
               Object oldValue,
               Object newValue) | 
| void | ObjectContext. propertyChanged(Persistent object,
               String property,
               Object oldValue,
               Object newValue)A callback method that child Persistent objects are expected to call from
 inside the setter after modifying a value of a persistent property,
 including "simple" and "arc" properties. | 
| abstract Object | Fault. resolveFault(Persistent sourceObject,
            String relationshipName)Returns an object for a given source object and relationship. | 
| protected void | CayenneDataObject. willConnect(String relationshipName,
           Persistent object)Called before establishing a relationship with another object. | 
| Constructor and Description | 
|---|
| DeleteDenyException(Persistent object,
                   String relationship,
                   String reason) | 
| Modifier and Type | Field and Description | 
|---|---|
| protected Map<Object,Persistent> | ObjectStore. objectMap | 
| Modifier and Type | Method and Description | 
|---|---|
| <T extends Persistent> | DataContext. objectFromDataRow(Class<T> objectClass,
                 DataRow dataRow)Creates a DataObject from DataRow. | 
| Modifier and Type | Method and Description | 
|---|---|
| Persistent | DataContext. newObject(String entityName)Instantiates a new object and registers it with this context. | 
| Modifier and Type | Method and Description | 
|---|---|
| Map<Object,Persistent> | DefaultObjectMapRetainStrategy. createObjectMap() | 
| Map<Object,Persistent> | ObjectMapRetainStrategy. createObjectMap() | 
| Iterator<Persistent> | ObjectStore. getObjectIterator()Returns an iterator over the registered objects. | 
| List<Persistent> | ObjectStore. objectsInState(int state)Return a subset of registered objects that are in a certain persistence state. | 
| Modifier and Type | Method and Description | 
|---|---|
| DataRow | DataContext. currentSnapshot(Persistent object)Returns a DataRow reflecting current, possibly uncommitted, object state. | 
| Object | ToManyListFault. resolveFault(Persistent sourceObject,
            String relationshipName)Resolves this fault to a List of objects. | 
| Object | ToManyMapFault. resolveFault(Persistent sourceObject,
            String relationshipName) | 
| Object | ToManySetFault. resolveFault(Persistent sourceObject,
            String relationshipName) | 
| Object | ToOneFault. resolveFault(Persistent sourceObject,
            String relationshipName)Resolves this fault to a DataObject. | 
| Constructor and Description | 
|---|
| ToManyList(Persistent source,
          String relationship)Creates ToManyList. | 
| ToManySet(Persistent relationshipOwner,
         String relationshipName) | 
| Constructor and Description | 
|---|
| NoSyncObjectStore(DataRowStore dataRowCache,
                 Map<Object,Persistent> objectMap) | 
| ObjectStore(DataRowStore dataRowCache,
           Map<Object,Persistent> objectMap)Creates an ObjectStore with  DataRowStoreand a map to use for storing
 registered objects. | 
| Modifier and Type | Method and Description | 
|---|---|
| void | DataObjectMatchTranslator. setDataObject(Persistent obj) | 
| Modifier and Type | Method and Description | 
|---|---|
| protected Object | AshwoodEntitySorter. findReflexiveMaster(Persistent object,
                   ObjRelationship toOneRel,
                   String targetEntityName) | 
| Modifier and Type | Method and Description | 
|---|---|
| static <T extends Persistent> | Property. createSelf(Class<? super T> type)
 Creates "self" Property for persistent class. | 
| <T extends Persistent> | Property. flat(Class<? super T> tClass)Create new "flat" property for toMany relationship. | 
| Modifier and Type | Method and Description | 
|---|---|
| static Expression | ExpressionFactory. matchAnyExp(Persistent... objects)Creates an expression that matches any of the objects contained in the
  objectsarray | 
| static Expression | ExpressionFactory. matchExp(Persistent object)Creates an expression that matches the primary key of object in
  ObjectId'sIdSnapshotfor the argumentobject. | 
| Modifier and Type | Method and Description | 
|---|---|
| static Expression | ExpressionFactory. matchAnyExp(List<? extends Persistent> objects)Creates an expression that matches any of the objects contained in the
 list  objects | 
| Modifier and Type | Method and Description | 
|---|---|
| protected Persistent | ChildDiffLoader. findObject(Object nodeId) | 
| protected Persistent | ChildDiffLoader. findObjectInCollection(Object nodeId,
                      Object toManyHolder) | 
| Modifier and Type | Method and Description | 
|---|---|
| ObjEntity | DataMap. getObjEntity(Persistent object) | 
| ObjEntity | EntityResolver. getObjEntity(Persistent object) | 
| ObjEntity | MappingNamespace. getObjEntity(Persistent object) | 
| Constructor and Description | 
|---|
| RefreshQuery(Persistent object)Creates a RefreshQuery that refreshes a single object, including invalidation of
 its relationships. | 
| Modifier and Type | Method and Description | 
|---|---|
| void | LifecycleCallbackRegistry. performCallbacks(LifecycleEvent type,
                Persistent object)Invokes callbacks of a specific type for a given entity object. | 
| Modifier and Type | Field and Description | 
|---|---|
| protected Persistent | RelationshipFault. relationshipOwner | 
| Modifier and Type | Field and Description | 
|---|---|
| protected Map<ObjectId,Persistent> | ObjectDetachOperation. seen | 
| Modifier and Type | Method and Description | 
|---|---|
| <T extends Persistent> | DeepMergeOperation. merge(T peerInParentContext) | 
| <T extends Persistent> | ShallowMergeOperation. merge(T peerInParentContext) | 
| Modifier and Type | Method and Description | 
|---|---|
| Persistent | RelationshipFault. getRelationshipOwner() | 
| Modifier and Type | Method and Description | 
|---|---|
| protected Object | PersistentObjectHolder. connect(Persistent persistent)Returns an object that should be stored as a value in this ValueHolder, ensuring
 that it is registered with the same context. | 
| protected void | ObjectContextGraphAction. handleArcPropertyChange(Persistent object,
                       ArcProperty property,
                       Object oldValue,
                       Object newValue) | 
| void | ObjectContextGraphAction. handlePropertyChange(Persistent object,
                    String propertyName,
                    Object oldValue,
                    Object newValue)Handles property change in a Persistent object, routing to either
  ObjectContextGraphAction.handleArcPropertyChange(Persistent, ArcProperty, Object, Object)orObjectContextGraphAction.handleSimplePropertyChange(Persistent, String, Object, Object). | 
| protected void | ObjectContextGraphAction. handleSimplePropertyChange(Persistent object,
                          String propertyName,
                          Object oldValue,
                          Object newValue) | 
| protected boolean | ObjectContextGraphAction. markAsDirty(Persistent object)Changes object state to MODIFIED if needed, returning true if the change has
 occurred, false if not. | 
| Constructor and Description | 
|---|
| PersistentObjectHolder(Persistent relationshipOwner,
                      String relationshipName) | 
| PersistentObjectList(Persistent relationshipOwner,
                    String relationshipName)Creates PersistentObjectList initializing it with list owner persistent object and
 relationship name that this list maps to. | 
| PersistentObjectMap(Persistent relationshipOwner,
                   String relationshipName,
                   Accessor mapKeyAccessor)Creates PersistentObjectList initializing it with list owner persistent object and
 relationship name that this list maps to. | 
| PersistentObjectSet(Persistent relationshipOwner,
                   String relationshipName) | 
| RelationshipFault(Persistent relationshipOwner,
                 String relationshipName) | 
Copyright © 2001–2023 Apache Cayenne. All rights reserved.