NativeEntryEntityPersister (GORM for Rx 8.1.2)

org.grails.datastore.mapping.engine.NativeEntryEntityPersister

```
@java.lang.SuppressWarnings({"unused", "rawtypes", "unchecked"})
public abstract class NativeEntryEntityPersister<T, K>
extends ThirdPartyCacheEntityPersister
```
Provides an implementation of the EntityPersister class that reads and writes against a native datastore type specified by the generic type parameter T
Authors:
Graeme Rocher
Since:
1.0

Nested Class Summary

Nested classes
Modifiers	Name	Description
`protected class`	`NativeEntryEntityPersister.NativeEntryModifyingEntityAccess`

Field Summary

Fields
Modifiers	Name	Description
`static java.lang.String`	`EMBEDDED_PREFIX`
`protected ClassMapping`	`classMapping`

Inherited fields
Fields inherited from class	Fields
`class ThirdPartyCacheEntityPersister`	`cacheAdapterRepository`
`class LockableEntityPersister`	`DEFAULT_TIMEOUT`
`class EntityPersister`	`mappingContext, persistentEntity, proxyFactory, publisher, reflector, session`

Constructor Summary

Constructors
Constructor and description
`NativeEntryEntityPersister (MappingContext mappingContext, PersistentEntity entity, Session session, org.springframework.context.ApplicationEventPublisher publisher)`
`NativeEntryEntityPersister (MappingContext mappingContext, PersistentEntity entity, Session session, org.springframework.context.ApplicationEventPublisher publisher, TPCacheAdapterRepository<T> cacheAdapterRepository)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected boolean`	`areCollectionsEqual(java.lang.Object oldValue, java.lang.Object currentValue)`
	`protected boolean`	`areEqual(java.lang.Object oldValue, java.lang.Object currentValue, java.lang.String propName)`
	`protected void`	`cacheEmbeddedEntry(PersistentEntity persistentEntity, java.io.Serializable nativeKey, T nativeEntry)`
	`protected void`	`cacheNativeEntry(PersistentEntity persistentEntity, java.io.Serializable nativeKey, T nativeEntry)`
	`protected void`	`cascadeAfterDelete(PersistentEntity persistentEntity, EntityAccess entityAccess, K key, java.lang.Object instance)` Delete many-to-ones after owner delete.
	`protected void`	`cascadeBeforeDelete(PersistentEntity persistentEntity, EntityAccess entityAccess, K key, java.lang.Object instance)` Delete collections before owner delete.
	`protected void`	`cascadeDeleteCollection(EntityAccess entityAccess, Association association)`
	`protected java.lang.Object`	`convertBasicEntryValue(PersistentEntity persistentEntity, Basic prop, java.lang.Object entryValue)` Convert a Basic (collection-style) property native entry value taken from an entity into the target property type.
	`protected java.io.Serializable`	`convertIdIfNecessary(PersistentEntity entity, java.io.Serializable nativeKey)`
	`protected java.io.Serializable`	`convertToNativeKey(java.io.Serializable nativeKey)` Subclasses should override to provide any conversion necessary to convert to a nativeKey
	`public static java.lang.String`	`createEmbeddedCacheEntryKey(java.lang.Object instance)`
	`protected EntityAccess`	`createEntityAccess(PersistentEntity persistentEntity, java.lang.Object obj, T nativeEntry)`
	`public T`	`createNativeObjectForEmbedded(Association embedded, java.lang.Object instance)`
	`protected abstract T`	`createNewEntry(java.lang.String family)` Creates a new entry for the given family.
	`protected T`	`createNewEntry(java.lang.String family, java.lang.Object instance)` Creates a new entry for the given family.
	`public java.lang.Object`	`createObjectFromEmbeddedNativeEntry(PersistentEntity persistentEntity, T nativeEntry)`
	`public java.lang.Object`	`createObjectFromNativeEntry(PersistentEntity persistentEntity, java.io.Serializable nativeKey, T nativeEntry)`
	`protected final void`	`deleteEntities(PersistentEntity persistentEntity, java.lang.Iterable objects)`
	`protected void`	`deleteEntity(PersistentEntity persistentEntity, java.lang.Object obj)`
	`protected abstract void`	`deleteEntries(java.lang.String family, java.util.List<K> keys)` Deletes one or many entries for the given list of Keys
	`protected abstract void`	`deleteEntry(java.lang.String family, K key, java.lang.Object entry)` Deletes a single entry
	`protected PersistentEntity`	`discriminatePersistentEntity(PersistentEntity persistentEntity, T nativeEntry)` Subclasses should override to customize how entities in hierarchies are discriminated
	`protected boolean`	`doManualDirtyCheck(java.lang.Object instance, java.lang.Object entry)`
	`protected boolean`	`doesRequirePropertyIndexing()` Subclasses should override to optimize away manual property indexing if it is not required
	`protected K`	`executeInsert(PersistentEntity persistentEntity, NativeEntryEntityPersister.NativeEntryModifyingEntityAccess entityAccess, K id, T e)` Executes an insert for the given entity, entity access, identifier and native entry.
	`protected java.lang.Object`	`formulateDatabaseReference(PersistentEntity persistentEntity, Association association, java.io.Serializable associationId)` Formulates a database reference for the given entity, association and association id
	`protected abstract K`	`generateIdentifier(PersistentEntity persistentEntity, T entry)` Subclasses should override to provide id generation.
	`public abstract AssociationIndexer`	`getAssociationIndexer(T nativeEntry, Association association)` Obtains an indexer for the given association
	`public ClassMapping`	`getClassMapping()`
	`protected T`	`getEmbedded(T nativeEntry, java.lang.String key)` Implementors should override to provide support for embedded objects.
	`public abstract java.lang.String`	`getEntityFamily()`
	`protected abstract java.lang.Object`	`getEntryValue(T nativeEntry, java.lang.String property)` Reads a value for the given key from the native entry
	`protected java.lang.String`	`getIdentifierName(ClassMapping cm)` Obtains the identifier name to use.
	`protected java.util.Collection`	`getManyToManyKeys(PersistentEntity persistentEntity, java.lang.Object obj, java.io.Serializable nativeKey, T nativeEntry, ManyToMany manyToMany)`
	`protected java.lang.String`	`getNativePropertyKey(PersistentProperty prop)`
	`private AbstractPersistentCollection`	`getPersistentCollection(java.util.Collection associatedObjects, java.lang.Class associationType)`
	`public abstract PropertyValueIndexer`	`getPropertyIndexer(PersistentProperty property)` Obtains an indexer for a particular property
	`protected java.lang.String`	`getPropertyKey(PersistentProperty prop)`
	`private void`	`handleCustom(PersistentProperty prop, EntityAccess ea, T nativeEntry)`
	`protected T`	`handleEmbeddedInstance(Association association, java.lang.Object embeddedInstance)`
	`protected T`	`handleEmbeddedInstance(Association association, java.lang.Object embeddedInstance, boolean includeNulls)`
	`protected void`	`handleEmbeddedToMany(EntityAccess entityAccess, T e, PersistentProperty prop, java.lang.String key)`
	`protected void`	`handleEmbeddedToOne(Association association, java.lang.String key, EntityAccess entityAccess, T nativeEntry)`
	`private void`	`handleIndexing(boolean update, T e, java.util.Map<PersistentProperty, java.lang.Object> toIndex, java.util.Map<PersistentProperty, java.lang.Object> toUnindex, PersistentProperty prop, java.lang.String key, boolean indexed, java.lang.Object propValue)`
	`protected java.lang.Object`	`inferNativeKey(java.lang.String family, java.lang.Object identifier)` Used to establish the native key to use from the identifier defined by the object
	`public boolean`	`isDirty(java.lang.Object instance, java.lang.Object entry)`
	`protected boolean`	`isEmbeddedEntry(java.lang.Object entry)` Tests whether a native entry is an embedded entry
	`private boolean`	`isInitializedCollection(java.util.Collection associatedObjects)`
	`private boolean`	`isLazyAssociation(PropertyMapping<Property> associationPropertyMapping)`
	`public boolean`	`isLocked(java.lang.Object o)` Subclasses can override to provide locking semantics
	`private boolean`	`isNotUpdateForAssignedId(PersistentEntity persistentEntity, java.lang.Object obj, boolean update, boolean assignedId, SessionImplementor<java.lang.Object> si)`
	`protected boolean`	`isPropertyIndexed(Property mappedProperty)`
	`protected void`	`loadEmbeddedCollection(EmbeddedCollection embeddedCollection, EntityAccess ea, java.lang.Object embeddedInstances, java.lang.String propertyKey)` Implementors who want to the ability to read embedded collections should implement this method
	`protected java.util.List`	`loadEmbeddedCollectionKeys(Association association, EntityAccess ea, T nativeEntry)` Implementors who want to support one-to-many associations embedded should implement this method
	`public final java.lang.Object`	`lock(java.io.Serializable id)`
	`public final java.lang.Object`	`lock(java.io.Serializable id, int timeout)`
	`protected void`	`lockEntry(PersistentEntity persistentEntity, java.lang.String entityFamily, java.io.Serializable id, int timeout)` Subclasses can override to provide locking semantics
	`protected java.util.List<java.io.Serializable>`	`persistEntities(PersistentEntity persistentEntity, java.lang.Iterable objs)` This is a rather simplistic and unoptimized implementation.
	`protected java.io.Serializable`	`persistEntity(PersistentEntity persistentEntity, java.lang.Object obj, boolean isInsert)`
	`protected final java.io.Serializable`	`persistEntity(PersistentEntity persistentEntity, java.lang.Object obj)`
	`protected K`	`readIdentifierFromObject(java.lang.Object object)`
	`protected K`	`readObjectIdentifier(EntityAccess entityAccess, ClassMapping cm)` Reads an objects identifier using the entity access and ClassMapping instance
	`public java.io.Serializable`	`refresh(java.lang.Object o)`
	`protected void`	`refreshObjectStateFromNativeEntry(PersistentEntity persistentEntity, java.lang.Object obj, java.io.Serializable nativeKey, T nativeEntry)`
	`protected void`	`refreshObjectStateFromNativeEntry(PersistentEntity persistentEntity, java.lang.Object obj, java.io.Serializable nativeKey, T nativeEntry, boolean isEmbedded)`
	`private java.lang.Object`	`replaceNullOrUninitialized(java.lang.Object c, java.lang.Object other)`
	`protected java.util.List<java.lang.Object>`	`retrieveAllEntities(PersistentEntity persistentEntity, java.lang.Iterable<java.io.Serializable> keys)` Simplistic default implementation of retrieveAllEntities that iterates over each key and retrieves the entities one-by-one.
	`protected java.util.List<java.lang.Object>`	`retrieveAllEntities(PersistentEntity persistentEntity, java.io.Serializable[] keys)` Simplistic default implementation of retrieveAllEntities that iterates over each key and retrieves the entities one-by-one.
	`protected final java.lang.Object`	`retrieveEntity(PersistentEntity persistentEntity, java.io.Serializable nativeKey)`
	`protected abstract T`	`retrieveEntry(PersistentEntity persistentEntity, java.lang.String family, java.io.Serializable key)` Reads the native form of a Key/value datastore entry.
	`public void`	`run()`
	`public void`	`run()`
	`public void`	`run()`
	`public void`	`run()`
	`protected void`	`setEmbedded(T nativeEntry, java.lang.String key, T embeddedEntry)` Implementors should override this method to provide support for embedded objects
	`protected void`	`setEmbeddedCollection(T nativeEntry, java.lang.String key, java.util.Collection<?> instances, java.util.List<T> embeddedEntries)` Implementors should override this method to provide support for embedded objects
	`protected void`	`setEmbeddedCollectionKeys(Association association, EntityAccess embeddedEntityAccess, T embeddedEntry, java.util.List<java.io.Serializable> keys)`
	`protected void`	`setEmbeddedMap(T nativeEntry, java.lang.String key, java.util.Map instances, java.util.Map<java.lang.Object, T> embeddedEntries)` Implementors should override this method to provide support for maps of embedded objects
	`protected abstract void`	`setEntryValue(T nativeEntry, java.lang.String key, java.lang.Object value)` Sets a value on an entry
	`protected void`	`setManyToMany(PersistentEntity persistentEntity, java.lang.Object obj, T nativeEntry, ManyToMany manyToMany, java.util.Collection associatedObjects, java.util.Map<Association, java.util.List<java.io.Serializable>> toManyKeys)`
	`protected abstract K`	`storeEntry(PersistentEntity persistentEntity, EntityAccess entityAccess, K storeId, T nativeEntry)` Stores the native form of a Key/value datastore to the actual data store
	`public void`	`unlock(java.lang.Object o)`
	`protected void`	`unlockEntry(PersistentEntity persistentEntity, java.lang.String entityFamily, java.io.Serializable id)` Subclasses to override to provide locking semantics
	`protected abstract void`	`updateEntry(PersistentEntity persistentEntity, EntityAccess entityAccess, K key, T entry)` Updates an existing entry to the actual datastore
	`private void`	`updatePropertyIndices(java.lang.Object identifier, java.util.Map<PersistentProperty, java.lang.Object> valuesToIndex, java.util.Map<PersistentProperty, java.lang.Object> valuesToDeindex)`
	`private void`	`updateToManyIndices(T nativeEntry, java.lang.Object identifier, java.util.Map<Association, java.util.List<java.io.Serializable>> toManyKeys, boolean preIndex)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class ThirdPartyCacheEntityPersister`	`getFromTPCache, updateTPCache`
