org.granite.client.tide.data.spi

Interface DataManager

All Known Implementing Classes:

AbstractDataManager, JavaBeanDataManager

public interface DataManager

SPI for integrating with different types of data objects (javabeans, javafx bindable beans, ...)

Author:

William DRAI

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DataManager.ChangeKind Kinds of changes for collections and maps
static interface	DataManager.TrackingHandler Callback interface for objects that need to be notified when modifications are made on managed entities
static class	DataManager.TrackingType Types of tracked events

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Reset all currently tracked objects
void	copyProxyState(Object target, Object source) Copy the proxy state (fields __initialized__ and __detachedState__) from source to target
void	copyUid(Object target, Object source) Copy the uid field (annotated with Uid) from source to target
boolean	defineProxy(Object target, Object source) Define the target object as a proxy for the source entity
String	getCacheKey(Object entity) Return a unique key for the entity to be used in a local cache
String	getDetachedState(Object entity) Return the persistent detached state of an entity (private field name __detachedState__)
Object	getId(Object entity) Return the persistent id of an entity (field annotated with Id) ?
Object	getPropertyValue(Object entity, String name) Return the value of the property for the specified entity instance
Map<String,Object>	getPropertyValues(Object entity, boolean excludeVersion, boolean includeReadOnly) Return a map of property values for the specified entity instance
Map<String,Object>	getPropertyValues(Object entity, boolean excludeIdUid, boolean excludeVersion, boolean includeReadOnly) Return a map of property values for the specified entity instance
String	getUid(Object entity) Get the uid field (annotated with Uid) for the entity Note that the data manager implementation is allowed to generate a reasonable uid value from other fields if no uid field is present
Object	getVersion(Object entity) Return the version (field annotated with Version) for an entity
String	getVersionPropertyName(Object entity) Name of the version field for the entity
boolean	hasIdProperty(Object entity) Has the entity an id field ?
boolean	hasVersionProperty(Object entity) Has the entity a version field (annotated with Version) ?
boolean	isDeepDirtyEntity(Object entity) Is the entity graph dirty (any object in the graph of this entity has been modified since last received from server) ?
boolean	isDirty() Is the data manager dirty (any managed entity instance has been modified since last received from server) ?
boolean	isDirtyEntity(Object entity) Is the entity instance dirty (modified since last received from server) ?
boolean	isEntity(Object object) Is the object an entity (i.e. annotated with Entity) ?
boolean	isInitialized(Object entity) Is the entity initialized (field __initialized__ true) ?
boolean	isLazyProperty(Object entity, String name) Is the specified property lazy ?
void	notifyDirtyChange(boolean oldDirty, boolean dirty) Notify listeners that the dirty state of this data manager has changed Called by dirty checking
void	notifyEntityDirtyChange(Object entity, boolean oldDirtyEntity, boolean newDirtyEntity) Notify listeners that the dirty state of the specified has changed
void	setLazyProperty(Object entity, String name) Define a property as lazy
void	setPropertyValue(Object entity, String name, Object value) Set the value of the property for the specified entity instance
void	setTrackingHandler(DataManager.TrackingHandler trackingHandler) Register a handler that will be notified when any managed entity is modified
void	startTracking(Object previous, Object parent) Start tracking for the specified object / parent
void	stopTracking(Object previous, Object parent) Stop tracking for the specified object / parent

Method Detail

isEntity

boolean isEntity(Object object)

Is the object an entity (i.e. annotated with Entity) ?

Parameters:

object - object

Returns:

true if entity

getId

Object getId(Object entity)

Return the persistent id of an entity (field annotated with Id) ?

Parameters:

entity - object

Returns:

id if field found, error if no id field

hasIdProperty

boolean hasIdProperty(Object entity)

Has the entity an id field ?

Parameters:

entity - object

Returns:

true if id field found

getDetachedState

String getDetachedState(Object entity)

Return the persistent detached state of an entity (private field name __detachedState__)

Parameters:

entity - object

Returns:

detached state if field found, error if field not found

defineProxy

boolean defineProxy(Object target,
                  Object source)

Define the target object as a proxy for the source entity

Parameters:

target - target object

source - source entity

Returns:

true if proxy was setup, false if source was not an entity or did not have any detached state

copyProxyState

void copyProxyState(Object target,
                  Object source)

Copy the proxy state (fields __initialized__ and __detachedState__) from source to target

Parameters:

target - target object

source - source entity

copyUid

void copyUid(Object target,
           Object source)

