|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.apache.cayenne.CayenneContext
public class CayenneContext
A default generic implementation of ObjectContext suitable for accessing Cayenne from
either an ORM or a client tiers. Communicates with Cayenne via a
DataChannel.
| Field Summary | |
|---|---|
protected DataChannel |
channel
|
protected EntityResolver |
entityResolver
|
| Constructor Summary | |
|---|---|
CayenneContext()
Creates a new CayenneContext with no channel and disabled graph events. |
|
CayenneContext(DataChannel channel)
Creates a new CayenneContext, initializaing it with a channel instance. |
|
CayenneContext(DataChannel channel,
boolean changeEventsEnabled,
boolean syncEventsEnabled)
Creates a new CayenneContext, initializaing it with a channel. |
|
| Method Summary | |
|---|---|
void |
commitChanges()
Commits changes to uncommitted objects. |
void |
commitChangesToParent()
Flushes all changes to objects in this context to the parent DataChannel. |
java.util.Collection |
deletedObjects()
Returns a collection of objects that are registered with this ObjectContext and have a state PersistenceState.DELETED |
void |
deleteObject(Persistent object)
Deletes an object locally, scheduling it for future deletion from the external data store. |
DataChannel |
getChannel()
Returns an DataChannel used by this context. |
EntityResolver |
getEntityResolver()
Returns an EntityResolver that provides mapping information needed for CayenneContext operation. |
GraphManager |
getGraphManager()
Returns GraphManager that manages object graph associated with this context. |
boolean |
isChangeEventsEnabled()
Returns true if this context posts individual object modification events. |
boolean |
isLifecycleEventsEnabled()
Returns true if this context posts lifecycle events. |
Persistent |
localObject(ObjectId id,
Persistent prototype)
Converts a list of Persistent objects registered in some other ObjectContext to a list of objects local to this ObjectContext. |
java.util.Collection |
modifiedObjects()
Returns a collection of objects that are registered with this ObjectContext and have a state PersistenceState.MODIFIED |
Persistent |
newObject(java.lang.Class persistentClass)
Creates and registers a new Persistent object instance. |
java.util.Collection |
newObjects()
Returns a collection of objects that are registered with this ObjectContext and have a state PersistenceState.NEW |
QueryResponse |
performGenericQuery(Query query)
Executes any kind of query providing the result in a form of QueryResponse. |
java.util.List |
performQuery(Query query)
Runs a query, returning result as list. |
void |
prepareForAccess(Persistent object,
java.lang.String property)
Resolves an object if it is HOLLOW. |
void |
propertyChanged(Persistent object,
java.lang.String property,
java.lang.Object oldValue,
java.lang.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. |
void |
rollbackChanges()
Resets all uncommitted changes made to the objects in this ObjectContext, cascading rollback operation all the way through the stack. |
void |
rollbackChangesLocally()
Resets all uncommitted changes made to the objects in this ObjectContext. |
void |
setChannel(DataChannel channel)
Sets the context channel, setting up a listener for channel events. |
void |
setEntityResolver(EntityResolver entityResolver)
|
java.util.Collection |
uncommittedObjects()
Returns a collection of MODIFIED, DELETED or NEW objects. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
protected transient DataChannel channel
protected EntityResolver entityResolver
| Constructor Detail |
|---|
public CayenneContext()
public CayenneContext(DataChannel channel)
public CayenneContext(DataChannel channel,
boolean changeEventsEnabled,
boolean syncEventsEnabled)
graphEventsEnabled is true, this context will broadcast GraphEvents
using ObjectContext.GRAPH_CHANGE_SUBJECT.
| Method Detail |
|---|
public DataChannel getChannel()
ObjectContext
getChannel in interface ObjectContextpublic void setChannel(DataChannel channel)
public boolean isChangeEventsEnabled()
ObjectContext.GRAPH_CHANGED_SUBJECT.
public boolean isLifecycleEventsEnabled()
ObjectContext.GRAPH_COMMIT_STARTED_SUBJECT, ObjectContext.GRAPH_COMMITTED_SUBJECT,
ObjectContext.GRAPH_COMMIT_ABORTED_SUBJECT, ObjectContext.GRAPH_ROLLEDBACK_SUBJECT..
public EntityResolver getEntityResolver()
getEntityResolver in interface ObjectContextpublic void setEntityResolver(EntityResolver entityResolver)
public GraphManager getGraphManager()
ObjectContext
getGraphManager in interface ObjectContextpublic void commitChanges()
commitChanges in interface ObjectContextpublic void rollbackChanges()
ObjectContext
rollbackChanges in interface ObjectContextpublic void commitChangesToParent()
ObjectContextObjectContext.commitChanges(), but no cascading flush occurs.
commitChangesToParent in interface ObjectContextpublic void rollbackChangesLocally()
ObjectContextObjectContext.rollbackChanges()(), but rollback is local to this context and no
cascading changes undoing occurs.
rollbackChangesLocally in interface ObjectContextpublic void deleteObject(Persistent object)
deleteObject in interface ObjectContextpublic Persistent newObject(java.lang.Class persistentClass)
newObject in interface ObjectContextpublic java.util.List performQuery(Query query)
performQuery in interface ObjectContextpublic QueryResponse performGenericQuery(Query query)
ObjectContext
performGenericQuery in interface ObjectContext
public Persistent localObject(ObjectId id,
Persistent prototype)
Current limitation: all objects in the source list must be either in COMMITTED or in HOLLOW state.
localObject in interface ObjectContext
public void prepareForAccess(Persistent object,
java.lang.String property)
prepareForAccess in interface ObjectContext
public void propertyChanged(Persistent object,
java.lang.String property,
java.lang.Object oldValue,
java.lang.Object newValue)
ObjectContext
propertyChanged in interface ObjectContextpublic java.util.Collection uncommittedObjects()
ObjectContext
uncommittedObjects in interface ObjectContextpublic java.util.Collection deletedObjects()
ObjectContext
deletedObjects in interface ObjectContextpublic java.util.Collection modifiedObjects()
ObjectContext
modifiedObjects in interface ObjectContextpublic java.util.Collection newObjects()
ObjectContext
newObjects in interface ObjectContext
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||