`class LockableEntityPersister`	`isLocked, lock, lock, proxy, unlock`
`class EntityPersister`	cancelDelete, cancelInsert, cancelLoad, cancelUpdate, createEntityAccess, delete, delete, deleteEntities, deleteEntity, firePostDeleteEvent, firePostInsertEvent, firePostLoadEvent, firePostUpdateEvent, firePreLoadEvent, getCurrentVersion, getMappingContext, getObjectIdentifier, getPersistentEntity, getProxyFactory, getSession, getType, incrementEntityVersion, incrementVersion, insert, isAssignedId, isVersioned, newEntityInstance, persist, persist, persistEntities, persistEntity, persistEntity, proxy, retrieve, retrieveAll, retrieveAll, retrieveAllEntities, retrieveAllEntities, retrieveEntity, setDateVersion, setDateVersionInternal, setObjectIdentifier, setVersion

- Field Detail
  - public static final java.lang.String EMBEDDED_PREFIX
  - protected ClassMapping classMapping
- Constructor Detail
  - public NativeEntryEntityPersister(MappingContext mappingContext, PersistentEntity entity, Session session, org.springframework.context.ApplicationEventPublisher publisher)
  - public NativeEntryEntityPersister(MappingContext mappingContext, PersistentEntity entity, Session session, org.springframework.context.ApplicationEventPublisher publisher, TPCacheAdapterRepository<T> cacheAdapterRepository)