Copy the uid field (annotated with Uid) from source to target

Parameters:

target - target object

source - source entity

getVersion

Object getVersion(Object entity)

Return the version (field annotated with Version) for an entity

Parameters:

entity - entity

Returns:

version or error if no version field found

hasVersionProperty

boolean hasVersionProperty(Object entity)

Has the entity a version field (annotated with Version) ?

Parameters:

entity - object

Returns:

true if version field found

getVersionPropertyName

String getVersionPropertyName(Object entity)

Name of the version field for the entity

Parameters:

entity - object

Returns:

property name or null if not found

getUid

String getUid(Object entity)

Get the uid field (annotated with Uid) for the entity Note that the data manager implementation is allowed to generate a reasonable uid value from other fields if no uid field is present

Parameters:

entity - object

Returns:

uid or error if uid could not be generated

getPropertyValues

Map<String,Object> getPropertyValues(Object entity,
                                   boolean excludeIdUid,
                                   boolean excludeVersion,
                                   boolean includeReadOnly)

Return a map of property values for the specified entity instance

Parameters:

entity - object instance

excludeIdUid - true to exclude id and uid fields from the map

excludeVersion - true to exclude version field from the map

includeReadOnly - true to include readonly fields in the map

Returns:

a map of values keyed by property names

getPropertyValues

Map<String,Object> getPropertyValues(Object entity,
                                   boolean excludeVersion,
                                   boolean includeReadOnly)

Return a map of property values for the specified entity instance

Parameters:

entity - object instance

excludeVersion - true to exclude version field from the map

includeReadOnly - true to include readonly fields in the map

Returns:

a map of values keyed by property names

getPropertyValue

Object getPropertyValue(Object entity,
                      String name)

Return the value of the property for the specified entity instance

Parameters:

entity - object instance

name - property name

Returns:

property value

setPropertyValue

void setPropertyValue(Object entity,
                    String name,
                    Object value)

Set the value of the property for the specified entity instance

Parameters:

entity - object instance

name - property name

value - property value

isLazyProperty

boolean isLazyProperty(Object entity,
                     String name)

Is the specified property lazy ? A property is considered lazy if it is annotated with Lazy or if the server has returned an initialized value

Parameters:

entity - entity instance

name - property name

Returns:

true if property defined as lazy

setLazyProperty

void setLazyProperty(Object entity,
                   String name)

Define a property as lazy

Parameters:

entity - entity instance

name - property name

getCacheKey

String getCacheKey(Object entity)

Return a unique key for the entity to be used in a local cache

Parameters:

entity - entity instance

Returns:

unique key

isInitialized

boolean isInitialized(Object entity)

Is the entity initialized (field __initialized__ true) ?

Parameters:

entity - entity instance

Returns:

true if initialized

isDirty

boolean isDirty()

Is the data manager dirty (any managed entity instance has been modified since last received from server) ?

Returns:

true if modified

isDirtyEntity

boolean isDirtyEntity(Object entity)

Is the entity instance dirty (modified since last received from server) ?

Returns:

true if modified

isDeepDirtyEntity

boolean isDeepDirtyEntity(Object entity)

Is the entity graph dirty (any object in the graph of this entity has been modified since last received from server) ?

Returns:

true if modified

setTrackingHandler

void setTrackingHandler(DataManager.TrackingHandler trackingHandler)

Register a handler that will be notified when any managed entity is modified

Parameters:

trackingHandler - tracking handler

startTracking

void startTracking(Object previous,
                 Object parent)

Start tracking for the specified object / parent

Parameters:

previous - previously existing object in the entity manager cache (null if no existing object)

parent - parent object for collections

stopTracking

void stopTracking(Object previous,
                Object parent)

Stop tracking for the specified object / parent

Parameters:

previous - previously existing object in the entity manager cache (null if no existing object)

parent - parent object for collections

clear

void clear()

Reset all currently tracked objects

notifyDirtyChange

void notifyDirtyChange(boolean oldDirty,
                     boolean dirty)

Notify listeners that the dirty state of this data manager has changed Called by dirty checking

Parameters:

oldDirty - old value

dirty - new value

See Also:

DirtyCheckContext

notifyEntityDirtyChange

void notifyEntityDirtyChange(Object entity,
                           boolean oldDirtyEntity,
                           boolean newDirtyEntity)

Notify listeners that the dirty state of the specified has changed

Parameters:

entity - entity instance

oldDirtyEntity - old value

newDirtyEntity - new value

See Also:

DirtyCheckContext