org.apache.cayenne.access
Class DataContext

java.lang.Object
  extended by org.apache.cayenne.BaseContext
      extended by org.apache.cayenne.access.DataContext
All Implemented Interfaces:
Serializable, DataChannel, ObjectContext

public class DataContext
extends BaseContext
implements DataChannel

Class that provides applications with access to Cayenne persistence features. In most cases this is the only access class directly used in the application.

Most common DataContext use pattern is to create one DataContext per session. "Session" may be a an HttpSession in a web application, or any other similar concept in a multiuser application.

DataObjects are registered with DataContext either implicitly when they are fetched via a query, or read via a relationship from another object, or explicitly via calling newObject(Class)during new DataObject creation. DataContext tracks changes made to its DataObjects in memory, and flushes them to the database when commitChanges()is called. Until DataContext is committed, changes made to its objects are not visible in other DataContexts.

Each DataObject can belong only to a single DataContext. To create a replica of an object from a different DataContext in a local context, use localObject(ObjectId, Object) method.

Author:
Andrus Adamchik
See Also:
Serialized Form

Field Summary
static EventSubject DID_COMMIT
           
static EventSubject DID_ROLLBACK
           
protected  EntityResolver entityResolver
           
protected  String lazyInitParentDomainName
          Stores the name of parent DataDomain.
protected  org.apache.cayenne.access.DataContextMergeHandler mergeHandler
           
protected  ObjectStore objectStore
           
protected  QueryCache queryCache
           
protected static ThreadLocal threadDataContext
          A holder of a DataContext bound to the current thread.
protected  Map userProperties
          Stores user defined properties associated with this DataContext.
protected  boolean usingSharedSnaphsotCache
           
protected  boolean validatingObjectsOnCommit
           
static EventSubject WILL_COMMIT
           
 
Fields inherited from class org.apache.cayenne.BaseContext
channel
 
Fields inherited from interface org.apache.cayenne.DataChannel
FLUSH_CASCADE_SYNC, FLUSH_NOCASCADE_SYNC, GRAPH_CHANGED_SUBJECT, GRAPH_FLUSHED_SUBJECT, GRAPH_ROLLEDBACK_SUBJECT, ROLLBACK_CASCADE_SYNC
 
Constructor Summary
DataContext()
          Creates a new DataContext that is not attached to the Cayenne stack.
DataContext(DataChannel channel, ObjectStore objectStore)
          Creates a new DataContext with parent DataChannel and ObjectStore.
 
Method Summary
static void bindThreadDataContext(DataContext context)
          Binds a DataContext to the current thread.
 void commitChanges()
          Synchronizes object graph with the database.
 void commitChangesToParent()
          "Flushes" the changes to the parent DataChannel.
 DataObject createAndRegisterNewObject(Class objectClass)
          Deprecated. since 3.0, use newObject(Class) instead.
 DataObject createAndRegisterNewObject(String objEntityName)
          Deprecated. since 3.0, use newObject(String) instead.
 DataContext createChildDataContext()
          Creates and returns a new child DataContext.
static DataContext createDataContext()
          Factory method that creates and returns a new instance of DataContext based on default domain.
static DataContext createDataContext(boolean useSharedCache)
          Factory method that creates and returns a new instance of DataContext based on default domain.
static DataContext createDataContext(String domainName)
          Factory method that creates and returns a new instance of DataContext using named domain as its parent.
static DataContext createDataContext(String domainName, boolean useSharedCache)
          Creates and returns new DataContext that will use a named DataDomain as its parent.
 DataRow currentSnapshot(Persistent object)
          Returns a DataRow reflecting current, possibly uncommitted, object state.
 Collection deletedObjects()
          Returns a list of objects that are registered with this DataContext and have a state PersistenceState.DELETED
 void deleteObject(Object object)
          Schedules an object for deletion on the next commit of this DataContext.
 void deleteObjects(Collection objects)
          Schedules all objects in the collection for deletion on the next commit of this DataContext.
 DataChannel getChannel()
          Returns an DataChannel used by this context.
 DataContextDelegate getDelegate()
          Returns a delegate currently associated with this DataContext.
 EntityResolver getEntityResolver()
          Returns EntityResolver.
 EventManager getEventManager()
          Returns EventManager associated with the ObjectStore.
 GraphManager getGraphManager()
          Returns this context's ObjectStore.
 ObjectStore getObjectStore()
          Returns ObjectStore associated with this DataContext.
 DataDomain getParentDataDomain()
          Returns a DataDomain used by this DataContext.
 QueryCache getQueryCache()
          Returns QueryCache used by this DataContext, creating it on the fly if needed.
