org.granite.client.tide.data.impl

Class EntityManagerImpl

java.lang.Object

org.granite.client.tide.data.impl.EntityManagerImpl

All Implemented Interfaces:

EntityManager

public class EntityManagerImpl
extends java.lang.Object
implements EntityManager

Author:

William DRAI

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	EntityManagerImpl.DefaultTrackingHandler

Nested classes/interfaces inherited from interface org.granite.client.tide.data.EntityManager

EntityManager.Function, EntityManager.Propagation, EntityManager.PropagationPolicy, EntityManager.Update, EntityManager.UpdateKind

Constructor Summary

Constructors

Constructor and Description
EntityManagerImpl(java.lang.String id, DataManager dataManager)

Method Summary

Methods

Modifier and Type	Method and Description
void	acceptConflict(Conflict conflict, boolean client) Accept values for conflict
void	addListener(DataConflictListener listener) Register a listener for data conflicts
void	addReference(java.lang.Object obj, java.lang.Object parent, java.lang.String propName) Register a reference to the provided object with either a parent or res
void	attach(java.lang.Object object) Attach an entity graph in the current entity manager
void	attachEntity(java.lang.Object entity) Attach an entity to this context
void	attachEntity(java.lang.Object entity, boolean putInCache) Attach an entity to this context
void	clear() Clear the current context Destroys all components/context variables
void	clearCache() Clears entity cache
void	defaultMerge(MergeContext mergeContext, java.lang.Object obj, java.lang.Object dest, java.lang.Object parent, java.lang.String propertyName) Default implementation of entity merge for simple ActionScript beans with public properties Can be used to implement Tide managed entities with simple objects
void	detach(java.lang.Object object, java.util.IdentityHashMap<java.lang.Object,java.lang.Object> cache, boolean forceRemove) Internal implementation of object detach
void	detachEntity(java.lang.Object entity, boolean removeFromCache, boolean forceRemove) Detach an entity from this context
java.lang.Object	getCachedObject(java.lang.Object object, boolean nullIfAbsent) Retrieve an entity in the cache from its uid
DataManager	getDataManager() Data manager for this entity manager
java.lang.String	getId() Return the entity manager id
java.util.List<java.lang.Object[]>	getOwnerEntities(java.lang.Object object) Retrieve the owner entity of the provided object (collection/map/entity)
java.lang.Object[]	getOwnerEntity(java.lang.Object object) Retrieve the owner entity of the provided object (collection/map/entity)
java.util.Map<java.lang.Object,java.util.Map<java.lang.String,java.lang.Object>>	getSavedProperties() Current map of saved properties for the the context
java.util.Map<java.lang.String,java.lang.Object>	getSavedProperties(java.lang.Object entity) Current map of saved properties for the specified entity
DataManager.TrackingHandler	getTrackingHandler() Tracking handler for this entity manager
void	handleMergeConflicts(MergeContext mergeContext) Dispatch an event when last merge generated conflicts
void	handleRemovalsAndPersists(MergeContext mergeContext, java.util.List<java.lang.Object> removals, java.util.List<java.lang.Object> persists) Remove elements from cache and managed collections
void	handleUpdates(MergeContext mergeContext, java.lang.String sourceSessionId, java.util.List<EntityManager.Update> updates) Handle data updates
boolean	initializeObject(ServerSession serverSession, java.lang.Object entity, java.lang.String propertyName, java.lang.Object object) Trigger remote initialization of lazy-loaded objects
MergeContext	initMerge(ServerSession serverSession) Initialize the merge context in the current thread MergeContext should be released at the end of the process
java.lang.Object	internalMergeExternalData(MergeContext mergeContext, java.lang.Object obj, java.lang.Object prev, java.util.List<java.lang.Object> removals, java.util.List<java.lang.Object> persists) Merge an object coming from a remote location (in general from a service) in the local context
boolean	isActive() Return the entity manager state
boolean	isDeepDirtyEntity(java.lang.Object entity) Entity is deep dirty when any element in its object graph has been modified
boolean	isDirty() Entity manager is dirty when any entity/collection/map has been modified
boolean	isDirtyEntity(java.lang.Object entity) Entity is dirty when any direct property has been modified
boolean	isEntityChanged(java.lang.Object entity)
boolean	isEntityDeepChanged(java.lang.Object entity)
boolean	isPersisted(java.lang.Object entity) Indicates if the entity is persisted on the server (id/version not null/NaN)
boolean	isSavedEntity(java.lang.Object entity)
static boolean	isSimple(java.lang.Object object)
boolean	isUninitializeAllowed() Allow uninitialize of persistent collections ?
java.lang.Object	mergeExternal(MergeContext mergeContext, java.lang.Object obj, java.lang.Object previous, java.lang.Object parent, java.lang.String propertyName, boolean forceUpdate) Merge an object coming from the server in the context
java.lang.Object	mergeExternalData(java.lang.Object obj) Merge an object coming from a remote location (in general from a service) in the local context
java.lang.Object	mergeExternalData(java.lang.Object obj, java.lang.Object prev, java.lang.String externalDataSessionId, java.util.List<java.lang.Object> removals, java.util.List<java.lang.Object> persists) Merge an object coming from a remote location (in general from a service) in the local context
java.lang.Object	mergeExternalData(ServerSession serverSession, java.lang.Object obj) Merge an object coming from a remote location (in general from a service) in the local context
java.lang.Object	mergeExternalData(ServerSession serverSession, java.lang.Object obj, java.lang.Object prev, java.lang.String externalDataSessionId, java.util.List<java.lang.Object> removals, java.util.List<java.lang.Object> persists) Merge an object coming from a remote location (in general from a service) in the local context
java.lang.Object	mergeFromEntityManager(EntityManager sourceEntityManager, ServerSession serverSession, java.lang.Object obj, java.lang.String externalDataSessionId, boolean uninitializing) Merge an object coming from another entity manager (in general in the global context) in the local context
void	mergeInEntityManager(EntityManager entityManager, ServerSession serverSession) Merge conversation entity manager context variables in global entity manager Only applicable to conversation contexts
protected java.lang.Object	mergePersistentCollection(MergeContext mergeContext, org.granite.client.persistence.collection.PersistentCollection<?> coll, java.lang.Object previous, java.lang.Object parent, java.lang.String propertyName) Wraps a persistent collection to manage lazy initialization
EntityManager	newTemporaryEntityManager() Create a new temporary entity manager
void	raiseUpdateEvents(Context context, java.util.List<EntityManager.Update> updates) Dispatch update events on the context
void	removeListener(DataConflictListener listener) Unregister a listener for data conflicts
boolean	removeReference(java.lang.Object obj, java.lang.Object parent, java.lang.String propName) Remove a reference on the provided object
void	resetAllEntities() Discard changes of all cached entities from last version received from the server
void	resetEntity(java.lang.Object entity) Discard changes of entity from last version received from the server
void	resolveMergeConflicts(MergeContext mergeContext, java.lang.Object modifiedEntity, java.lang.Object localEntity, boolean resolving) Resolve merge conflicts
void	setActive(boolean active) Setter for active flag When EntityManager is not active, dirty checking is disabled
void	setCustomMergers(DataMerger[] customMergers) Setter for the array of custom mergers
void	setDirtyCheckContext(DirtyCheckContext dirtyCheckContext) Setter for dirty check context implementation
void	setEntityManagerPropagation(EntityManager.Propagation propagation) Setter for the propagation manager
void	setRemoteInitializer(RemoteInitializer remoteInitializer) Setter for the remote initializer implementation
void	setRemoteValidator(RemoteValidator remoteValidator) Setter for the remote validator implementation
void	setUninitializeAllowed(boolean uninitializeAllowed) Allow uninitialize of persistent collections
boolean	validateObject(java.lang.Object object, java.lang.String property, java.lang.Object value) Trigger remote validation of objects

