org.seedstack.business.api.interfaces.assembler

Class BaseAssembler<AGGREGATE_ROOT extends AggregateRoot<?>,DTO>

java.lang.Object

org.seedstack.business.api.interfaces.assembler.AbstractBaseAssembler<AGGREGATE_ROOT,DTO>

org.seedstack.business.api.interfaces.assembler.BaseAssembler<AGGREGATE_ROOT,DTO>

Type Parameters:

AGGREGATE_ROOT - the aggregate root type

DTO - the dto type

All Implemented Interfaces:

Assembler<AGGREGATE_ROOT,DTO>

public abstract class BaseAssembler<AGGREGATE_ROOT extends AggregateRoot<?>,DTO>
extends AbstractBaseAssembler<AGGREGATE_ROOT,DTO>

This class is the class to be extended by the users in order to create an Assembler.

User must implements doAssembleDtoFromAggregate(Object, org.seedstack.business.api.domain.AggregateRoot) and doMergeAggregateWithDto(org.seedstack.business.api.domain.AggregateRoot, Object) to provide implementation of the copy.

For instance:

 public class ProductAssembler extends BaseAssembler<Product,ProductRepresentation> {

     @Override
     protected void doAssembleDtoFromAggregate(ProductRepresentation targetDto, Product sourceAggregate) {
          targetDto.fillProductId(sourceAggregate.getEntityId().getStoreId(),
              sourceAggregate.getEntityId().getProductCode());
          targetDto.setName(sourceAggregate.getName());
          targetDto.setDescription(sourceAggregate.getDescription());
     }

     @Override
     protected void doMergeAggregateWithDto(Product targetAggregate, ProductRepresentation sourceDto) {
          targetAggregate.setName(sourceDto.getName());
          targetAggregate.setDescription(sourceDto.getDescription());
     }
 }
 

Then the assembler can be used via:

 @Inject
 ProductAssembler productAssembler;
 

And used like this:

 ProductRepresentation productRepresentation = productAssembler.assembleDtoFromAggregate(productFromRepo);
 

or

 productAssembler.mergeAggregateWithDto(productToMerge, productRepresentationSource);
 

Note that Assemblers will automatically have a reference of ProductAssembler and the following will be respectively equivalent to the previous use.

 @Inject
 Assemblers assemblers;
 ...
 ProductRepresentation productRepresentation = assemblers.assembleDtoFromAggregate(ProductRepresentation.class, productFromRepo);
 ...
 assemblers.mergeAggregateWithDto(productToMerge, productRepresentationSource);
 

Author:

epo.jemba@ext.mpsa.com

Field Summary

Fields inherited from class org.seedstack.business.api.interfaces.assembler.AbstractBaseAssembler

dtoClass

Constructor Summary

Constructors

Constructor and Description
BaseAssembler() Default needed constructor.

Method Summary

Methods

Modifier and Type	Method and Description
DTO	assembleDtoFromAggregate(AGGREGATE_ROOT sourceAggregate) This method is used by developers or by the DSL to assemble a new DTO from the given aggregate.
protected abstract void	doAssembleDtoFromAggregate(DTO targetDto, AGGREGATE_ROOT sourceAggregate) This method has to be overridden by users to actually assemble the DTO from the aggregate.
protected abstract void	doMergeAggregateWithDto(AGGREGATE_ROOT targetAggregate, DTO sourceDto) This method has to be overridden by users to actually merge an aggregate with the DTO.
void	mergeAggregateWithDto(AGGREGATE_ROOT targetAggregate, DTO sourceDto) This method is used by developers or by the DSL to actually merge the aggregate.
void	updateDtoFromAggregate(DTO sourceDto, AGGREGATE_ROOT sourceAggregate) Updates the given DTO from the aggregate.

Methods inherited from class org.seedstack.business.api.interfaces.assembler.AbstractBaseAssembler

getDtoClass, newDto

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseAssembler

public BaseAssembler()

Default needed constructor.

Method Detail

assembleDtoFromAggregate

public DTO assembleDtoFromAggregate(AGGREGATE_ROOT sourceAggregate)

This method is used by developers or by the DSL to assemble a new DTO from the given aggregate.

• It calls AbstractBaseAssembler.newDto() for the DTO creation
• and doAssembleDtoFromAggregate(Object, org.seedstack.business.api.domain.AggregateRoot) for the assembly algorithm.

this Method adds data security. It intercepts and secures data according to the org.seedstack.seed.security.api.data.DataSecurityService.

Parameters:

sourceAggregate - The aggregate from which create the DTO.

Returns:

the assembled DTO

See Also:

Assembler.assembleDtoFromAggregate(Object)

updateDtoFromAggregate

public void updateDtoFromAggregate(DTO sourceDto,
                          AGGREGATE_ROOT sourceAggregate)

Description copied from interface: Assembler

Updates the given DTO from the aggregate.

Parameters:

sourceDto - The dto to update.

sourceAggregate - The aggregate to copy data from.

doAssembleDtoFromAggregate

protected abstract void doAssembleDtoFromAggregate(DTO targetDto,
                              AGGREGATE_ROOT sourceAggregate)

This method has to be overridden by users to actually assemble the DTO from the aggregate.

 targetDto.fillProductId(sourceAggregate.getEntityId().getStoreId(),
     sourceAggregate.getEntityId().getProductCode());
 targetDto.setName(sourceAggregate.getName());
 targetDto.setDescription(sourceAggregate.getDescription());
 

This method will be called by the public method assembleDtoFromAggregate(org.seedstack.business.api.domain.AggregateRoot)

Parameters:

targetDto - the target dto

sourceAggregate - the source aggregate

mergeAggregateWithDto

public void mergeAggregateWithDto(AGGREGATE_ROOT targetAggregate,
                         DTO sourceDto)

This method is used by developers or by the DSL to actually merge the aggregate.

It will call doMergeAggregateWithDto(org.seedstack.business.api.domain.AggregateRoot, Object), which is overridden by developers.

Parameters:

targetAggregate - the target aggregate

sourceDto - the source dto

See Also:

Assembler.mergeAggregateWithDto(Object, Object)

doMergeAggregateWithDto

protected abstract void doMergeAggregateWithDto(AGGREGATE_ROOT targetAggregate,
                           DTO sourceDto)

This method has to be overridden by users to actually merge an aggregate with the DTO.

 ...
 targetAggregate.setName(sourceDto.getName());
 targetAggregate.setDescription(sourceDto.getDescription());
 ...
 

This method will be called by the public method mergeAggregateWithDto(org.seedstack.business.api.domain.AggregateRoot, Object).

Parameters:

sourceDto - the source dto

targetAggregate - the target aggregate