- Method Detail
  - protected boolean areCollectionsEqual(java.lang.Object oldValue, java.lang.Object currentValue)
  - protected boolean areEqual(java.lang.Object oldValue, java.lang.Object currentValue, java.lang.String propName)
  - protected void cacheEmbeddedEntry(PersistentEntity persistentEntity, java.io.Serializable nativeKey, T nativeEntry)
  - protected void cacheNativeEntry(PersistentEntity persistentEntity, java.io.Serializable nativeKey, T nativeEntry)
  - protected void cascadeAfterDelete(PersistentEntity persistentEntity, EntityAccess entityAccess, K key, java.lang.Object instance)
    
    Delete many-to-ones after owner delete.
  - protected void cascadeBeforeDelete(PersistentEntity persistentEntity, EntityAccess entityAccess, K key, java.lang.Object instance)
    
    Delete collections before owner delete.
  - protected void cascadeDeleteCollection(EntityAccess entityAccess, Association association)
  - protected java.lang.Object convertBasicEntryValue(PersistentEntity persistentEntity, Basic prop, java.lang.Object entryValue)
    
    Convert a Basic (collection-style) property native entry value taken from an entity into the target property type. This takes into account any generic parameter types specified on the property (e.g. Collection<Locale> tells us to convert elements into Locale objects). If you don't specify generic properties, collection elements are not modified. If the target type is known from the generic parameters, the conversion process is essentially identical to that used for single Simple properties.
    Parameters:
    persistentEntity - The persistent entity
    prop - The property in question
    entryValue - The value of the entry
    Returns:
    The transformed entry type.
  - protected java.io.Serializable convertIdIfNecessary(PersistentEntity entity, java.io.Serializable nativeKey)
  - protected java.io.Serializable convertToNativeKey(java.io.Serializable nativeKey)
    
    Subclasses should override to provide any conversion necessary to convert to a nativeKey
    Parameters:
    nativeKey - The key
    Returns:
    The native key
  - public static java.lang.String createEmbeddedCacheEntryKey(java.lang.Object instance)
  - protected EntityAccess createEntityAccess(PersistentEntity persistentEntity, java.lang.Object obj, T nativeEntry)
  - public T createNativeObjectForEmbedded(Association embedded, java.lang.Object instance)
  - protected abstract T createNewEntry(java.lang.String family)
    
    Creates a new entry for the given family.
    Parameters:
    family - The family
    Returns:
    An entry such as a BigTable Entity, ColumnFamily etc.
  - protected T createNewEntry(java.lang.String family, java.lang.Object instance)
    
    Creates a new entry for the given family.
    Parameters:
    family - The family
    Returns:
    An entry such as a BigTable Entity, ColumnFamily etc.
  - public java.lang.Object createObjectFromEmbeddedNativeEntry(PersistentEntity persistentEntity, T nativeEntry)
  - public java.lang.Object createObjectFromNativeEntry(PersistentEntity persistentEntity, java.io.Serializable nativeKey, T nativeEntry)
  - @java.lang.Override protected final void deleteEntities(PersistentEntity persistentEntity, java.lang.Iterable objects)
  - @java.lang.Override protected void deleteEntity(PersistentEntity persistentEntity, java.lang.Object obj)
  - protected abstract void deleteEntries(java.lang.String family, java.util.List<K> keys)
    
    Deletes one or many entries for the given list of Keys
    Parameters:
    family - The family
    keys - The keys
  - protected abstract void deleteEntry(java.lang.String family, K key, java.lang.Object entry)
    
    Deletes a single entry
    Parameters:
    family - The family
    key - The key
    entry - the entry
  - protected PersistentEntity discriminatePersistentEntity(PersistentEntity persistentEntity, T nativeEntry)
    
    Subclasses should override to customize how entities in hierarchies are discriminated
    Parameters:
    persistentEntity - The PersistentEntity
    nativeEntry - The native entry
    Returns:
    The discriminated entity
  - protected boolean doManualDirtyCheck(java.lang.Object instance, java.lang.Object entry)
  - protected boolean doesRequirePropertyIndexing()
    
    Subclasses should override to optimize away manual property indexing if it is not required
    Returns:
    True if property indexing is required (the default)
  - protected K executeInsert(PersistentEntity persistentEntity, NativeEntryEntityPersister.NativeEntryModifyingEntityAccess entityAccess, K id, T e)
    
    Executes an insert for the given entity, entity access, identifier and native entry. Any before interceptors will be triggered
    Parameters:
    persistentEntity
    entityAccess
    id
    e
    Returns:
    The key
  - protected java.lang.Object formulateDatabaseReference(PersistentEntity persistentEntity, Association association, java.io.Serializable associationId)
    
    Formulates a database reference for the given entity, association and association id
    Parameters:
    persistentEntity - The entity being persisted
    association - The association
    associationId - The association id
    Returns:
    A database reference
  - protected abstract K generateIdentifier(PersistentEntity persistentEntity, T entry)
    
    Subclasses should override to provide id generation. If an identifier is only generated via an insert operation then this method should return null
    Parameters:
    persistentEntity - The entity
    entry - The native entry
    Returns:
    The identifier or null if an identifier is generated only on insert
  - public abstract AssociationIndexer getAssociationIndexer(T nativeEntry, Association association)
    
    Obtains an indexer for the given association
    Parameters:
    nativeEntry - The native entry
    association - The association
    Returns:
    An indexer
  - public ClassMapping getClassMapping()
  - protected T getEmbedded(T nativeEntry, java.lang.String key)
    
    Implementors should override to provide support for embedded objects.
    Parameters:
    nativeEntry - The native entry to read the embedded instance from
    key - The key
    Returns:
    The native entry of the embedded instance
  - public abstract java.lang.String getEntityFamily()
  - protected abstract java.lang.Object getEntryValue(T nativeEntry, java.lang.String property)
    
    Reads a value for the given key from the native entry
    Parameters:
    nativeEntry - The native entry. Could be a ColumnFamily, a BigTable entity, a Map etc.
    property - The property key
    Returns:
    The value
  - protected java.lang.String getIdentifierName(ClassMapping cm)
    
    Obtains the identifier name to use. Subclasses can override to provide their own strategy for looking up an identifier name
    Parameters:
    cm - The ClassMapping instance
    Returns:
    The identifier name
  - protected java.util.Collection getManyToManyKeys(PersistentEntity persistentEntity, java.lang.Object obj, java.io.Serializable nativeKey, T nativeEntry, ManyToMany manyToMany)
  - protected java.lang.String getNativePropertyKey(PersistentProperty prop)
  - private AbstractPersistentCollection getPersistentCollection(java.util.Collection associatedObjects, java.lang.Class associationType)
  - public abstract PropertyValueIndexer getPropertyIndexer(PersistentProperty property)
    
    Obtains an indexer for a particular property
    Parameters:
    property - The property to index
    Returns:
    The indexer
  - protected java.lang.String getPropertyKey(PersistentProperty prop)
  - private void handleCustom(PersistentProperty prop, EntityAccess ea, T nativeEntry)
  - protected T handleEmbeddedInstance(Association association, java.lang.Object embeddedInstance)
  - protected T handleEmbeddedInstance(Association association, java.lang.Object embeddedInstance, boolean includeNulls)
  - protected void handleEmbeddedToMany(EntityAccess entityAccess, T e, PersistentProperty prop, java.lang.String key)
  - protected void handleEmbeddedToOne(Association association, java.lang.String key, EntityAccess entityAccess, T nativeEntry)
  - private void handleIndexing(boolean update, T e, java.util.Map<PersistentProperty, java.lang.Object> toIndex, java.util.Map<PersistentProperty, java.lang.Object> toUnindex, PersistentProperty prop, java.lang.String key, boolean indexed, java.lang.Object propValue)
  - protected java.lang.Object inferNativeKey(java.lang.String family, java.lang.Object identifier)
    
    Used to establish the native key to use from the identifier defined by the object
    Parameters:
    family - The family
    identifier - The identifier specified by the object
    Returns:
    The native key which may just be a cast from the identifier parameter to K
  - public boolean isDirty(java.lang.Object instance, java.lang.Object entry)
  - protected boolean isEmbeddedEntry(java.lang.Object entry)
    
    Tests whether a native entry is an embedded entry
    Parameters:
    entry - The native entry
    Returns:
    True if it is embedded
  - private boolean isInitializedCollection(java.util.Collection associatedObjects)
  - private boolean isLazyAssociation(PropertyMapping<Property> associationPropertyMapping)
  - @java.lang.Override public boolean isLocked(java.lang.Object o)
    
    Subclasses can override to provide locking semantics
    Parameters:
    o - The object
    Returns:
    True if the object is locked
  - private boolean isNotUpdateForAssignedId(PersistentEntity persistentEntity, java.lang.Object obj, boolean update, boolean assignedId, SessionImplementor<java.lang.Object> si)
  - protected boolean isPropertyIndexed(Property mappedProperty)
  - protected void loadEmbeddedCollection(EmbeddedCollection embeddedCollection, EntityAccess ea, java.lang.Object embeddedInstances, java.lang.String propertyKey)
    
    Implementors who want to the ability to read embedded collections should implement this method
    Parameters:
    embeddedCollection - The EmbeddedCollection instance
    ea - The EntityAccess instance
    embeddedInstances - The embedded instances
    propertyKey - The property key
  - protected java.util.List loadEmbeddedCollectionKeys(Association association, EntityAccess ea, T nativeEntry)
    
    Implementors who want to support one-to-many associations embedded should implement this method
    Parameters:
    association - The association
    ea
    nativeEntry
    Returns:
    A list of keys loaded from the embedded instance
  - @java.lang.Override public final java.lang.Object lock(java.io.Serializable id)
  - @java.lang.Override public final java.lang.Object lock(java.io.Serializable id, int timeout)
  - protected void lockEntry(PersistentEntity persistentEntity, java.lang.String entityFamily, java.io.Serializable id, int timeout)
    
    Subclasses can override to provide locking semantics
    Parameters:
    persistentEntity - The PesistentEntity instnace
    entityFamily - The family
    id - The identifer
    timeout - The lock timeout in seconds
  - @java.lang.Override protected java.util.List<java.io.Serializable> persistEntities(PersistentEntity persistentEntity, java.lang.Iterable objs)
    
    This is a rather simplistic and unoptimized implementation. Subclasses can override to provide batch insert capabilities to optimize the insertion of multiple entities in one go
    Parameters:
    persistentEntity - The persistent entity
    objs - The objext to persist
    Returns:
    A list of keys
  - @java.lang.Override protected java.io.Serializable persistEntity(PersistentEntity persistentEntity, java.lang.Object obj, boolean isInsert)
  - @java.lang.Override protected final java.io.Serializable persistEntity(PersistentEntity persistentEntity, java.lang.Object obj)
  - protected K readIdentifierFromObject(java.lang.Object object)
  - protected K readObjectIdentifier(EntityAccess entityAccess, ClassMapping cm)
    
    Reads an objects identifier using the entity access and ClassMapping instance
    Parameters:
    entityAccess
    cm
    Returns:
    The object identifier
  - public java.io.Serializable refresh(java.lang.Object o)
  - protected void refreshObjectStateFromNativeEntry(PersistentEntity persistentEntity, java.lang.Object obj, java.io.Serializable nativeKey, T nativeEntry)
  - protected void refreshObjectStateFromNativeEntry(PersistentEntity persistentEntity, java.lang.Object obj, java.io.Serializable nativeKey, T nativeEntry, boolean isEmbedded)
  - private java.lang.Object replaceNullOrUninitialized(java.lang.Object c, java.lang.Object other)
  - @java.lang.Override protected java.util.List<java.lang.Object> retrieveAllEntities(PersistentEntity persistentEntity, java.lang.Iterable<java.io.Serializable> keys)
    
    Simplistic default implementation of retrieveAllEntities that iterates over each key and retrieves the entities one-by-one. Data stores that support batch retrieval can optimize this to retrieve all entities in one go.
    Parameters:
    persistentEntity - The persist entity
    keys - The keys
    Returns:
    A list of entities
  - @java.lang.Override protected java.util.List<java.lang.Object> retrieveAllEntities(PersistentEntity persistentEntity, java.io.Serializable[] keys)
    
    Simplistic default implementation of retrieveAllEntities that iterates over each key and retrieves the entities one-by-one. Data stores that support batch retrieval can optimize this to retrieve all entities in one go.
    Parameters:
    persistentEntity - The persist entity
    keys - The keys
    Returns:
    A list of entities
  - @java.lang.Override protected final java.lang.Object retrieveEntity(PersistentEntity persistentEntity, java.io.Serializable nativeKey)
  - protected abstract T retrieveEntry(PersistentEntity persistentEntity, java.lang.String family, java.io.Serializable key)
    
    Reads the native form of a Key/value datastore entry. This could be a ColumnFamily, a BigTable Entity, a Map etc.
    Parameters:
    persistentEntity - The persistent entity
    family - The family
    key - The key
    Returns:
    The native form
  - public void run()
  - public void run()
  - public void run()
  - public void run()
  - protected void setEmbedded(T nativeEntry, java.lang.String key, T embeddedEntry)
    
    Implementors should override this method to provide support for embedded objects
    Parameters:
    nativeEntry - The native entry
    key - The key
    embeddedEntry - The embedded object
  - protected void setEmbeddedCollection(T nativeEntry, java.lang.String key, java.util.Collection<?> instances, java.util.List<T> embeddedEntries)
    
    Implementors should override this method to provide support for embedded objects
    Parameters:
    nativeEntry - The native entry
    key - The key
    instances - the embedded instances
    embeddedEntries - the native entries
  - protected void setEmbeddedCollectionKeys(Association association, EntityAccess embeddedEntityAccess, T embeddedEntry, java.util.List<java.io.Serializable> keys)
  - protected void setEmbeddedMap(T nativeEntry, java.lang.String key, java.util.Map instances, java.util.Map<java.lang.Object, T> embeddedEntries)
    
    Implementors should override this method to provide support for maps of embedded objects
    Parameters:
    nativeEntry - The native entry
    key - The key
    instances - the embedded instances
    embeddedEntries - the native entries
  - protected abstract void setEntryValue(T nativeEntry, java.lang.String key, java.lang.Object value)
    
    Sets a value on an entry
    Parameters:
    nativeEntry - The native entry such as a BigTable Entity, ColumnFamily etc.
    key - The key
    value - The value
  - protected void setManyToMany(PersistentEntity persistentEntity, java.lang.Object obj, T nativeEntry, ManyToMany manyToMany, java.util.Collection associatedObjects, java.util.Map<Association, java.util.List<java.io.Serializable>> toManyKeys)
  - protected abstract K storeEntry(PersistentEntity persistentEntity, EntityAccess entityAccess, K storeId, T nativeEntry)
    
    Stores the native form of a Key/value datastore to the actual data store
    Parameters:
    persistentEntity - The persistent entity
    entityAccess - The EntityAccess
    storeId
    nativeEntry - The native form. Could be a a ColumnFamily, BigTable Entity etc.
    Returns:
    The native key
  - @java.lang.Override public void unlock(java.lang.Object o)
  - protected void unlockEntry(PersistentEntity persistentEntity, java.lang.String entityFamily, java.io.Serializable id)
    
    Subclasses to override to provide locking semantics
    Parameters:
    persistentEntity - The persistent entity
    entityFamily - The entity family
    id - The identifer
  - protected abstract void updateEntry(PersistentEntity persistentEntity, EntityAccess entityAccess, K key, T entry)
    
    Updates an existing entry to the actual datastore
    Parameters:
    persistentEntity - The PersistentEntity
    entityAccess - The EntityAccess
    key - The key of the object to update
    entry - The entry
  - private void updatePropertyIndices(java.lang.Object identifier, java.util.Map<PersistentProperty, java.lang.Object> valuesToIndex, java.util.Map<PersistentProperty, java.lang.Object> valuesToDeindex)
  - private void updateToManyIndices(T nativeEntry, java.lang.Object identifier, java.util.Map<Association, java.util.List<java.io.Serializable>> toManyKeys, boolean preIndex)