Methods inherited from class java.lang.Object

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

Constructor Detail

EntityManagerImpl

public EntityManagerImpl(java.lang.String id,
                 DataManager dataManager)

Method Detail

getId

public java.lang.String getId()

Return the entity manager id

Specified by:

getId in interface EntityManager

Returns:

the entity manager id

isActive

public boolean isActive()

Return the entity manager state

Specified by:

isActive in interface EntityManager

Returns:

the entity manager state

clear

public void clear()

Clear the current context Destroys all components/context variables

Specified by:

clear in interface EntityManager

clearCache

public void clearCache()

Clears entity cache

Specified by:

clearCache in interface EntityManager

getDataManager

public DataManager getDataManager()

Description copied from interface: EntityManager

Data manager for this entity manager

Specified by:

getDataManager in interface EntityManager

Returns:

data manager

getTrackingHandler

public DataManager.TrackingHandler getTrackingHandler()

Description copied from interface: EntityManager

Tracking handler for this entity manager

Specified by:

getTrackingHandler in interface EntityManager

Returns:

tracking handler

setCustomMergers

public void setCustomMergers(DataMerger[] customMergers)

Setter for the array of custom mergers

Parameters:

customMergers - array of mergers

setUninitializeAllowed

public void setUninitializeAllowed(boolean uninitializeAllowed)