static DataContext getThreadDataContext()
          Returns the DataContext bound to the current thread.
protected  Map getUserProperties()
          Returns a map of user-defined properties associated with this DataContext.
 Object getUserProperty(String key)
          Returns a user-defined property previously set via 'setUserProperty'.
 boolean hasChanges()
          Returns true if there are any modified, deleted or new objects registered with this DataContext, false otherwise.
 void invalidateObjects(Collection objects)
          "Invalidates" a Collection of persistent objects.
 boolean isTransactionEventsEnabled()
          Deprecated. since 3.0M1 in favor of LifecycleListener. Will be removed in later 3.0 milestones.
 boolean isUsingSharedSnapshotCache()
          Returns true if the ObjectStore uses shared cache of a parent DataDomain.
 boolean isValidatingObjectsOnCommit()
          Returns whether this DataContext performs object validation before commit is executed.
 Persistent localObject(ObjectId id, Object prototype)
          Returns an object local to this DataContext and matching the ObjectId.
 Collection modifiedObjects()
          Returns a list of objects that are registered with this DataContext and have a state PersistenceState.MODIFIED
 Persistent newObject(Class persistentClass)
          Creates and registers a new persistent object.
 Persistent newObject(String entityName)
          Instantiates a new object and registers it with this context.
 Collection newObjects()
          Returns a list of objects that are registered with this DataContext and have a state PersistenceState.NEW
 DataObject objectFromDataRow(Class objectClass, DataRow dataRow, boolean refresh)
          Creates a DataObject from DataRow.
 List objectsFromDataRows(Class objectClass, List dataRows, boolean refresh, boolean resolveInheritanceHierarchy)
          Converts a list of DataRows to a List of DataObject registered with this DataContext.
 List objectsFromDataRows(ObjEntity entity, List dataRows, boolean refresh, boolean resolveInheritanceHierarchy)
          Converts a list of data rows to a list of DataObjects.
 QueryResponse onQuery(ObjectContext context, Query query)
          An implementation of a DataChannel method that is used by child contexts to execute queries.
 GraphDiff onSync(ObjectContext originatingContext, GraphDiff changes, int syncType)
          An implementation of a DataChannel method that is used by child contexts to synchronize state with this context.
 QueryResponse performGenericQuery(Query query)
          Executes a query returning a generic response.
 ResultIterator performIteratedQuery(Query query)
          Performs a single database select query returning result as a ResultIterator.
 int[] performNonSelectingQuery(Query query)
          Performs a single database query that does not select rows.
 int[] performNonSelectingQuery(String queryName)
          Performs a named mapped query that does not select rows.
 int[] performNonSelectingQuery(String queryName, Map parameters)
          Performs a named mapped non-selecting query using a map of parameters.
 List performQuery(Query query)
          Performs a single selecting query.
 List performQuery(String queryName, boolean expireCachedLists)
          Returns a list of objects or DataRows for a named query stored in one of the DataMaps.
 List performQuery(String queryName, Map parameters, boolean expireCachedLists)
          Returns a list of objects or DataRows for a named query stored in one of the DataMaps.
 void 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.
 DataObject refetchObject(ObjectId oid)
          Deprecated. since 3.0 use ObjectIdQuery with appropraite refresh settings.
 void registerNewObject(Object object)
          Registers a transient object with the context, recursively registering all transient persistent objects attached to this object via relationships.
 void rollbackChanges()
          Reverts any changes that have occurred to objects registered with DataContext; also performs cascading rollback of all parent DataContexts.
 void rollbackChangesLocally()
          If the parent channel is a DataContext, reverts local changes to make this context look like the parent, if the parent channel is a DataDomain, reverts all changes.
 void setChannel(DataChannel channel)
           
 void setDelegate(DataContextDelegate delegate)
          Sets a DataContextDelegate for this context.
 void setQueryCache(QueryCache queryCache)
          Sets a QueryCache to be used for storing cached query results.
 void setTransactionEventsEnabled(boolean flag)
          Deprecated. since 3.0M1 in favor of LifecycleListener. Will be removed in later 3.0 milestones.
