Package org.hibernate.envers.internal.entities.mapper.id

Class EmbeddedIdMapper

java.lang.Object

org.hibernate.envers.internal.entities.mapper.AbstractMapper

org.hibernate.envers.internal.entities.mapper.id.AbstractIdMapper

org.hibernate.envers.internal.entities.mapper.id.AbstractCompositeIdMapper

org.hibernate.envers.internal.entities.mapper.id.EmbeddedIdMapper

All Implemented Interfaces:

IdMapper, SimpleIdMapperBuilder, SimpleMapperBuilder

Direct Known Subclasses:

NestedEmbeddedIdMapper

public class EmbeddedIdMapper
extends AbstractCompositeIdMapper
implements SimpleIdMapperBuilder

An identifier mapper implementation for EmbeddedId mappings.

Field Summary

Fields inherited from class org.hibernate.envers.internal.entities.mapper.id.AbstractCompositeIdMapper

compositeIdClass, ids

Constructor Summary

Constructors

Constructor	Description
EmbeddedIdMapper(PropertyData propertyData, Component component)

Method Summary

Modifier and Type	Method	Description
boolean	mapToEntityFromMap(Object obj, Map data)
Object	mapToIdFromEntity(Object data)
void	mapToMapFromEntity(Map<String,Object> data, Object obj)
void	mapToMapFromId(Map<String,Object> data, Object obj)
List<QueryParameterData>	mapToQueryParametersFromId(Object obj)
IdMapper	prefixMappedProperties(String prefix)	Creates a mapper with all mapped properties prefixed.

Methods inherited from class org.hibernate.envers.internal.entities.mapper.id.AbstractCompositeIdMapper

add, add, instantiateCompositeId, mapToEntityFromEntity, mapToIdFromMap

Methods inherited from class org.hibernate.envers.internal.entities.mapper.id.AbstractIdMapper

addIdEqualsToQuery, addIdsEqualToQuery, addIdsEqualToQuery, addNamedIdEqualsToQuery, addNamedIdEqualsToQuery, addNullableIdsEqualToQuery, getAndSetValue, getServiceRegistry, getValueFromObject, setValueOnObject

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

doPrivileged, getAndSetValue, getValueFromObject, getValueFromObject, newObjectInstance, setValueOnObject

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.id.IdMapper

addIdEqualsToQuery, addIdsEqualToQuery, addIdsEqualToQuery, addNamedIdEqualsToQuery, addNamedIdEqualsToQuery, addNullableIdsEqualToQuery, getServiceRegistry, mapToIdFromMap, mapToMapFromId

Methods inherited from interface org.hibernate.envers.internal.entities.mapper.id.SimpleIdMapperBuilder

add

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

add

Constructor Detail

EmbeddedIdMapper

public EmbeddedIdMapper(PropertyData propertyData,
                        Component component)

Method Detail

mapToMapFromId

public void mapToMapFromId(Map<String,Object> data,
                           Object obj)

Specified by:

mapToMapFromId in interface IdMapper

mapToMapFromEntity

public void mapToMapFromEntity(Map<String,Object> data,
                               Object obj)

Specified by:

mapToMapFromEntity in interface IdMapper

mapToEntityFromMap

public boolean mapToEntityFromMap(Object obj,
                                  Map data)

Specified by:

mapToEntityFromMap in interface IdMapper

Parameters:

obj - Object to map to.

data - Data to map.

Returns:

True if data was mapped; false otherwise (when the id is null).

prefixMappedProperties

public IdMapper prefixMappedProperties(String prefix)

Description copied from interface: IdMapper

Creates a mapper with all mapped properties prefixed. A mapped property is a property which is directly mapped to values (not composite).

Specified by:

prefixMappedProperties in interface IdMapper

Parameters:

prefix - Prefix to add to mapped properties

Returns:

A copy of the current property mapper, with mapped properties prefixed.

mapToIdFromEntity

public Object mapToIdFromEntity(Object data)

Specified by:

mapToIdFromEntity in interface IdMapper

mapToQueryParametersFromId

public List<QueryParameterData> mapToQueryParametersFromId(Object obj)

Specified by:

mapToQueryParametersFromId in interface IdMapper

Parameters:

obj - Id from which to map.

Returns:

A set parameter data, needed to build a query basing on the given id.