org.hibernate.envers.internal.entities.mapper.relation

Class AbstractToOneMapper

java.lang.Object

org.hibernate.envers.internal.entities.mapper.AbstractPropertyMapper

org.hibernate.envers.internal.entities.mapper.relation.AbstractToOneMapper

All Implemented Interfaces:

DynamicComponentMapperSupport, ModifiedFlagMapperSupport, PropertyMapper

Direct Known Subclasses:

AbstractOneToOneMapper, ToOneIdMapper

public abstract class AbstractToOneMapper
extends AbstractPropertyMapper

Base class for property mappers that manage to-one relation.

Author:

Lukasz Antoniak (lukasz dot antoniak at gmail dot com), Chris Cranford

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractToOneMapper.EntityInfo Simple descriptor of an entity.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractToOneMapper(ServiceRegistry serviceRegistry, PropertyData propertyData)

Method Summary

Modifier and Type	Method and Description
protected AbstractToOneMapper.EntityInfo	getEntityInfo(EnversService enversService, String entityName)
protected PropertyData	getPropertyData()
boolean	hasPropertiesWithModifiedFlag() Returns whether the associated PropertyMapper has any properties that use the witModifiedFlag feature.
List<PersistentCollectionChangeData>	mapCollectionChanges(SessionImplementor session, String referencingPropertyName, PersistentCollection newColl, Serializable oldColl, Serializable id) Maps collection changes.
void	mapToEntityFromMap(EnversService enversService, Object obj, Map data, Object primaryKey, AuditReaderImplementor versionsReader, Number revision) Maps properties from the given map to the given object.
boolean	mapToMapFromEntity(SessionImplementor session, Map<String,Object> data, Object newObj, Object oldObj) Maps properties to the given map, basing on differences between properties of new and old objects.
abstract void	nullSafeMapToEntityFromMap(EnversService enversService, Object obj, Map data, Object primaryKey, AuditReaderImplementor versionsReader, Number revision) Parameter obj is never null.
protected void	setPropertyValue(Object targetObject, Object value)

Methods inherited from class org.hibernate.envers.internal.entities.mapper.AbstractPropertyMapper

isDynamicComponentMap, markAsDynamicComponentMap

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hibernate.envers.internal.entities.mapper.PropertyMapper

mapModifiedFlagsToMapForCollectionChange, mapModifiedFlagsToMapFromEntity

Constructor Detail

AbstractToOneMapper

protected AbstractToOneMapper(ServiceRegistry serviceRegistry,
                              PropertyData propertyData)

Method Detail

mapToMapFromEntity

public boolean mapToMapFromEntity(SessionImplementor session,
                                  Map<String,Object> data,
                                  Object newObj,
                                  Object oldObj)

Description copied from interface: PropertyMapper

Maps properties to the given map, basing on differences between properties of new and old objects.

Parameters:

session - The current session.

data - Data to map to.

newObj - New state of the entity.

oldObj - Old state of the entity.

Returns:

True if there are any differences between the states represented by newObj and oldObj.

mapToEntityFromMap

public void mapToEntityFromMap(EnversService enversService,
                               Object obj,
                               Map data,
                               Object primaryKey,
                               AuditReaderImplementor versionsReader,
                               Number revision)

Description copied from interface: PropertyMapper

Maps properties from the given map to the given object.

Parameters:

enversService - The EnversService.

obj - Object to map to.

data - Data to map from.

primaryKey - Primary key of the object to which we map (for relations)

versionsReader - VersionsReader for reading relations

revision - Revision at which the object is read, for reading relations

mapCollectionChanges

public List<PersistentCollectionChangeData> mapCollectionChanges(SessionImplementor session,
                                                                 String referencingPropertyName,
                                                                 PersistentCollection newColl,
                                                                 Serializable oldColl,
                                                                 Serializable id)

Description copied from interface: PropertyMapper

Maps collection changes.

Parameters:

session - The current session.

referencingPropertyName - Name of the field, which holds the collection in the entity.

newColl - New collection, after updates.

oldColl - Old collection, before updates.

id - Id of the object owning the collection.

Returns:

List of changes that need to be performed on the persistent store.

getEntityInfo

protected AbstractToOneMapper.EntityInfo getEntityInfo(EnversService enversService,
                                                       String entityName)

Parameters:

enversService - The EnversService

entityName - Entity name.

Returns:

Entity class, name and information whether it is audited or not.

setPropertyValue

protected void setPropertyValue(Object targetObject,
                                Object value)

getPropertyData

protected PropertyData getPropertyData()

Returns:

Bean property that represents the relation.

nullSafeMapToEntityFromMap

public abstract void nullSafeMapToEntityFromMap(EnversService enversService,
                                                Object obj,
                                                Map data,
                                                Object primaryKey,
                                                AuditReaderImplementor versionsReader,
                                                Number revision)

Parameter obj is never null.

hasPropertiesWithModifiedFlag

public boolean hasPropertiesWithModifiedFlag()

Description copied from interface: ModifiedFlagMapperSupport

Returns whether the associated PropertyMapper has any properties that use the witModifiedFlag feature.

Returns:

true if a property uses withModifiedFlag, otherwise false.