Description copied from interface: EntityManager

Allow uninitialize of persistent collections

Specified by:

setUninitializeAllowed in interface EntityManager

Parameters:

uninitializeAllowed - allow uninitialize of collections

isUninitializeAllowed

public boolean isUninitializeAllowed()

Description copied from interface: EntityManager

Allow uninitialize of persistent collections ?

Specified by:

isUninitializeAllowed in interface EntityManager

Returns:

allow uninitialize of collections

setEntityManagerPropagation

public void setEntityManagerPropagation(EntityManager.Propagation propagation)

Setter for the propagation manager

Specified by:

setEntityManagerPropagation in interface EntityManager

Parameters:

propagation - propagation function that will visit child entity managers

setActive

public void setActive(boolean active)

Setter for active flag When EntityManager is not active, dirty checking is disabled

Parameters:

active - state

setDirtyCheckContext

public void setDirtyCheckContext(DirtyCheckContext dirtyCheckContext)

Setter for dirty check context implementation

Parameters:

dirtyCheckContext - dirty check context implementation

newTemporaryEntityManager

public EntityManager newTemporaryEntityManager()

Create a new temporary entity manager

Specified by:

newTemporaryEntityManager in interface EntityManager

Returns:

a temporary entity manager

attachEntity

public void attachEntity(java.lang.Object entity)

Attach an entity to this context

Parameters:

entity - an entity

attachEntity

public void attachEntity(java.lang.Object entity,
                boolean putInCache)

Attach an entity to this context

Parameters:

entity - an entity

putInCache - put entity in cache

detachEntity

public void detachEntity(java.lang.Object entity,
                boolean removeFromCache,
                boolean forceRemove)

Detach an entity from this context

Parameters:

entity - an entity

removeFromCache - remove entity from cache

forceRemove - remove even if persistent

attach

public void attach(java.lang.Object object)

Description copied from interface: EntityManager

Attach an entity graph in the current entity manager

Specified by:

attach in interface EntityManager

isSimple

public static boolean isSimple(java.lang.Object object)

isPersisted

public boolean isPersisted(java.lang.Object entity)

Indicates if the entity is persisted on the server (id/version not null/NaN)

Specified by:

isPersisted in interface EntityManager

Parameters:

entity - an entity

Returns:

true if saved

detach

public void detach(java.lang.Object object,
          java.util.IdentityHashMap<java.lang.Object,java.lang.Object> cache,
          boolean forceRemove)

Internal implementation of object detach

Parameters:

object - object

cache - internal cache to avoid graph loops

forceRemove - force removal even if persisted

getCachedObject

public java.lang.Object getCachedObject(java.lang.Object object,
                               boolean nullIfAbsent)

Retrieve an entity in the cache from its uid

Specified by:

getCachedObject in interface EntityManager

Parameters:

object - an entity

nullIfAbsent - return null if entity not cached in context

