|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.cayenne.BaseContext
org.apache.cayenne.access.DataContext
public class DataContext
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.
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 |
---|
public static final EventSubject WILL_COMMIT
public static final EventSubject DID_COMMIT
public static final EventSubject DID_ROLLBACK
protected static final ThreadLocal threadDataContext
protected boolean usingSharedSnaphsotCache
protected boolean validatingObjectsOnCommit
protected ObjectStore objectStore
protected QueryCache queryCache
protected transient EntityResolver entityResolver
protected transient org.apache.cayenne.access.DataContextMergeHandler mergeHandler
protected Map userProperties
protected transient String lazyInitParentDomainName
Constructor Detail |
---|
public DataContext()
public DataContext(DataChannel channel, ObjectStore objectStore)
Method Detail |
---|
public static DataContext getThreadDataContext() throws IllegalStateException
IllegalStateException
- if there is no DataContext bound to the current
thread.WebApplicationContextFilter
public static void bindThreadDataContext(DataContext context)
getThreadDataContext()
.
Using null parameter will unbind currently bound DataContext.
public static DataContext createDataContext()
createDataContext(String)
must be used instead. ObjectStore
associated with created DataContext will have a cache stack configured using parent
domain settings.
public static DataContext createDataContext(boolean useSharedCache)
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.
public static DataContext createDataContext(String domainName)
public static DataContext createDataContext(String domainName, boolean useSharedCache)
public QueryCache getQueryCache()
QueryCache
used by this DataContext, creating it on the fly if
needed. Uses parent DataDomain QueryCacheFactory
to initialize the cache
for the first time.
public void setQueryCache(QueryCache queryCache)
protected Map getUserProperties()
public DataContext createChildDataContext()
public Object getUserProperty(String key)
public void setUserProperty(String key, Object value)
public void setChannel(DataChannel channel)
public DataChannel getChannel()
ObjectContext
getChannel
in interface ObjectContext
getChannel
in class BaseContext
public DataDomain getParentDataDomain()
public void setDelegate(DataContextDelegate delegate)
public DataContextDelegate getDelegate()
public ObjectStore getObjectStore()
public boolean hasChanges()
true
if there are any modified, deleted or new objects
registered with this DataContext, false
otherwise.
public Collection newObjects()
newObjects
in interface ObjectContext
newObjects
in class BaseContext
public Collection deletedObjects()
deletedObjects
in interface ObjectContext
deletedObjects
in class BaseContext
public Collection modifiedObjects()
modifiedObjects
in interface ObjectContext
modifiedObjects
in class BaseContext
public Collection uncommittedObjects()
uncommittedObjects
in interface ObjectContext
uncommittedObjects
in class BaseContext
public DataRow currentSnapshot(Persistent object)
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.
public List objectsFromDataRows(ObjEntity entity, List dataRows, boolean refresh, boolean resolveInheritanceHierarchy)
public List objectsFromDataRows(Class objectClass, List dataRows, boolean refresh, boolean resolveInheritanceHierarchy)
objectsFromDataRows(ObjEntity,List,boolean,boolean)
.
DataRow
public DataObject objectFromDataRow(Class objectClass, DataRow dataRow, boolean refresh)
objectsFromDataRows(Class,java.util.List,boolean,boolean)
.
DataRow
public DataObject createAndRegisterNewObject(String objEntityName)
newObject(String)
instead.
public Persistent newObject(Class persistentClass)
newObject
in interface ObjectContext
newObject
in class BaseContext
public Persistent newObject(String entityName)
newObject(Class)
method should be used,
however this method is helpful when generic persistent classes are used.
public DataObject createAndRegisterNewObject(Class objectClass)
newObject(Class)
instead.
public void registerNewObject(Object object)
DataObject
.
registerNewObject
in interface ObjectContext
registerNewObject
in class BaseContext
object
- new object that needs to be made persistent.public void unregisterObjects(Collection dataObjects)
invalidateObjects(Collection)
public void invalidateObjects(Collection objects)
unregisterObjects(Collection)
,
RefreshQuery
public void deleteObjects(Collection objects)
"Nullify" delete rule side effect: passing a collection representing to-many relationship with nullify delete rule may result in objects being removed from collection.
public void deleteObject(Object object) throws DeleteDenyException
deleteObject
in interface ObjectContext
deleteObject
in class BaseContext
object
- a persistent object that we want to delete.
DeleteDenyException
- if a DENY delete rule is applicable for object
deletion.
NullPointerException
- if object is null.public DataObject refetchObject(ObjectId oid)
ObjectIdQuery
with appropraite refresh settings.
PersistenceState.HOLLOW
. It can also be
used to refresh certain objects.
CayenneRuntimeException
- if object id doesn't match any records, or if there
is more than one object is fetched.public void rollbackChangesLocally()
rollbackChangesLocally
in interface ObjectContext
rollbackChangesLocally
in class BaseContext
public void rollbackChanges()
rollbackChanges
in interface ObjectContext
rollbackChanges
in class BaseContext
public void commitChangesToParent()
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()
.
commitChangesToParent
in interface ObjectContext
commitChangesToParent
in class BaseContext
commitChanges()
public void commitChanges() throws CayenneRuntimeException
commitChanges
in interface ObjectContext
commitChanges
in class BaseContext
CayenneRuntimeException
public EventManager getEventManager()
getEventManager
in interface DataChannel
public GraphDiff onSync(ObjectContext originatingContext, GraphDiff changes, int syncType)
DataChannel
method that is used by child contexts to
synchronize state with this context. Not intended for direct use.
onSync
in interface DataChannel
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
.public ResultIterator performIteratedQuery(Query query) throws CayenneException
CayenneException
public QueryResponse performGenericQuery(Query query)
performGenericQuery
in interface ObjectContext
performGenericQuery
in class BaseContext
public List performQuery(Query query)
Since 1.2 takes any Query parameter, not just GenericSelectQuery
performQuery
in interface ObjectContext
performQuery
in class BaseContext
QueryMetadata.isFetchingDataRows()
.public QueryResponse onQuery(ObjectContext context, Query query)
DataChannel
method that is used by child contexts to
execute queries. Not intended for direct use.
onQuery
in interface DataChannel
context
- an ObjectContext that originated the query, used to
register result objects.
public int[] performNonSelectingQuery(Query query)
public int[] performNonSelectingQuery(String queryName)
public int[] performNonSelectingQuery(String queryName, Map parameters)
public List performQuery(String queryName, boolean expireCachedLists)
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.public List performQuery(String queryName, Map parameters, boolean expireCachedLists)
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.public EntityResolver getEntityResolver()
getEntityResolver
in interface DataChannel
getEntityResolver
in interface ObjectContext
getEntityResolver
in class BaseContext
public static void setTransactionEventsEnabledDefault(boolean flag)
LifecycleListener
. Will be removed in
later 3.0 milestones.
public void setTransactionEventsEnabled(boolean flag)
LifecycleListener
. Will be removed in
later 3.0 milestones.
public boolean isTransactionEventsEnabled()
LifecycleListener
. Will be removed in
later 3.0 milestones.
public boolean isUsingSharedSnapshotCache()
true
if the ObjectStore uses shared cache of a parent
DataDomain.
public boolean isValidatingObjectsOnCommit()
public void setValidatingObjectsOnCommit(boolean flag)
public void propertyChanged(Persistent object, String property, Object oldValue, Object newValue)
ObjectContext
propertyChanged
in interface ObjectContext
propertyChanged
in class BaseContext
public GraphManager getGraphManager()
getGraphManager
in interface ObjectContext
getGraphManager
in class BaseContext
public Persistent localObject(ObjectId id, Object prototype)
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.
localObject
in interface ObjectContext
localObject
in class BaseContext
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |