org.granite.client.tide.data.impl

Class AbstractDataManager

java.lang.Object

org.granite.client.tide.data.impl.AbstractDataManager

All Implemented Interfaces:

DataManager

Direct Known Subclasses:

JavaBeanDataManager

public abstract class AbstractDataManager
extends java.lang.Object
implements DataManager

Author:

William DRAI

Nested Class Summary

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

DataManager.ChangeKind, DataManager.TrackingHandler, DataManager.TrackingType

Field Summary

Fields

Modifier and Type	Field and Description
protected org.granite.client.persistence.Persistence	persistence

Constructor Summary

Constructors

Constructor and Description
AbstractDataManager()

Method Summary

Methods

Modifier and Type	Method and Description
void	copyProxyState(java.lang.Object dest, java.lang.Object obj) Copy the proxy state (fields __initialized__ and __detachedState__) from source to target
void	copyUid(java.lang.Object dest, java.lang.Object obj) Copy the uid field (annotated with Uid) from source to target
boolean	defineProxy(java.lang.Object dest, java.lang.Object obj) Define the target object as a proxy for the source entity
java.lang.String	getCacheKey(java.lang.Object entity) Return a unique key for the entity to be used in a local cache
java.lang.String	getDetachedState(java.lang.Object entity) Return the persistent detached state of an entity (private field name __detachedState__)
java.lang.Object	getId(java.lang.Object entity) Return the persistent id of an entity (field annotated with Id) ?
java.lang.String	getIdPropertyName(java.lang.Object entity) Name of the id field for the entity
java.lang.Object	getPropertyValue(java.lang.Object entity, java.lang.String name) Return the value of the property for the specified entity instance
java.util.Map<java.lang.String,java.lang.Object>	getPropertyValues(java.lang.Object entity, boolean excludeVersion, boolean includeReadOnly) Return a map of property values for the specified entity instance
java.util.Map<java.lang.String,java.lang.Object>	getPropertyValues(java.lang.Object entity, boolean excludeIdUid, boolean excludeVersion, boolean includeReadOnly) Return a map of property values for the specified entity instance
java.lang.String	getUid(java.lang.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
java.lang.String	getUidPropertyName(java.lang.Object entity) Name of the uid field for the entity
java.lang.Object	getVersion(java.lang.Object entity) Return the version (field annotated with Version) for an entity
java.lang.String	getVersionPropertyName(java.lang.Object entity) Name of the version field for the entity
boolean	hasIdProperty(java.lang.Object entity) Has the entity an id field ?
boolean	hasProperty(java.lang.Object entity, java.lang.String name) Return the value of the property for the specified entity instance
boolean	hasVersionProperty(java.lang.Object entity) Has the entity a version field (annotated with Version) ?
protected void	initPersistence()
void	initProxy(java.lang.Object dest, java.lang.Object id, boolean initialized, java.lang.String detachedState) Init state of a proxy object
boolean	isDeepDirtyEntity(java.lang.Object entity) Is the entity graph dirty (any object in the graph of this entity has been modified since last received from server) ?
boolean	isDirtyEntity(java.lang.Object entity) Is the entity instance dirty (modified since last received from server) ?
boolean	isEntity(java.lang.Object entity) Is the object an entity (i.e. annotated with Entity) ?
boolean	isInitialized(java.lang.Object object) Is the entity initialized (field __initialized__ true) ?
boolean	isLazyProperty(java.lang.Object entity, java.lang.String propertyName) Is the specified property lazy ?
<T> T	newInstance(java.lang.Object source, java.lang.Class<T> cast) Create an empty instance of the same class as the source
void	setInitialized(java.lang.Object object, boolean initialized)
void	setLazyProperty(java.lang.Object entity, java.lang.String propertyName) Define a property as lazy
void	setPropertyValue(java.lang.Object entity, java.lang.String name, java.lang.Object value) Set the value of the property for the specified entity instance

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.granite.client.tide.data.spi.DataManager

clear, isDirty, notifyDirtyChange, notifyEntityDirtyChange, setTrackingHandler, startTracking, stopTracking

Field Detail

persistence

protected org.granite.client.persistence.Persistence persistence

Constructor Detail

AbstractDataManager

public AbstractDataManager()

Method Detail

initPersistence

protected void initPersistence()

isEntity

public boolean isEntity(java.lang.Object entity)

Description copied from interface: DataManager

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

Specified by:

isEntity in interface DataManager

Parameters:

entity - object

Returns:

true if entity

getId

public java.lang.Object getId(java.lang.Object entity)

Description copied from interface: DataManager

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

Specified by:

getId in interface DataManager

Parameters:

entity - object

Returns:

id if field found, error if no id field

hasIdProperty

public boolean hasIdProperty(java.lang.Object entity)

Description copied from interface: DataManager

Has the entity an id field ?

Specified by:

hasIdProperty in interface DataManager

Parameters:

entity - object

Returns:

true if id field found

getIdPropertyName

public java.lang.String getIdPropertyName(java.lang.Object entity)

Description copied from interface: DataManager

Name of the id field for the entity

Specified by:

getIdPropertyName in interface DataManager

Parameters:

entity - object

Returns:

property name or null if not found

getDetachedState

public java.lang.String getDetachedState(java.lang.Object entity)

Description copied from interface: DataManager

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

Specified by:

getDetachedState in interface DataManager

Parameters:

entity - object

Returns:

detached state if field found, error if field not found

getVersion

public java.lang.Object getVersion(java.lang.Object entity)

Description copied from interface: DataManager

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

Specified by:

getVersion in interface DataManager

Parameters:

entity - entity

Returns:

version or error if no version field found

hasVersionProperty

public boolean hasVersionProperty(java.lang.Object entity)

Description copied from interface: DataManager

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

Specified by:

hasVersionProperty in interface DataManager

Parameters:

entity - object

Returns:

true if version field found

getVersionPropertyName

public java.lang.String getVersionPropertyName(java.lang.Object entity)

Description copied from interface: DataManager

Name of the version field for the entity

Specified by:

getVersionPropertyName in interface DataManager

Parameters:

entity - object

Returns:

property name or null if not found

hasProperty

public boolean hasProperty(java.lang.Object entity,
                  java.lang.String name)

Description copied from interface: DataManager

Return the value of the property for the specified entity instance

Specified by:

hasProperty in interface DataManager

Parameters:

entity - object instance

name - property name

Returns:

property exists

getPropertyValue

public java.lang.Object getPropertyValue(java.lang.Object entity,
                                java.lang.String name)

Description copied from interface: DataManager

Return the value of the property for the specified entity instance

Specified by:

getPropertyValue in interface DataManager

Parameters:

entity - object instance

name - property name

Returns:

property value

setPropertyValue

public void setPropertyValue(java.lang.Object entity,
                    java.lang.String name,
                    java.lang.Object value)

Description copied from interface: DataManager

Set the value of the property for the specified entity instance

Specified by:

setPropertyValue in interface DataManager

Parameters:

entity - object instance

name - property name

value - property value

getUid

public java.lang.String getUid(java.lang.Object entity)

Description copied from interface: DataManager

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

Specified by:

getUid in interface DataManager

Parameters:

entity - object

Returns:

uid or error if uid could not be generated

getUidPropertyName

public java.lang.String getUidPropertyName(java.lang.Object entity)

Description copied from interface: DataManager

Name of the uid field for the entity

Specified by:

getUidPropertyName in interface DataManager

Parameters:

entity - object

Returns:

property name or null if not found

getCacheKey

public java.lang.String getCacheKey(java.lang.Object entity)

Description copied from interface: DataManager

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

Specified by:

getCacheKey in interface DataManager

Parameters:

entity - entity instance

Returns:

unique key

isInitialized

public boolean isInitialized(java.lang.Object object)

Description copied from interface: DataManager

Is the entity initialized (field __initialized__ true) ?

Specified by:

isInitialized in interface DataManager

Parameters:

object - entity instance

Returns:

true if initialized

setInitialized

public void setInitialized(java.lang.Object object,
                  boolean initialized)

copyUid

public void copyUid(java.lang.Object dest,
           java.lang.Object obj)

Description copied from interface: DataManager

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

Specified by:

copyUid in interface DataManager

Parameters:

dest - target object

obj - source entity

initProxy

public void initProxy(java.lang.Object dest,
             java.lang.Object id,
             boolean initialized,
             java.lang.String detachedState)

Description copied from interface: DataManager

Init state of a proxy object

Specified by:

initProxy in interface DataManager

Parameters:

dest - proxy object

id - proxy id

initialized - is initialized

detachedState - detached state

defineProxy

public boolean defineProxy(java.lang.Object dest,
                  java.lang.Object obj)

Description copied from interface: DataManager

Define the target object as a proxy for the source entity

Specified by:

defineProxy in interface DataManager

Parameters:

dest - target object

obj - source entity

Returns:

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

copyProxyState

public void copyProxyState(java.lang.Object dest,
                  java.lang.Object obj)

Description copied from interface: DataManager

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

Specified by:

copyProxyState in interface DataManager

Parameters:

dest - target object

obj - source entity

getPropertyValues

public java.util.Map<java.lang.String,java.lang.Object> getPropertyValues(java.lang.Object entity,
                                                                 boolean excludeVersion,
                                                                 boolean includeReadOnly)

Description copied from interface: DataManager

Return a map of property values for the specified entity instance

Specified by:

getPropertyValues in interface DataManager

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

getPropertyValues

public java.util.Map<java.lang.String,java.lang.Object> getPropertyValues(java.lang.Object entity,
                                                                 boolean excludeIdUid,
                                                                 boolean excludeVersion,
                                                                 boolean includeReadOnly)

Description copied from interface: DataManager

Return a map of property values for the specified entity instance

Specified by:

getPropertyValues in interface DataManager

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

isLazyProperty

public boolean isLazyProperty(java.lang.Object entity,
                     java.lang.String propertyName)

Description copied from interface: DataManager

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

Specified by:

isLazyProperty in interface DataManager

Parameters:

entity - entity instance

propertyName - property name

Returns:

true if property defined as lazy

setLazyProperty

public void setLazyProperty(java.lang.Object entity,
                   java.lang.String propertyName)

Description copied from interface: DataManager

Define a property as lazy

Specified by:

setLazyProperty in interface DataManager

Parameters:

entity - entity instance

propertyName - property name

newInstance

public <T> T newInstance(java.lang.Object source,
                java.lang.Class<T> cast)
              throws java.lang.IllegalAccessException,
                     java.lang.InstantiationException

Description copied from interface: DataManager

Create an empty instance of the same class as the source

Specified by:

newInstance in interface DataManager

Type Parameters:

T - expected type

Parameters:

source - source object

cast - expected type

Returns:

new empty instance

Throws:

java.lang.IllegalAccessException

java.lang.InstantiationException

isDirtyEntity

public boolean isDirtyEntity(java.lang.Object entity)

Description copied from interface: DataManager

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

Specified by:

isDirtyEntity in interface DataManager

Returns:

true if modified

isDeepDirtyEntity

public boolean isDeepDirtyEntity(java.lang.Object entity)

Description copied from interface: DataManager

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

Specified by:

isDeepDirtyEntity in interface DataManager

Returns:

true if modified