static void setTransactionEventsEnabledDefault(boolean flag)
          Deprecated. since 3.0M1 in favor of LifecycleListener. Will be removed in later 3.0 milestones.
 void setUserProperty(String key, Object value)
          Sets a user-defined property.
 void setValidatingObjectsOnCommit(boolean flag)
          Sets the property defining whether this DataContext should perform object validation before commit is executed.
 Collection uncommittedObjects()
          Returns a collection of all uncommitted registered objects.
 void unregisterObjects(Collection dataObjects)
          Unregisters a Collection of DataObjects from the DataContext and the underlying ObjectStore.
 
Methods inherited from class org.apache.cayenne.BaseContext
prepareForAccess, prepareForAccess
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

WILL_COMMIT

public static final EventSubject WILL_COMMIT

DID_COMMIT

public static final EventSubject DID_COMMIT

DID_ROLLBACK

public static final EventSubject DID_ROLLBACK

threadDataContext

protected static final ThreadLocal threadDataContext
A holder of a DataContext bound to the current thread.

Since:
1.1

usingSharedSnaphsotCache

protected boolean usingSharedSnaphsotCache

validatingObjectsOnCommit

protected boolean validatingObjectsOnCommit

objectStore

protected ObjectStore objectStore

queryCache

protected QueryCache queryCache

entityResolver

protected transient EntityResolver entityResolver

mergeHandler

protected transient org.apache.cayenne.access.DataContextMergeHandler mergeHandler

userProperties

protected Map userProperties
Stores user defined properties associated with this DataContext.

Since:
1.2

lazyInitParentDomainName

protected transient String lazyInitParentDomainName
Stores the name of parent DataDomain. Used to defer initialization of the parent QueryEngine after deserialization. This helps avoid an issue with certain servlet engines (e.g. Tomcat) where HttpSessions with DataContext's are deserialized at startup before Cayenne stack is fully initialized.

Constructor Detail

DataContext

public DataContext()
Creates a new DataContext that is not attached to the Cayenne stack.


DataContext

public DataContext(DataChannel channel,
                   ObjectStore objectStore)
Creates a new DataContext with parent DataChannel and ObjectStore.

Since:
1.2
Method Detail

getThreadDataContext

public static DataContext getThreadDataContext()
                                        throws IllegalStateException
Returns the DataContext bound to the current thread.

Returns:
the DataContext associated with caller thread.
Throws:
IllegalStateException - if there is no DataContext bound to the current thread.
Since:
1.1
See Also:
WebApplicationContextFilter

bindThreadDataContext

public static void bindThreadDataContext(DataContext context)
Binds a DataContext to the current thread. DataContext can later be retrieved by users in the same thread by calling getThreadDataContext(). Using null parameter will unbind currently bound DataContext.

Since:
1.1

createDataContext

public static DataContext createDataContext()
Factory method that creates and returns a new instance of DataContext based on default domain. If more than one domain exists in the current configuration, createDataContext(String) must be used instead. ObjectStore associated with created DataContext will have a cache stack configured using parent domain settings.


createDataContext

public static DataContext createDataContext(boolean useSharedCache)
Factory method that creates and returns a new instance of DataContext based on default domain. If more than one domain exists in the current configuration, createDataContext(String, boolean) must be used instead. ObjectStore associated with newly created DataContext will have a cache stack configured according to the specified policy, overriding a parent domain setting.

