org.apache.cayenne

Class CayenneContext

java.lang.Object

org.apache.cayenne.BaseContext

org.apache.cayenne.CayenneContext

All Implemented Interfaces:

Serializable, DataChannel, ObjectContext

public class CayenneContext
extends BaseContext

A default generic implementation of ObjectContext suitable for accessing Cayenne from either an ORM or a client tiers. Communicates with Cayenne via a DataChannel.

Since:

1.2

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.cayenne.BaseContext

channel, entityResolver, graphAction, queryCache, threadObjectContext, userProperties, validatingObjectsOnCommit

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

Constructors

Constructor and Description
CayenneContext() Creates a new CayenneContext with no channel and disabled graph events.
CayenneContext(DataChannel channel) Creates a new CayenneContext, initializing it with a channel instance.
CayenneContext(DataChannel channel, boolean changeEventsEnabled, boolean lifecyleEventsEnabled) Creates a new CayenneContext, initializing it with a channel.

Method Summary

Modifier and Type	Method and Description
protected void	attachToChannel(DataChannel channel)
void	commitChanges() Commits changes to uncommitted objects.
void	commitChangesToParent()
Collection<?>	deletedObjects()
GraphManager	getGraphManager()
boolean	hasChanges() Returns true if there are any modified, deleted or new objects registered with this CayenneContext, false otherwise.
boolean	isChangeEventsEnabled() Returns true if this context posts individual object modification events.
boolean	isLifecycleEventsEnabled() Returns true if this context posts lifecycle events.
<T> ResultIterator<T>	iterator(Select<T> query) This method simply returns an iterator over a list of selected objects.
Collection<?>	modifiedObjects()
<T> T	newObject(Class<T> persistentClass) Creates and registers a new Persistent object instance.
Collection<?>	newObjects()
protected GraphDiff	onContextFlush(ObjectContext originatingContext, GraphDiff changes, boolean cascade)
QueryResponse	onQuery(ObjectContext context, Query query)
QueryResponse	performGenericQuery(Query query)
List	performQuery(Query query) Runs a query, returning result as list.
void	registerNewObject(Object object)
void	rollbackChanges()
void	rollbackChangesLocally()
Collection<?>	uncommittedObjects()

Methods inherited from class org.apache.cayenne.BaseContext

attachToRuntime, attachToRuntimeIfNeeded, batchIterator, bindThreadObjectContext, deleteObject, deleteObjects, deleteObjects, fireDataChannelChanged, fireDataChannelCommitted, fireDataChannelRolledback, getChannel, getEntityResolver, getEventManager, getQueryCache, getThreadObjectContext, getUserProperties, getUserProperty, injectInitialValue, invalidateObjects, invalidateObjects, isValidatingObjectsOnCommit, iterate, localObject, onSync, prepareForAccess, propertyChanged, select, selectFirst, selectOne, setChannel, setEntityResolver, setQueryCache, setUserProperty, setValidatingObjectsOnCommit

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CayenneContext

public CayenneContext()

Creates a new CayenneContext with no channel and disabled graph events.

CayenneContext

public CayenneContext(DataChannel channel)

Creates a new CayenneContext, initializing it with a channel instance. CayenneContext created using this constructor WILL NOT broadcast graph change events.

CayenneContext

public CayenneContext(DataChannel channel,
                      boolean changeEventsEnabled,
                      boolean lifecyleEventsEnabled)

Creates a new CayenneContext, initializing it with a channel.

Method Detail

attachToChannel

protected void attachToChannel(DataChannel channel)

Overrides:

attachToChannel in class BaseContext

Since:

3.1

isChangeEventsEnabled

public boolean isChangeEventsEnabled()

Returns true if this context posts individual object modification events. Subject used for these events is ObjectContext.GRAPH_CHANGED_SUBJECT.

isLifecycleEventsEnabled

public boolean isLifecycleEventsEnabled()

Returns true if this context posts lifecycle events. Subjects used for these events are ObjectContext.GRAPH_COMMIT_STARTED_SUBJECT, ObjectContext.GRAPH_COMMITTED_SUBJECT, ObjectContext.GRAPH_COMMIT_ABORTED_SUBJECT, ObjectContext.GRAPH_ROLLEDBACK_SUBJECT. .

getGraphManager

public GraphManager getGraphManager()

Specified by:

getGraphManager in interface ObjectContext

Specified by:

getGraphManager in class BaseContext

commitChanges

public void commitChanges()

Commits changes to uncommitted objects. First checks if there are changes in this context and if any changes are detected, sends a commit message to remote Cayenne service via an internal instance of CayenneConnector.

Specified by:

commitChanges in interface ObjectContext

Specified by:

commitChanges in class BaseContext

commitChangesToParent

public void commitChangesToParent()

Specified by:

commitChangesToParent in interface ObjectContext

Specified by:

commitChangesToParent in class BaseContext

rollbackChanges

public void rollbackChanges()

Specified by:

rollbackChanges in interface ObjectContext

Specified by:

rollbackChanges in class BaseContext

rollbackChangesLocally

public void rollbackChangesLocally()

Specified by:

rollbackChangesLocally in interface ObjectContext

Specified by:

rollbackChangesLocally in class BaseContext

newObject

public <T> T newObject(Class<T> persistentClass)

Creates and registers a new Persistent object instance.

Specified by:

newObject in interface ObjectContext

Specified by:

newObject in class BaseContext

registerNewObject

public void registerNewObject(Object object)

Specified by:

registerNewObject in interface ObjectContext

Specified by:

registerNewObject in class BaseContext

Since:

3.0

performQuery

public List performQuery(Query query)

Runs a query, returning result as list.

Specified by:

performQuery in interface ObjectContext

Specified by:

performQuery in class BaseContext

performGenericQuery

public QueryResponse performGenericQuery(Query query)

Specified by:

performGenericQuery in interface ObjectContext

Specified by:

performGenericQuery in class BaseContext

onQuery

public QueryResponse onQuery(ObjectContext context,
                             Query query)

uncommittedObjects

public Collection<?> uncommittedObjects()

Specified by:

uncommittedObjects in interface ObjectContext

Specified by:

uncommittedObjects in class BaseContext

deletedObjects

public Collection<?> deletedObjects()

Specified by:

deletedObjects in interface ObjectContext

Specified by:

deletedObjects in class BaseContext

modifiedObjects

public Collection<?> modifiedObjects()

Specified by:

modifiedObjects in interface ObjectContext

Specified by:

modifiedObjects in class BaseContext

newObjects

public Collection<?> newObjects()

Specified by:

newObjects in interface ObjectContext

Specified by:

newObjects in class BaseContext

onContextFlush

protected GraphDiff onContextFlush(ObjectContext originatingContext,
                                   GraphDiff changes,
                                   boolean cascade)

Specified by:

onContextFlush in class BaseContext

hasChanges

public boolean hasChanges()

Returns true if there are any modified, deleted or new objects registered with this CayenneContext, false otherwise.

iterator

public <T> ResultIterator<T> iterator(Select<T> query)

This method simply returns an iterator over a list of selected objects. There's no performance benefit of using it vs. regular "select".

Specified by:

iterator in interface ObjectContext

Specified by:

iterator in class BaseContext

Since:

4.0