org.seedstack.business.api.interfaces.assembler

Annotation Type MatchingFactoryParameter

@Retention(value=RUNTIME)
@Target(value=METHOD)
public @interface MatchingFactoryParameter

This annotation allows the use of the fromFactory() method of the assembler DSL. If you don't use this DSL feature, this annotated is unnecessary.

It binds the DTO's annotated method to one parameter of a factory method used to create the assembled aggregate.

It also handle the case of a DTO assembled from a tuple of aggregate roots.

Case 1: Basic use case.

 public class CustomerDto {

     @MatchingFactoryParameter(index = 0)
     public String getName() {...}

     @MatchingFactoryParameter(index = 1)
     public Date getBirthDate() {...}

     // No need for annotation here as the address is not part of the factory method
     public Address getAddress() {...}
 }

 public class RecipeAssembler extends BaseAssembler<Customer, CustomerDto> { ... }

 public class CustomerFactory {
     public Customer createCustomer(String name, Date birthDate);
 }
 

Case 2: The DTO is an assembly of multiple aggregates.

 public class RecipeDto {

     @MatchingFactoryParameter(index = 0, typeIndex = 0)
     public String getCustomerName() {...}

     @MatchingFactoryParameter(index = 1, typeIndex = 0)
     public Date getCustomerBirthDate() {...}

     @MatchingFactoryParameter(index = 0, typeIndex = 1)
     public int getOrderId() {...}
 }

 public class RecipeAssembler extends BaseTupleAssembler<Pair<Customer, Order>, RecipeDto> { ... }

 public class CustomerFactory {
     Customer createCustomer(String name, Date birthDate);
 }

 public class OrderFactory {
     Customer createOrder(int orderId);
 }
 

Author:

epo.jemba@ext.mpsa.com

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
int	index Indicates which factory parameter the annotated method match.
int	typeIndex When using a tuple assembler, i.e. when assembling a DTO to tuple of aggregate roots.

Element Detail

index

public abstract int index

Indicates which factory parameter the annotated method match.

Returns:

the parameter index in the factory method.

Default:

-1

typeIndex

public abstract int typeIndex

When using a tuple assembler, i.e. when assembling a DTO to tuple of aggregate roots. This index indicates for which aggregate root this factory parameter is used.

Returns:

the aggregate index

See Also:

BaseTupleAssembler

Default:

-1