Since:
1.1

createDataContext

public static DataContext createDataContext(String domainName)
Factory method that creates and returns a new instance of DataContext using named domain as its parent. If there is no domain matching the name argument, an exception is thrown.


createDataContext

public static DataContext createDataContext(String domainName,
                                            boolean useSharedCache)
Creates and returns new DataContext that will use a named DataDomain as its parent. ObjectStore associated with newly created DataContext will have a cache stack configured according to the specified policy, overriding a parent domain setting.

Since:
1.1

getQueryCache

public QueryCache getQueryCache()
Returns QueryCache used by this DataContext, creating it on the fly if needed. Uses parent DataDomain QueryCacheFactory to initialize the cache for the first time.

Since:
3.0

setQueryCache

public void setQueryCache(QueryCache queryCache)
Sets a QueryCache to be used for storing cached query results.

Since:
3.0

getUserProperties

protected Map getUserProperties()
Returns a map of user-defined properties associated with this DataContext.

Since:
1.2

createChildDataContext

public DataContext createChildDataContext()
Creates and returns a new child DataContext.

Since:
1.2

getUserProperty

public Object getUserProperty(String key)
Returns a user-defined property previously set via 'setUserProperty'. Note that it is a caller responsibility to synchronize access to properties.

Since:
1.2

setUserProperty

public void setUserProperty(String key,
                            Object value)
Sets a user-defined property. Note that it is a caller responsibility to synchronize access to properties.

Since:
1.2

setChannel

public void setChannel(DataChannel channel)
Since:
1.2

getChannel

public DataChannel getChannel()
Description copied from interface: ObjectContext
Returns an DataChannel used by this context.

Specified by:
getChannel in interface ObjectContext
Overrides:
getChannel in class BaseContext

getParentDataDomain

public DataDomain getParentDataDomain()
Returns a DataDomain used by this DataContext. DataDomain is looked up in the DataChannel hierarchy. If a channel is not a DataDomain or a DataContext, null is returned.

Returns:
DataDomain that is a direct or indirect parent of this DataContext in the DataChannel hierarchy.
Since:
1.1

setDelegate

public void setDelegate(DataContextDelegate delegate)
Sets a DataContextDelegate for this context. Delegate is notified of certain events in the DataContext lifecycle and can customize DataContext behavior.

Since:
1.1

getDelegate

public DataContextDelegate getDelegate()
Returns a delegate currently associated with this DataContext.

Since:
1.1

getObjectStore

public ObjectStore getObjectStore()
Returns ObjectStore associated with this DataContext.


hasChanges

public boolean hasChanges()
Returns true if there are any modified, deleted or new objects registered with this DataContext, false otherwise.


newObjects

public Collection newObjects()
Returns a list of objects that are registered with this DataContext and have a state PersistenceState.NEW

Specified by:
newObjects in interface ObjectContext
Specified by:
newObjects in class BaseContext

deletedObjects

public Collection deletedObjects()
Returns a list of objects that are registered with this DataContext and have a state PersistenceState.DELETED

Specified by:
deletedObjects in interface ObjectContext
Specified by:
deletedObjects in class BaseContext

modifiedObjects

public Collection modifiedObjects()
Returns a list of objects that are registered with this DataContext and have a state PersistenceState.MODIFIED

Specified by:
modifiedObjects in interface ObjectContext
Specified by:
modifiedObjects in class BaseContext

uncommittedObjects

public Collection uncommittedObjects()
Returns a collection of all uncommitted registered objects.

Specified by:
uncommittedObjects in interface ObjectContext
Specified by:
uncommittedObjects in class BaseContext
Since:
1.2

currentSnapshot

public DataRow currentSnapshot(Persistent object)
Returns a DataRow reflecting current, possibly uncommitted, object state.

Warning: This method will return a partial snapshot if an object or one of its related objects that propagate their keys to this object have temporary ids. DO NOT USE this method if you expect a DataRow to represent a complete object state.

Since:
1.1

objectsFromDataRows