Returns:

cached object with the same uid as the specified object

getOwnerEntity

public java.lang.Object[] getOwnerEntity(java.lang.Object object)

Retrieve the owner entity of the provided object (collection/map/entity)

Specified by:

getOwnerEntity in interface EntityManager

Parameters:

object - an entity

Returns:

array containing owner entity and property name

getOwnerEntities

public java.util.List<java.lang.Object[]> getOwnerEntities(java.lang.Object object)

Retrieve the owner entity of the provided object (collection/map/entity)

Parameters:

object - an entity

Returns:

list of arrays containing owner and property name

addReference

public void addReference(java.lang.Object obj,
                java.lang.Object parent,
                java.lang.String propName)

Register a reference to the provided object with either a parent or res

Specified by:

addReference in interface EntityManager

Parameters:

obj - an entity

parent - the parent entity

propName - name of the parent entity property that references the entity

removeReference

public boolean removeReference(java.lang.Object obj,
                      java.lang.Object parent,
                      java.lang.String propName)

Remove a reference on the provided object

Specified by:

removeReference in interface EntityManager

Parameters:

obj - an entity

parent - the parent entity to dereference

propName - name of the parent entity property that references the entity

Returns:

true if actually removed

initMerge

public MergeContext initMerge(ServerSession serverSession)

Description copied from interface: EntityManager

Initialize the merge context in the current thread MergeContext should be released at the end of the process

Specified by:

initMerge in interface EntityManager

Returns:

current merge context

mergeExternal

public java.lang.Object mergeExternal(MergeContext mergeContext,
                             java.lang.Object obj,
                             java.lang.Object previous,
                             java.lang.Object parent,
                             java.lang.String propertyName,
                             boolean forceUpdate)

Merge an object coming from the server in the context

Specified by:

mergeExternal in interface EntityManager

Parameters:

mergeContext - current merge context

obj - external object

previous - previously existing object in the context (null if no existing object)

parent - parent object for collections

propertyName - property name of the current object in the parent object

forceUpdate - force update of property (used for externalized properties)

Returns:

merged object (should === previous when previous not null)

mergePersistentCollection

protected java.lang.Object mergePersistentCollection(MergeContext mergeContext,
                                         org.granite.client.persistence.collection.PersistentCollection<?> coll,
                                         java.lang.Object previous,
                                         java.lang.Object parent,
                                         java.lang.String propertyName)

Wraps a persistent collection to manage lazy initialization

Parameters:

mergeContext - current merge context

coll - the collection to wrap

previous - the previous existing collection

parent - the owner object

propertyName - owner property

Returns:

the wrapped persistent collection

mergeFromEntityManager

public java.lang.Object mergeFromEntityManager(EntityManager sourceEntityManager,
                                      ServerSession serverSession,
                                      java.lang.Object obj,
                                      java.lang.String externalDataSessionId,
                                      boolean uninitializing)

Merge an object coming from another entity manager (in general in the global context) in the local context

Specified by:

mergeFromEntityManager in interface EntityManager

Parameters:

sourceEntityManager - source context of incoming data

serverSession - current server session

obj - external object

externalDataSessionId - is merge from external data

uninitializing - true to force folding of loaded lazy associations

Returns:

merged object

mergeExternalData

public java.lang.Object mergeExternalData(java.lang.Object obj)

Merge an object coming from a remote location (in general from a service) in the local context

Specified by:

mergeExternalData in interface EntityManager

Parameters:

obj - external object

Returns:

merged object (should === previous when previous not null)

mergeExternalData

public java.lang.Object mergeExternalData(ServerSession serverSession,
                                 java.lang.Object obj)

Description copied from interface: EntityManager

Merge an object coming from a remote location (in general from a service) in the local context

Specified by:

mergeExternalData in interface EntityManager

Parameters:

serverSession - the current server session

obj - external object

Returns:

merged object

mergeExternalData

public java.lang.Object mergeExternalData(java.lang.Object obj,
                                 java.lang.Object prev,
                                 java.lang.String externalDataSessionId,
                                 java.util.List<java.lang.Object> removals,
                                 java.util.List<java.lang.Object> persists)