| Detail:
Field
Constructor
Method

Groovy Documentation

[Java] Class NativeEntryEntityPersister<T, K>

Nested Class Summary

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final java.lang.String EMBEDDED_PREFIX

protected ClassMapping classMapping

Constructor Detail

public NativeEntryEntityPersister(MappingContext mappingContext, PersistentEntity entity, Session session, org.springframework.context.ApplicationEventPublisher publisher)

public NativeEntryEntityPersister(MappingContext mappingContext, PersistentEntity entity, Session session, org.springframework.context.ApplicationEventPublisher publisher, TPCacheAdapterRepository<T> cacheAdapterRepository)

Method Detail

protected boolean areCollectionsEqual(java.lang.Object oldValue, java.lang.Object currentValue)

protected boolean areEqual(java.lang.Object oldValue, java.lang.Object currentValue, java.lang.String propName)

protected void cacheEmbeddedEntry(PersistentEntity persistentEntity, java.io.Serializable nativeKey, T nativeEntry)

protected void cacheNativeEntry(PersistentEntity persistentEntity, java.io.Serializable nativeKey, T nativeEntry)

protected void cascadeAfterDelete(PersistentEntity persistentEntity, EntityAccess entityAccess, K key, java.lang.Object instance)

protected void cascadeBeforeDelete(PersistentEntity persistentEntity, EntityAccess entityAccess, K key, java.lang.Object instance)