public List objectsFromDataRows(ObjEntity entity,
                                List dataRows,
                                boolean refresh,
                                boolean resolveInheritanceHierarchy)
Converts a list of data rows to a list of DataObjects.

Since:
1.1

objectsFromDataRows

public List objectsFromDataRows(Class objectClass,
                                List dataRows,
                                boolean refresh,
                                boolean resolveInheritanceHierarchy)
Converts a list of DataRows to a List of DataObject registered with this DataContext. Internally calls objectsFromDataRows(ObjEntity,List,boolean,boolean).

Since:
1.1
See Also:
DataRow

objectFromDataRow

public DataObject objectFromDataRow(Class objectClass,
                                    DataRow dataRow,
                                    boolean refresh)
Creates a DataObject from DataRow. This is a convenience shortcut to objectsFromDataRows(Class,java.util.List,boolean,boolean).

See Also:
DataRow

createAndRegisterNewObject

public DataObject createAndRegisterNewObject(String objEntityName)
Deprecated. since 3.0, use newObject(String) instead.


newObject

public Persistent newObject(Class persistentClass)
Creates and registers a new persistent object.

Specified by:
newObject in interface ObjectContext
Specified by:
newObject in class BaseContext
Since:
1.2

newObject

public Persistent newObject(String entityName)
Instantiates a new object and registers it with this context. Object class is determined from the mapped entity. Object class must have a default constructor.

Note: in most cases newObject(Class) method should be used, however this method is helpful when generic persistent classes are used.

Since:
3.0

createAndRegisterNewObject

public DataObject createAndRegisterNewObject(Class objectClass)
Deprecated. since 3.0, use newObject(Class) instead.

Instantiates new object and registers it with itself. Object class must have a default constructor.

Since:
1.1

registerNewObject

public void registerNewObject(Object object)
Registers a transient object with the context, recursively registering all transient persistent objects attached to this object via relationships.

Note that since 3.0 this method takes Object as an argument instead of a DataObject.

Specified by:
registerNewObject in interface ObjectContext
Specified by:
registerNewObject in class BaseContext
Parameters:
object - new object that needs to be made persistent.

unregisterObjects

public void unregisterObjects(Collection dataObjects)
Unregisters a Collection of DataObjects from the DataContext and the underlying ObjectStore. This operation also unsets DataContext and ObjectId for each object and changes its state to TRANSIENT.

See Also:
invalidateObjects(Collection)

invalidateObjects

public void invalidateObjects(Collection objects)
"Invalidates" a Collection of persistent objects. This operation would remove each object's snapshot from cache and change object's state to HOLLOW. On the next access to this object, it will be refetched.

See Also:
unregisterObjects(Collection), RefreshQuery

deleteObjects

public void deleteObjects(Collection objects)
Schedules all objects in the collection for deletion on the next commit of this DataContext. Object's persistence state is changed to PersistenceState.DELETED; objects related to this object are processed according to delete rules, i.e. relationships can be unset ("nullify" rule), deletion operation is cascaded (cascade rule).

"Nullify" delete rule side effect: passing a collection representing to-many relationship with nullify delete rule may result in objects being removed from collection.

Since:
1.2

deleteObject

public void deleteObject(Object object)
                  throws DeleteDenyException
Schedules an object for deletion on the next commit of this DataContext. Object's persistence state is changed to PersistenceState.DELETED; objects related to this object are processed according to delete rules, i.e. relationships can be unset ("nullify" rule), deletion operation is cascaded (cascade rule).

Specified by:
deleteObject in interface ObjectContext
Specified by:
deleteObject in class BaseContext
Parameters:
object - a persistent object that we want to delete.
Throws:
DeleteDenyException - if a DENY delete rule is applicable for object deletion.
NullPointerException - if object is null.

refetchObject

public DataObject refetchObject(ObjectId oid)
Deprecated. since 3.0 use ObjectIdQuery with appropraite refresh settings.

Refetches object data for ObjectId. This method is used internally by Cayenne to resolve objects in state PersistenceState.HOLLOW. It can also be used to refresh certain objects.