Description copied from interface: EntityManager

Merge an object coming from a remote location (in general from a service) in the local context

Specified by:

mergeExternalData in interface EntityManager

Parameters:

obj - external object

prev - existing local object to merge with

externalDataSessionId - sessionId from which the data is coming (other user/server), null if local or current user session

removals - list of entities to remove from the entity manager cache

persists - list of entities newly persisted to be added in the entity manager cache

Returns:

merged object (should === previous when previous not null)

mergeExternalData

public java.lang.Object mergeExternalData(ServerSession serverSession,
                                 java.lang.Object obj,
                                 java.lang.Object prev,
                                 java.lang.String externalDataSessionId,
                                 java.util.List<java.lang.Object> removals,
                                 java.util.List<java.lang.Object> persists)

Merge an object coming from a remote location (in general from a service) in the local context

Specified by:

mergeExternalData in interface EntityManager

Parameters:

serverSession - server session

obj - external object

prev - existing local object to merge with

externalDataSessionId - sessionId from which the data is coming (other user/server), null if local or current user session

removals - list of entities to remove from the entity manager cache

persists - list of newly persisted entities

Returns:

merged object (should === previous when previous not null)

internalMergeExternalData

public java.lang.Object internalMergeExternalData(MergeContext mergeContext,
                                         java.lang.Object obj,
                                         java.lang.Object prev,
                                         java.util.List<java.lang.Object> removals,
                                         java.util.List<java.lang.Object> persists)

Merge an object coming from a remote location (in general from a service) in the local context

Parameters:

mergeContext - current merge context

obj - external object

prev - existing local object to merge with

removals - array of entities to remove from the entity manager cache

persists - list of newly persisted entities

Returns:

merged object (should === previous when previous not null)

mergeInEntityManager

public void mergeInEntityManager(EntityManager entityManager,
                        ServerSession serverSession)

Merge conversation entity manager context variables in global entity manager Only applicable to conversation contexts

Specified by:

mergeInEntityManager in interface EntityManager

Parameters:

entityManager - conversation entity manager

serverSession - current server session

isDirty

public boolean isDirty()

Description copied from interface: EntityManager

Entity manager is dirty when any entity/collection/map has been modified

Specified by:

isDirty in interface EntityManager

Returns:

is dirty

isDirtyEntity

public boolean isDirtyEntity(java.lang.Object entity)

Description copied from interface: EntityManager

Entity is dirty when any direct property has been modified

Specified by:

isDirtyEntity in interface EntityManager

Returns:

is dirty

isDeepDirtyEntity

public boolean isDeepDirtyEntity(java.lang.Object entity)

Description copied from interface: EntityManager

Entity is deep dirty when any element in its object graph has been modified

Specified by:

isDeepDirtyEntity in interface EntityManager

Parameters:

entity - root of the entity graph

Returns:

is dirty

isSavedEntity

public boolean isSavedEntity(java.lang.Object entity)

handleRemovalsAndPersists

public void handleRemovalsAndPersists(MergeContext mergeContext,
                             java.util.List<java.lang.Object> removals,
                             java.util.List<java.lang.Object> persists)

Remove elements from cache and managed collections

Parameters:

mergeContext - current merge context

removals - list of entity instances to remove from the entity manager cache

persists - list of newly persisted entity instances

addListener

public void addListener(DataConflictListener listener)

Description copied from interface: EntityManager

Register a listener for data conflicts

Specified by:

addListener in interface EntityManager

Parameters:

listener - listener

removeListener

public void removeListener(DataConflictListener listener)

Description copied from interface: EntityManager

Unregister a listener for data conflicts

Specified by:

removeListener in interface EntityManager

Parameters:

listener - listener

handleMergeConflicts

public void handleMergeConflicts(MergeContext mergeContext)

Dispatch an event when last merge generated conflicts

Parameters:

mergeContext - current merge context

resolveMergeConflicts