protected void cascadeDeleteCollection(EntityAccess entityAccess, Association association)

protected java.lang.Object convertBasicEntryValue(PersistentEntity persistentEntity, Basic prop, java.lang.Object entryValue)

protected java.io.Serializable convertIdIfNecessary(PersistentEntity entity, java.io.Serializable nativeKey)

protected java.io.Serializable convertToNativeKey(java.io.Serializable nativeKey)

public static java.lang.String createEmbeddedCacheEntryKey(java.lang.Object instance)

protected EntityAccess createEntityAccess(PersistentEntity persistentEntity, java.lang.Object obj, T nativeEntry)

public T createNativeObjectForEmbedded(Association embedded, java.lang.Object instance)

protected abstract T createNewEntry(java.lang.String family)

protected T createNewEntry(java.lang.String family, java.lang.Object instance)

public java.lang.Object createObjectFromEmbeddedNativeEntry(PersistentEntity persistentEntity, T nativeEntry)

public java.lang.Object createObjectFromNativeEntry(PersistentEntity persistentEntity, java.io.Serializable nativeKey, T nativeEntry)

@java.lang.Override protected final void deleteEntities(PersistentEntity persistentEntity, java.lang.Iterable objects)

@java.lang.Override protected void deleteEntity(PersistentEntity persistentEntity, java.lang.Object obj)