Throws:
CayenneRuntimeException - if object id doesn't match any records, or if there is more than one object is fetched.

rollbackChangesLocally

public void rollbackChangesLocally()
If the parent channel is a DataContext, reverts local changes to make this context look like the parent, if the parent channel is a DataDomain, reverts all changes.

Specified by:
rollbackChangesLocally in interface ObjectContext
Specified by:
rollbackChangesLocally in class BaseContext
Since:
1.2

rollbackChanges

public void rollbackChanges()
Reverts any changes that have occurred to objects registered with DataContext; also performs cascading rollback of all parent DataContexts.

Specified by:
rollbackChanges in interface ObjectContext
Specified by:
rollbackChanges in class BaseContext

commitChangesToParent

public void commitChangesToParent()
"Flushes" the changes to the parent DataChannel. If the parent channel is a DataContext, it updates its objects with this context's changes, without a database update. If it is a DataDomain (the most common case), the changes are written to the database. To cause cascading commit all the way to the database, one must use commitChanges().

Specified by:
commitChangesToParent in interface ObjectContext
Specified by:
commitChangesToParent in class BaseContext
Since:
1.2
See Also:
commitChanges()

commitChanges

public void commitChanges()
                   throws CayenneRuntimeException
Synchronizes object graph with the database. Executes needed insert, update and delete queries (generated internally).

Specified by:
commitChanges in interface ObjectContext
Specified by:
commitChanges in class BaseContext
Throws:
CayenneRuntimeException

getEventManager

public EventManager getEventManager()
Returns EventManager associated with the ObjectStore.

Specified by:
getEventManager in interface DataChannel
Since:
1.2

onSync

public GraphDiff onSync(ObjectContext originatingContext,
                        GraphDiff changes,
                        int syncType)
An implementation of a DataChannel method that is used by child contexts to synchronize state with this context. Not intended for direct use.

Specified by:
onSync in interface DataChannel
Parameters:
originatingContext - an ObjectContext that initiated the sync. Can be null.
changes - diff from the context that initiated the sync.
syncType - One of DataChannel.FLUSH_NOCASCADE_SYNC, DataChannel.FLUSH_CASCADE_SYNC, DataChannel.ROLLBACK_CASCADE_SYNC.
Since:
1.2

performIteratedQuery

public ResultIterator performIteratedQuery(Query query)
                                    throws CayenneException
Performs a single database select query returning result as a ResultIterator. It is caller's responsibility to explicitly close the ResultIterator. A failure to do so will result in a database connection not being released. Another side effect of an open ResultIterator is that an internal Cayenne transaction that originated in this method stays open until the iterator is closed. So users should normally close the iterator within the same thread that opened it.

Throws:
CayenneException

performGenericQuery

public QueryResponse performGenericQuery(Query query)
Executes a query returning a generic response.

Specified by:
performGenericQuery in interface ObjectContext
Specified by:
performGenericQuery in class BaseContext
Since:
1.2

performQuery

public List performQuery(Query query)
Performs a single selecting query. Various query setting control the behavior of this method and the results returned:

Since 1.2 takes any Query parameter, not just GenericSelectQuery

Specified by:
performQuery in interface ObjectContext
Specified by:
performQuery in class BaseContext
Returns:
A list of DataObjects or a DataRows, depending on the value returned by QueryMetadata.isFetchingDataRows().

onQuery

public QueryResponse onQuery(ObjectContext context,
                             Query query)
An implementation of a DataChannel method that is used by child contexts to execute queries. Not intended for direct use.

Specified by:
onQuery in interface DataChannel
Parameters:
context - an ObjectContext that originated the query, used to register result objects.
Returns:
a generic response object that encapsulates result of the execution.
Since:
1.2

performNonSelectingQuery

public int[] performNonSelectingQuery(Query query)
Performs a single database query that does not select rows. Returns an array of update counts.

Since:
1.1

performNonSelectingQuery

public int[] performNonSelectingQuery(String queryName)
Performs a named mapped query that does not select rows. Returns an array of update counts.