public void resolveMergeConflicts(MergeContext mergeContext,
                         java.lang.Object modifiedEntity,
                         java.lang.Object localEntity,
                         boolean resolving)

Resolve merge conflicts

Parameters:

mergeContext - current merge context

modifiedEntity - the received entity

localEntity - the locally cached entity

resolving - true to keep client state

getSavedProperties

public java.util.Map<java.lang.Object,java.util.Map<java.lang.String,java.lang.Object>> getSavedProperties()

Current map of saved properties for the the context

Specified by:

getSavedProperties in interface EntityManager

Returns:

saved properties

getSavedProperties

public java.util.Map<java.lang.String,java.lang.Object> getSavedProperties(java.lang.Object entity)

Current map of saved properties for the specified entity

Specified by:

getSavedProperties in interface EntityManager

Parameters:

entity - an entity

Returns:

saved properties for this entity

defaultMerge

public void defaultMerge(MergeContext mergeContext,
                java.lang.Object obj,
                java.lang.Object dest,
                java.lang.Object parent,
                java.lang.String propertyName)

Default implementation of entity merge for simple ActionScript beans with public properties Can be used to implement Tide managed entities with simple objects

Parameters:

mergeContext - current merge context

obj - source object

dest - destination object

parent - owning object

propertyName - property name of the owning object

isEntityChanged

public boolean isEntityChanged(java.lang.Object entity)

isEntityDeepChanged

public boolean isEntityDeepChanged(java.lang.Object entity)

resetEntity

public void resetEntity(java.lang.Object entity)

Discard changes of entity from last version received from the server

Specified by:

resetEntity in interface EntityManager

Parameters:

entity - entity to restore

resetAllEntities

public void resetAllEntities()

Discard changes of all cached entities from last version received from the server

Specified by:

resetAllEntities in interface EntityManager

acceptConflict

public void acceptConflict(Conflict conflict,
                  boolean client)

Accept values for conflict

Specified by:

acceptConflict in interface EntityManager

Parameters:

conflict - conflict

client - true: keep client changes, false: override with server changes

setRemoteInitializer

public void setRemoteInitializer(RemoteInitializer remoteInitializer)

Description copied from interface: EntityManager

Setter for the remote initializer implementation

Specified by:

setRemoteInitializer in interface EntityManager

Parameters:

remoteInitializer - instance of IRemoteInitializer

initializeObject

public boolean initializeObject(ServerSession serverSession,
                       java.lang.Object entity,
                       java.lang.String propertyName,
                       java.lang.Object object)

Trigger remote initialization of lazy-loaded objects

Specified by:

initializeObject in interface EntityManager

Parameters:

serverSession - current server session

entity - owner entity

propertyName - property name

object - a lazily loaded object

Returns:

true if initialization triggered

handleUpdates

public void handleUpdates(MergeContext mergeContext,
                 java.lang.String sourceSessionId,
                 java.util.List<EntityManager.Update> updates)

Handle data updates

Specified by:

handleUpdates in interface EntityManager

Parameters:

mergeContext - current merge context

sourceSessionId - sessionId from which data updates come (null when from current session)

updates - list of data updates

raiseUpdateEvents

public void raiseUpdateEvents(Context context,
                     java.util.List<EntityManager.Update> updates)

Description copied from interface: EntityManager

Dispatch update events on the context

Specified by:

raiseUpdateEvents in interface EntityManager

Parameters:

context - tide context

updates - list of data updates

setRemoteValidator

public void setRemoteValidator(RemoteValidator remoteValidator)

Description copied from interface: EntityManager

Setter for the remote validator implementation

Specified by:

setRemoteValidator in interface EntityManager

Parameters:

remoteValidator - instance of IRemoteValidator

validateObject

public boolean validateObject(java.lang.Object object,
                     java.lang.String property,
                     java.lang.Object value)

Description copied from interface: EntityManager

Trigger remote validation of objects

Specified by:

validateObject in interface EntityManager

Parameters:

object - an object to remotely validate

property - a property to validate

value - value to check

Returns:

true if validation triggered