protected abstract void deleteEntries(java.lang.String family, java.util.List<K> keys)

protected abstract void deleteEntry(java.lang.String family, K key, java.lang.Object entry)

protected PersistentEntity discriminatePersistentEntity(PersistentEntity persistentEntity, T nativeEntry)

protected boolean doManualDirtyCheck(java.lang.Object instance, java.lang.Object entry)

protected boolean doesRequirePropertyIndexing()

protected K executeInsert(PersistentEntity persistentEntity, NativeEntryEntityPersister.NativeEntryModifyingEntityAccess entityAccess, K id, T e)

protected java.lang.Object formulateDatabaseReference(PersistentEntity persistentEntity, Association association, java.io.Serializable associationId)

protected abstract K generateIdentifier(PersistentEntity persistentEntity, T entry)

public abstract AssociationIndexer getAssociationIndexer(T nativeEntry, Association association)

public ClassMapping getClassMapping()

protected T getEmbedded(T nativeEntry, java.lang.String key)

public abstract java.lang.String getEntityFamily()

protected abstract java.lang.Object getEntryValue(T nativeEntry, java.lang.String property)

protected java.lang.String getIdentifierName(ClassMapping cm)

protected java.util.Collection getManyToManyKeys(PersistentEntity persistentEntity, java.lang.Object obj, java.io.Serializable nativeKey, T nativeEntry, ManyToMany manyToMany)

