org.granite.client.tide.data

Interface EntityManager

All Known Implementing Classes:

EntityManagerImpl

public interface EntityManager

EntityManager is the interface for entity management (!) It is implemented by the Tide context

Author:

William DRAI

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	EntityManager.Function
static interface	EntityManager.Propagation
static interface	EntityManager.PropagationPolicy
static class	EntityManager.Update Update received from the server
static class	EntityManager.UpdateKind Kinds of updates than can be received from the server

Method Summary

Methods

Modifier and Type	Method and Description
void	acceptConflict(Conflict conflict, boolean acceptClient) Accept values for conflict
void	addListener(DataConflictListener listener) Register a listener for data conflicts
void	addReference(java.lang.Object entity, 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 entity) Attach an entity graph in the current entity manager
void	clear() Clear the current context Destroys all components/context variables
void	clearCache() Clear entity cache
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.lang.Object[]	getOwnerEntity(java.lang.Object object) Return the owner entity for the specified object (collection/map, embedded object or associated object)
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	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
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	isPersisted(java.lang.Object entity) Indicates if the entity is persisted on the server (id/version not null/NaN)
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 in the local 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
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 entity, 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	setEntityManagerPropagation(EntityManager.Propagation propagation) Set 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 allowed) Allow uninitialize of persistent collections
boolean	validateObject(java.lang.Object object, java.lang.String property, java.lang.Object value) Trigger remote validation of objects

Method Detail

getId

java.lang.String getId()

Return the entity manager id

Returns:

the entity manager id

isActive

boolean isActive()

Return the entity manager state

Returns:

the entity manager state

clearCache

void clearCache()

Clear entity cache

clear

void clear()

Clear the current context Destroys all components/context variables

getDataManager

DataManager getDataManager()

Data manager for this entity manager

Returns:

data manager

getTrackingHandler

DataManager.TrackingHandler getTrackingHandler()

Tracking handler for this entity manager

Returns:

tracking handler

setUninitializeAllowed

void setUninitializeAllowed(boolean allowed)

Allow uninitialize of persistent collections

Parameters:

allowed - allow uninitialize of collections

isUninitializeAllowed

boolean isUninitializeAllowed()

Allow uninitialize of persistent collections ?

Returns:

allow uninitialize of collections

setRemoteInitializer

void setRemoteInitializer(RemoteInitializer remoteInitializer)

Setter for the remote initializer implementation

Parameters:

remoteInitializer - instance of IRemoteInitializer

setRemoteValidator

void setRemoteValidator(RemoteValidator remoteValidator)

Setter for the remote validator implementation

Parameters:

remoteValidator - instance of IRemoteValidator

newTemporaryEntityManager

EntityManager newTemporaryEntityManager()

Create a new temporary entity manager

Returns:

a temporary entity manager

addReference

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

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

Parameters:

entity - an entity

parent - the parent entity

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

removeReference

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

Remove a reference on the provided object

Parameters:

entity - an entity

parent - the parent entity to dereference

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

isDirty

boolean isDirty()

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

Returns:

is dirty

isDirtyEntity

boolean isDirtyEntity(java.lang.Object entity)

Entity is dirty when any direct property has been modified

Parameters:

entity -

Returns:

is dirty

isDeepDirtyEntity

boolean isDeepDirtyEntity(java.lang.Object entity)

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

Parameters:

entity - root of the entity graph

Returns:

is dirty

isPersisted

boolean isPersisted(java.lang.Object entity)

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

Parameters:

entity - an entity

Returns:

true if saved

getCachedObject

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

Retrieve an entity in the cache from its uid

Parameters:

object - an entity

nullIfAbsent - return null if entity not cached in context

getOwnerEntity

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

Return the owner entity for the specified object (collection/map, embedded object or associated object)

Parameters:

object - an object

Returns:

array containing the owner entity and the property name or null if not found

initMerge

MergeContext initMerge(ServerSession serverSession)

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

Returns:

current merge context

mergeExternal

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 in the local context

Parameters:

mergeContext - current merge context

obj - object to merge

previous - previous instance

parent - parent/owning entity

propertyName - property name from the owning entity

forceUpdate - true to force update of the destination object even if versions do not match

Returns:

merged object

mergeExternalData

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

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

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

Parameters:

serverSession - the current server session

obj - external object

Returns:

merged object

mergeExternalData

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

Parameters:

serverSession - the current 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 - array 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

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

Parameters:

obj - external object

Returns:

merged object

mergeFromEntityManager

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

Parameters:

sourceEntityManager - source context of incoming data

obj - external object

externalDataSessionId - is merge from external data

uninitializing - the merge should uninitialize all collections/entities when possible

Returns:

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

mergeInEntityManager

void mergeInEntityManager(EntityManager entityManager,
                        ServerSession serverSession)

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

Parameters:

entityManager - conversation entity manager

serverSession - current server session

attach

void attach(java.lang.Object entity)

Attach an entity graph in the current entity manager

Parameters:

entity -

resetEntity

void resetEntity(java.lang.Object entity)

Discard changes of entity from last version received from the server

Parameters:

entity - entity to restore

resetAllEntities

void resetAllEntities()

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

getSavedProperties

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

Returns:

saved properties

getSavedProperties

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

Current map of saved properties for the specified entity

Parameters:

entity - an entity

Returns:

saved properties for this entity

handleUpdates

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

Handle data updates

Parameters:

mergeContext - current merge context

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

updates - list of data updates

raiseUpdateEvents

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

Dispatch update events on the context

Parameters:

context - tide context

updates - list of data updates

addListener

void addListener(DataConflictListener listener)

Register a listener for data conflicts

Parameters:

listener - listener

removeListener

void removeListener(DataConflictListener listener)

Unregister a listener for data conflicts

Parameters:

listener - listener

acceptConflict

void acceptConflict(Conflict conflict,
                  boolean acceptClient)

Accept values for conflict

Parameters:

conflict - conflict

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

initializeObject

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

Trigger remote initialization of lazy-loaded objects

Parameters:

serverSession - current server session

entity - owner entity

propertyName - property name

object - a lazily loaded object

Returns:

true if initialization triggered

validateObject

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

Trigger remote validation of objects

Parameters:

object - an object to remotely validate

property - a property to validate

value - value to check

Returns:

true if validation triggered

setEntityManagerPropagation

void setEntityManagerPropagation(EntityManager.Propagation propagation)

Set the propagation manager

Parameters:

propagation - propagation function that will visit child entity managers