Package org.modelmapper.spring.data

Class AggregateMappingModule

java.lang.Object

org.modelmapper.spring.data.AggregateMappingModule

All Implemented Interfaces:

org.modelmapper.Module

public class AggregateMappingModule
extends Object
implements org.modelmapper.Module

ModelMapper module to allow the mapping of identifiers of variable kinds into aggregate references loadable via Spring Data repositories. Failed aggregate resolution will be reported via an AggregateMappingModule.AggregateReferenceMappingException unless the type has a dedicated AggregateMappingModule.NullHandling registered.

Author:

Oliver Drotbohm

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AggregateMappingModule.AggregateReferenceMappingException	A MappingException being thrown in case no aggregate can be resolved for a given source value.
static enum	AggregateMappingModule.NullHandling

Constructor Summary

Constructors

Constructor	Description
AggregateMappingModule(org.springframework.data.repository.support.Repositories repositories, org.springframework.core.convert.ConversionService conversions)	Creates a new AggregateMappingModule from the given Repositories and ConversionService.

Method Summary

Modifier and Type	Method	Description
AggregateMappingModule	defaultNullHandling(AggregateMappingModule.NullHandling nullHandling)	Registers the given AggregateMappingModule.NullHandling as the one to be applied by default.
AggregateMappingModule	exclude(Class<?> type)	Excludes the given domain type from the aggregate resolution mapping.
AggregateMappingModule	nullHandling(Class<?> type, AggregateMappingModule.NullHandling nullHandling)	Registers a dedicated AggregateMappingModule.NullHandling for the given type.
AggregateMappingModule	register(AggregateIdentifierProcessor processor)	Registers an IdentifierProcessor to be used to pre- and post-process identifiers during conversions.
void	setupModule(org.modelmapper.ModelMapper mapper)

Methods inherited from class java.lang.Object

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

Constructor Details

AggregateMappingModule

public AggregateMappingModule(org.springframework.data.repository.support.Repositories repositories,
 org.springframework.core.convert.ConversionService conversions)

Creates a new AggregateMappingModule from the given Repositories and ConversionService.

Parameters:

repositories - must not be null.

conversions - must not be null.

Method Details

register

public AggregateMappingModule register(AggregateIdentifierProcessor processor)

Registers an IdentifierProcessor to be used to pre- and post-process identifiers during conversions.

Parameters:

processor - must not be null.

Returns:

exclude

public AggregateMappingModule exclude(Class<?> type)

Excludes the given domain type from the aggregate resolution mapping.

Parameters:

type - must not be null.

Returns:

nullHandling

public AggregateMappingModule nullHandling(Class<?> type,
 AggregateMappingModule.NullHandling nullHandling)

Registers a dedicated AggregateMappingModule.NullHandling for the given type. For all other types the default AggregateMappingModule.NullHandling will be used.

Parameters:

type - must not be null.

nullHandling - must not be null.

Returns:

will never be null.

See Also:

• defaultNullHandling(NullHandling)

defaultNullHandling

public AggregateMappingModule defaultNullHandling(AggregateMappingModule.NullHandling nullHandling)

Registers the given AggregateMappingModule.NullHandling as the one to be applied by default. Defaults to AggregateMappingModule.NullHandling.THROW_EXCEPTION.

Parameters:

nullHandling - must not be null.

Returns:

will never be null.

setupModule

public void setupModule(org.modelmapper.ModelMapper mapper)

Specified by:

setupModule in interface org.modelmapper.Module