protected java.lang.String getNativePropertyKey(PersistentProperty prop)

private AbstractPersistentCollection getPersistentCollection(java.util.Collection associatedObjects, java.lang.Class associationType)

public abstract PropertyValueIndexer getPropertyIndexer(PersistentProperty property)

protected java.lang.String getPropertyKey(PersistentProperty prop)

private void handleCustom(PersistentProperty prop, EntityAccess ea, T nativeEntry)

protected T handleEmbeddedInstance(Association association, java.lang.Object embeddedInstance)

protected T handleEmbeddedInstance(Association association, java.lang.Object embeddedInstance, boolean includeNulls)

protected void handleEmbeddedToMany(EntityAccess entityAccess, T e, PersistentProperty prop, java.lang.String key)

protected void handleEmbeddedToOne(Association association, java.lang.String key, EntityAccess entityAccess, T nativeEntry)

private void handleIndexing(boolean update, T e, java.util.Map<PersistentProperty, java.lang.Object> toIndex, java.util.Map<PersistentProperty, java.lang.Object> toUnindex, PersistentProperty prop, java.lang.String key, boolean indexed, java.lang.Object propValue)

protected java.lang.Object inferNativeKey(java.lang.String family, java.lang.Object identifier)

public boolean isDirty(java.lang.Object instance, java.lang.Object entry)