Since:
1.1

performNonSelectingQuery

public int[] performNonSelectingQuery(String queryName,
                                      Map parameters)
Performs a named mapped non-selecting query using a map of parameters. Returns an array of update counts.

Since:
1.1

performQuery

public List performQuery(String queryName,
                         boolean expireCachedLists)
Returns a list of objects or DataRows for a named query stored in one of the DataMaps. Internally Cayenne uses a caching policy defined in the named query. If refresh flag is true, a refresh is forced no matter what the caching policy is.

Parameters:
queryName - a name of a GenericSelectQuery defined in one of the DataMaps. If no such query is defined, this method will throw a CayenneRuntimeException.
expireCachedLists - A flag that determines whether refresh of cached lists is required in case a query uses caching.
Since:
1.1

performQuery

public List performQuery(String queryName,
                         Map parameters,
                         boolean expireCachedLists)
Returns a list of objects or DataRows for a named query stored in one of the DataMaps. Internally Cayenne uses a caching policy defined in the named query. If refresh flag is true, a refresh is forced no matter what the caching policy is.

Parameters:
queryName - a name of a GenericSelectQuery defined in one of the DataMaps. If no such query is defined, this method will throw a CayenneRuntimeException.
parameters - A map of parameters to use with stored query.
expireCachedLists - A flag that determines whether refresh of cached lists is required in case a query uses caching.
Since:
1.1

getEntityResolver

public EntityResolver getEntityResolver()
Returns EntityResolver. EntityResolver can be null if DataContext has not been attached to an DataChannel.

Specified by:
getEntityResolver in interface DataChannel
Specified by:
getEntityResolver in interface ObjectContext
Specified by:
getEntityResolver in class BaseContext

setTransactionEventsEnabledDefault

public static void setTransactionEventsEnabledDefault(boolean flag)
Deprecated. since 3.0M1 in favor of LifecycleListener. Will be removed in later 3.0 milestones.

Sets default for posting transaction events by new DataContexts.


setTransactionEventsEnabled

public void setTransactionEventsEnabled(boolean flag)
Deprecated. since 3.0M1 in favor of LifecycleListener. Will be removed in later 3.0 milestones.

Enables or disables posting of transaction events by this DataContext.


isTransactionEventsEnabled

public boolean isTransactionEventsEnabled()
Deprecated. since 3.0M1 in favor of LifecycleListener. Will be removed in later 3.0 milestones.


isUsingSharedSnapshotCache

public boolean isUsingSharedSnapshotCache()
Returns true if the ObjectStore uses shared cache of a parent DataDomain.

Since:
1.1

isValidatingObjectsOnCommit

public boolean isValidatingObjectsOnCommit()
Returns whether this DataContext performs object validation before commit is executed.

Since:
1.1

setValidatingObjectsOnCommit

public void setValidatingObjectsOnCommit(boolean flag)
Sets the property defining whether this DataContext should perform object validation before commit is executed.

Since:
1.1

propertyChanged

public void propertyChanged(Persistent object,
                            String property,
                            Object oldValue,
                            Object newValue)
Description copied from interface: ObjectContext
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.

Specified by:
propertyChanged in interface ObjectContext
Specified by:
propertyChanged in class BaseContext
Since:
1.2

getGraphManager

public GraphManager getGraphManager()
Returns this context's ObjectStore.

Specified by:
getGraphManager in interface ObjectContext
Specified by:
getGraphManager in class BaseContext
Since:
1.2

localObject

public Persistent localObject(ObjectId id,
                              Object prototype)
Returns an object local to this DataContext and matching the ObjectId. If prototype is not null, local object is refreshed with the prototype values.

In case you pass a non-null second parameter, you are responsible for setting correct persistence state of the returned local object, as generally there is no way for Cayenne to determine the resulting local object state.

Specified by:
localObject in interface ObjectContext
Specified by:
localObject in class BaseContext
Since:
1.2


Copyright © 2001-2007 Apache Cayenne. All Rights Reserved.