EntityPersister (Grails Data Mapping API

org.grails.datastore.mapping.engine.EntityPersister

All Implemented Interfaces and Traits:

Persister
```
public abstract class EntityPersister
extends java.lang.Object
implements Persister
```
A Persister specifically for persisting PersistentEntity instances.
Authors:
Graeme Rocher
Since:
1.0

Field Summary

Fields
Modifiers	Name	Description
`protected ProxyFactory`	`proxyFactory`
`protected ApplicationEventPublisher`	`publisher`
`protected EntityReflector`	`reflector`
`protected Session`	`session`

Constructor Summary

Constructors
Constructor and description
`EntityPersister(MappingContext mappingContext, PersistentEntity entity, Session session, ApplicationEventPublisher publisher)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`public boolean`	`cancelDelete(PersistentEntity persistentEntity, EntityAccess entityAccess)` Fire the beforeDelete event on an entityAccess object and return true if the operation should be cancelled
	`public boolean`	`cancelInsert(PersistentEntity persistentEntity, EntityAccess entityAccess)` Fire the beforeInsert even on an entityAccess object and return true if the operation should be cancelled
	`public boolean`	`cancelLoad(PersistentEntity persistentEntity, EntityAccess entityAccess)` Fire the beforeDelete event on an entityAccess object and return true if the operation should be cancelled
	`public boolean`	`cancelUpdate(PersistentEntity persistentEntity, EntityAccess entityAccess)` Fire the beforeUpdate event on an entityAccess object and return true if the operation should be cancelled
	`protected EntityAccess`	`createEntityAccess(PersistentEntity pe, java.lang.Object obj)`
	`public final void`	`delete(java.lang.Iterable objects)`
	`public void`	`delete(java.lang.Object obj)`
	`protected abstract void`	`deleteEntities(PersistentEntity pe, java.lang.Iterable objects)`
	`protected abstract void`	`deleteEntity(PersistentEntity pe, java.lang.Object obj)`
	`public void`	`firePostDeleteEvent(PersistentEntity persistentEntity, EntityAccess entityAccess)`
	`public void`	`firePostInsertEvent(PersistentEntity persistentEntity, EntityAccess entityAccess)`
	`public void`	`firePostLoadEvent(PersistentEntity persistentEntity, EntityAccess entityAccess)`
	`public void`	`firePostUpdateEvent(PersistentEntity persistentEntity, EntityAccess entityAccess)`
	`public void`	`firePreLoadEvent(PersistentEntity persistentEntity, EntityAccess entityAccess)`
	`public java.lang.Object`	`getCurrentVersion(EntityAccess ea)`
	`public MappingContext`	`getMappingContext()` Returns: The MappingContext instance
	`public java.io.Serializable`	`getObjectIdentifier(java.lang.Object obj)` Obtains an objects identifer
	`public PersistentEntity`	`getPersistentEntity()` Returns: The PersistentEntity instance
	`public ProxyFactory`	`getProxyFactory()`
	`public Session`	`getSession()`
	`public java.lang.Class`	`getType()`
	`public static void`	`incrementEntityVersion(EntityAccess ea)`
	`public void`	`incrementVersion(EntityAccess ea)`
	`public java.io.Serializable`	`insert(java.lang.Object obj)`
	`protected boolean`	`isAssignedId(PersistentEntity persistentEntity)`
	`public boolean`	`isVersioned(EntityAccess ea)`
	`protected java.lang.Object`	`newEntityInstance(PersistentEntity persistentEntity)`
	`public final java.io.Serializable`	`persist(java.lang.Object obj)` Persists an object returning the identifier
	`public java.util.List<java.io.Serializable>`	`persist(java.lang.Iterable objs)`
	`protected abstract java.util.List<java.io.Serializable>`	`persistEntities(PersistentEntity pe, java.lang.Iterable objs)`
	`protected java.io.Serializable`	`persistEntity(PersistentEntity entity, java.lang.Object obj, boolean isInsert)` Subclasses should override to support explicit inserts
	`protected abstract java.io.Serializable`	`persistEntity(PersistentEntity pe, java.lang.Object obj)` Persist the given persistent entity
	`public java.lang.Object`	`proxy(java.io.Serializable key)`
	`public final java.lang.Object`	`retrieve(java.io.Serializable key)`
	`public java.util.List<java.lang.Object>`	`retrieveAll(java.lang.Iterable<java.io.Serializable> keys)`
	`public java.util.List<java.lang.Object>`	`retrieveAll(java.io.Serializable[] keys)`
	`protected abstract java.util.List<java.lang.Object>`	`retrieveAllEntities(PersistentEntity pe, java.io.Serializable[] keys)`
	`protected abstract java.util.List<java.lang.Object>`	`retrieveAllEntities(PersistentEntity pe, java.lang.Iterable<java.io.Serializable> keys)`
	`protected abstract java.lang.Object`	`retrieveEntity(PersistentEntity pe, java.io.Serializable key)` Retrieve a PersistentEntity for the given mappingContext and key
	`protected void`	`setDateVersion(EntityAccess ea)`
	`public void`	`setObjectIdentifier(java.lang.Object obj, java.io.Serializable id)` Obtains an objects identifer
	`protected void`	`setVersion(EntityAccess ea)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#equals(java.lang.Object), java.lang.Object#getClass(), java.lang.Object#hashCode(), java.lang.Object#notify(), java.lang.Object#notifyAll(), java.lang.Object#toString(), java.lang.Object#wait(), java.lang.Object#wait(long), java.lang.Object#wait(long, int)`

- Field Detail
  - protected ProxyFactory proxyFactory
  - protected final ApplicationEventPublisher publisher
  - protected final EntityReflector reflector
  - protected final Session session
- Constructor Detail
  - public EntityPersister(MappingContext mappingContext, PersistentEntity entity, Session session, ApplicationEventPublisher publisher)
- Method Detail
  - public boolean cancelDelete(PersistentEntity persistentEntity, EntityAccess entityAccess)
    
    Fire the beforeDelete event on an entityAccess object and return true if the operation should be cancelled
    Parameters:
    persistentEntity - The entity
    entityAccess - The entity access
    Returns:
    true if the operation should be cancelled
  - public boolean cancelInsert(PersistentEntity persistentEntity, EntityAccess entityAccess)
    
    Fire the beforeInsert even on an entityAccess object and return true if the operation should be cancelled
    Parameters:
    persistentEntity - The entity
    entityAccess - The entity access
    Returns:
    true if the operation should be cancelled
  - public boolean cancelLoad(PersistentEntity persistentEntity, EntityAccess entityAccess)
    
    Fire the beforeDelete event on an entityAccess object and return true if the operation should be cancelled
    Parameters:
    persistentEntity - The entity
    entityAccess - The entity access
    Returns:
    true if the operation should be cancelled
  - public boolean cancelUpdate(PersistentEntity persistentEntity, EntityAccess entityAccess)
    
    Fire the beforeUpdate event on an entityAccess object and return true if the operation should be cancelled
    Parameters:
    persistentEntity - The entity
    entityAccess - The entity access
    Returns:
    true if the operation should be cancelled
  - protected EntityAccess createEntityAccess(PersistentEntity pe, java.lang.Object obj)
  - public final void delete(@java.lang.SuppressWarnings("rawtypes")
    java.lang.Iterable objects)
  - public void delete(java.lang.Object obj)
  - protected abstract void deleteEntities(PersistentEntity pe, @java.lang.SuppressWarnings("rawtypes")
    java.lang.Iterable objects)
  - protected abstract void deleteEntity(PersistentEntity pe, java.lang.Object obj)
  - public void firePostDeleteEvent(PersistentEntity persistentEntity, EntityAccess entityAccess)
  - public void firePostInsertEvent(PersistentEntity persistentEntity, EntityAccess entityAccess)
  - public void firePostLoadEvent(PersistentEntity persistentEntity, EntityAccess entityAccess)
  - public void firePostUpdateEvent(PersistentEntity persistentEntity, EntityAccess entityAccess)
  - public void firePreLoadEvent(PersistentEntity persistentEntity, EntityAccess entityAccess)
  - public java.lang.Object getCurrentVersion(EntityAccess ea)
  - public MappingContext getMappingContext()
    
    Returns:
    The MappingContext instance
  - public java.io.Serializable getObjectIdentifier(java.lang.Object obj)
    
    Obtains an objects identifer
    Parameters:
    obj - The object
    Returns:
    The identifier or null if it doesn't have one
  - public PersistentEntity getPersistentEntity()
    
    Returns:
    The PersistentEntity instance
  - public ProxyFactory getProxyFactory()
  - public Session getSession()
  - @java.lang.SuppressWarnings("rawtypes")
    public java.lang.Class getType()
  - public static void incrementEntityVersion(EntityAccess ea)
  - public void incrementVersion(EntityAccess ea)
  - @java.lang.Override
    public java.io.Serializable insert(java.lang.Object obj)
  - protected boolean isAssignedId(PersistentEntity persistentEntity)
  - public boolean isVersioned(EntityAccess ea)
  - protected java.lang.Object newEntityInstance(PersistentEntity persistentEntity)
  - public final java.io.Serializable persist(java.lang.Object obj)
    
    Persists an object returning the identifier
    Parameters:
    obj - The object to persist
    Returns:
    The identifer
  - public java.util.List<java.io.Serializable> persist(@java.lang.SuppressWarnings("rawtypes")
    java.lang.Iterable objs)
  - protected abstract java.util.List<java.io.Serializable> persistEntities(PersistentEntity pe, @java.lang.SuppressWarnings("rawtypes")
    java.lang.Iterable objs)
  - protected java.io.Serializable persistEntity(PersistentEntity entity, java.lang.Object obj, boolean isInsert)
    
    Subclasses should override to support explicit inserts
    Parameters:
    entity - The entity
    obj - The object
    isInsert - Whether it is an insert
    Returns:
    The id
  - protected abstract java.io.Serializable persistEntity(PersistentEntity pe, java.lang.Object obj)
    
    Persist the given persistent entity
    Parameters:
    pe - The PersistentEntity
    obj
    Returns:
    The generated key
  - @java.lang.SuppressWarnings("unchecked")
    public java.lang.Object proxy(java.io.Serializable key)
  - public final java.lang.Object retrieve(java.io.Serializable key)
  - public java.util.List<java.lang.Object> retrieveAll(java.lang.Iterable<java.io.Serializable> keys)
  - public java.util.List<java.lang.Object> retrieveAll(java.io.Serializable[] keys)
  - protected abstract java.util.List<java.lang.Object> retrieveAllEntities(PersistentEntity pe, java.io.Serializable[] keys)
  - protected abstract java.util.List<java.lang.Object> retrieveAllEntities(PersistentEntity pe, java.lang.Iterable<java.io.Serializable> keys)
  - protected abstract java.lang.Object retrieveEntity(PersistentEntity pe, java.io.Serializable key)
    
    Retrieve a PersistentEntity for the given mappingContext and key
    Parameters:
    pe - The entity
    key - The key
    Returns:
    The object or null if it doesn't exist
  - protected void setDateVersion(EntityAccess ea)
  - public void setObjectIdentifier(java.lang.Object obj, java.io.Serializable id)
    
    Obtains an objects identifer
    Parameters:
    obj - The object
  - protected void setVersion(EntityAccess ea)

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

Groovy Documentation

[Java] Class EntityPersister

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected ProxyFactory proxyFactory

protected final ApplicationEventPublisher publisher

protected final EntityReflector reflector

protected final Session session

Constructor Detail

public EntityPersister(MappingContext mappingContext, PersistentEntity entity, Session session, ApplicationEventPublisher publisher)

Method Detail

public boolean cancelDelete(PersistentEntity persistentEntity, EntityAccess entityAccess)

public boolean cancelInsert(PersistentEntity persistentEntity, EntityAccess entityAccess)

public boolean cancelLoad(PersistentEntity persistentEntity, EntityAccess entityAccess)

public boolean cancelUpdate(PersistentEntity persistentEntity, EntityAccess entityAccess)

protected EntityAccess createEntityAccess(PersistentEntity pe, java.lang.Object obj)

public final void delete(@java.lang.SuppressWarnings("rawtypes")java.lang.Iterable objects)

public void delete(java.lang.Object obj)

protected abstract void deleteEntities(PersistentEntity pe, @java.lang.SuppressWarnings("rawtypes")java.lang.Iterable objects)

protected abstract void deleteEntity(PersistentEntity pe, java.lang.Object obj)

public void firePostDeleteEvent(PersistentEntity persistentEntity, EntityAccess entityAccess)

public void firePostInsertEvent(PersistentEntity persistentEntity, EntityAccess entityAccess)

public void firePostLoadEvent(PersistentEntity persistentEntity, EntityAccess entityAccess)

public void firePostUpdateEvent(PersistentEntity persistentEntity, EntityAccess entityAccess)

public void firePreLoadEvent(PersistentEntity persistentEntity, EntityAccess entityAccess)

public java.lang.Object getCurrentVersion(EntityAccess ea)

public MappingContext getMappingContext()

public java.io.Serializable getObjectIdentifier(java.lang.Object obj)

public PersistentEntity getPersistentEntity()

public ProxyFactory getProxyFactory()

public Session getSession()

@java.lang.SuppressWarnings("rawtypes")public java.lang.Class getType()

public static void incrementEntityVersion(EntityAccess ea)

public void incrementVersion(EntityAccess ea)

@java.lang.Overridepublic java.io.Serializable insert(java.lang.Object obj)

protected boolean isAssignedId(PersistentEntity persistentEntity)

public boolean isVersioned(EntityAccess ea)

protected java.lang.Object newEntityInstance(PersistentEntity persistentEntity)

public final java.io.Serializable persist(java.lang.Object obj)

public java.util.List<java.io.Serializable> persist(@java.lang.SuppressWarnings("rawtypes")java.lang.Iterable objs)

protected abstract java.util.List<java.io.Serializable> persistEntities(PersistentEntity pe, @java.lang.SuppressWarnings("rawtypes")java.lang.Iterable objs)

protected java.io.Serializable persistEntity(PersistentEntity entity, java.lang.Object obj, boolean isInsert)

protected abstract java.io.Serializable persistEntity(PersistentEntity pe, java.lang.Object obj)

@java.lang.SuppressWarnings("unchecked")public java.lang.Object proxy(java.io.Serializable key)

public final java.lang.Object retrieve(java.io.Serializable key)

public java.util.List<java.lang.Object> retrieveAll(java.lang.Iterable<java.io.Serializable> keys)

public java.util.List<java.lang.Object> retrieveAll(java.io.Serializable[] keys)

protected abstract java.util.List<java.lang.Object> retrieveAllEntities(PersistentEntity pe, java.io.Serializable[] keys)

protected abstract java.util.List<java.lang.Object> retrieveAllEntities(PersistentEntity pe, java.lang.Iterable<java.io.Serializable> keys)

protected abstract java.lang.Object retrieveEntity(PersistentEntity pe, java.io.Serializable key)

protected void setDateVersion(EntityAccess ea)

public void setObjectIdentifier(java.lang.Object obj, java.io.Serializable id)

protected void setVersion(EntityAccess ea)

public final void delete(@java.lang.SuppressWarnings("rawtypes")
java.lang.Iterable objects)

protected abstract void deleteEntities(PersistentEntity pe, @java.lang.SuppressWarnings("rawtypes")
java.lang.Iterable objects)

@java.lang.SuppressWarnings("rawtypes")
public java.lang.Class getType()

@java.lang.Override
public java.io.Serializable insert(java.lang.Object obj)

public java.util.List<java.io.Serializable> persist(@java.lang.SuppressWarnings("rawtypes")
java.lang.Iterable objs)

protected abstract java.util.List<java.io.Serializable> persistEntities(PersistentEntity pe, @java.lang.SuppressWarnings("rawtypes")
java.lang.Iterable objs)

@java.lang.SuppressWarnings("unchecked")
public java.lang.Object proxy(java.io.Serializable key)