protected boolean isEmbeddedEntry(java.lang.Object entry)

private boolean isInitializedCollection(java.util.Collection associatedObjects)

private boolean isLazyAssociation(PropertyMapping<Property> associationPropertyMapping)

@java.lang.Override public boolean isLocked(java.lang.Object o)

private boolean isNotUpdateForAssignedId(PersistentEntity persistentEntity, java.lang.Object obj, boolean update, boolean assignedId, SessionImplementor<java.lang.Object> si)

protected boolean isPropertyIndexed(Property mappedProperty)

protected void loadEmbeddedCollection(EmbeddedCollection embeddedCollection, EntityAccess ea, java.lang.Object embeddedInstances, java.lang.String propertyKey)

protected java.util.List loadEmbeddedCollectionKeys(Association association, EntityAccess ea, T nativeEntry)

@java.lang.Override public final java.lang.Object lock(java.io.Serializable id)

@java.lang.Override public final java.lang.Object lock(java.io.Serializable id, int timeout)

protected void lockEntry(PersistentEntity persistentEntity, java.lang.String entityFamily, java.io.Serializable id, int timeout)

@java.lang.Override protected java.util.List<java.io.Serializable> persistEntities(PersistentEntity persistentEntity, java.lang.Iterable objs)

@java.lang.Override protected java.io.Serializable persistEntity(PersistentEntity persistentEntity, java.lang.Object obj, boolean isInsert)

@java.lang.Override protected final java.io.Serializable persistEntity(PersistentEntity persistentEntity, java.lang.Object obj)

protected K readIdentifierFromObject(java.lang.Object object)

protected K readObjectIdentifier(EntityAccess entityAccess, ClassMapping cm)

public java.io.Serializable refresh(java.lang.Object o)

protected void refreshObjectStateFromNativeEntry(PersistentEntity persistentEntity, java.lang.Object obj, java.io.Serializable nativeKey, T nativeEntry)

protected void refreshObjectStateFromNativeEntry(PersistentEntity persistentEntity, java.lang.Object obj, java.io.Serializable nativeKey, T nativeEntry, boolean isEmbedded)

private java.lang.Object replaceNullOrUninitialized(java.lang.Object c, java.lang.Object other)

@java.lang.Override protected java.util.List<java.lang.Object> retrieveAllEntities(PersistentEntity persistentEntity, java.lang.Iterable<java.io.Serializable> keys)