org.apache.polygene.api.unitofwork

Interface ToValueConverter

public interface ToValueConverter

MetaInfo holder for entity-to-value conversion in UnitOfWork.toValue(Class, HasIdentity)

The implementation of this interface should be registered as metaInfo on the Usecase of the UnitOfWork where the conversion should take place.

     private static final Usecase USECASE_GET_USER_DETAILS = UseCaseBuilder
                                                                 .buildUseCase("get user details")
                                                                 .withMetaInfo( new MyToValueConverter() )
                                                                 .newUsecase();
     @Structure
     private UnitOfWorkFactory uowf;
     :
     :
     try( UnitOfWork uow = uowf.newUnitOfWork( USECASE_GET_USER_DETAILS ) )
     {
         :
         User entity = ...;
         User value = uow.toValue( User.class, value );
         :
     }
     :
     :
 

Method Summary

Modifier and Type	Method and Description
Function<AssociationDescriptor,EntityReference>	associations(Object entityComposite, Function<AssociationDescriptor,EntityReference> defaultFn) Returns the Function to convert each of the associations of the entities into the value.
Function<AssociationDescriptor,Stream<EntityReference>>	manyAssociations(Object entityComposite, Function<AssociationDescriptor,Stream<EntityReference>> defaultFn) Returns the Function to convert each of the manyAssociations of the entities into the value.
Function<AssociationDescriptor,Stream<Map.Entry<String,EntityReference>>>	namedAssociations(Object entityComposite, Function<AssociationDescriptor,Stream<Map.Entry<String,EntityReference>>> defaultFn) Returns the Function to convert each of the NamedAssociations of the entities into the value.
Function<PropertyDescriptor,Object>	properties(Object entityComposite, Function<PropertyDescriptor,Object> defaultFn) Returns the Function to convert each of the properties of the entities into the value.

Method Detail

properties

Function<PropertyDescriptor,Object> properties(Object entityComposite,
                                               Function<PropertyDescriptor,Object> defaultFn)

Returns the Function to convert each of the properties of the entities into the value.

Parameters:

entityComposite - the entity that is to be converted.

defaultFn - The default converter function. This can be used to delegate non-special cases, or simply return to do all the conversions

Returns:

The function to do the conversion. It MUST NOT return null, and if no conversion is wanted, return the defaultFn.

associations

Function<AssociationDescriptor,EntityReference> associations(Object entityComposite,
                                                             Function<AssociationDescriptor,EntityReference> defaultFn)

Returns the Function to convert each of the associations of the entities into the value.

Parameters:

entityComposite - the entity that is to be converted.

defaultFn - The default converter function. This can be used to delegate non-special cases, or simply return to do all the conversions

Returns:

The function to do the conversion. It MUST NOT return null, and if no conversion is wanted, return the defaultFn.

manyAssociations

Function<AssociationDescriptor,Stream<EntityReference>> manyAssociations(Object entityComposite,
                                                                         Function<AssociationDescriptor,Stream<EntityReference>> defaultFn)

Returns the Function to convert each of the manyAssociations of the entities into the value.

Parameters:

entityComposite - the entity that is to be converted.

defaultFn - The default converter function. This can be used to delegate non-special cases, or simply return to do all the conversions

Returns:

The function to do the conversion. It MUST NOT return null, and if no conversion is wanted, return the defaultFn.

namedAssociations

Function<AssociationDescriptor,Stream<Map.Entry<String,EntityReference>>> namedAssociations(Object entityComposite,
                                                                                            Function<AssociationDescriptor,Stream<Map.Entry<String,EntityReference>>> defaultFn)

Returns the Function to convert each of the NamedAssociations of the entities into the value.

Parameters:

entityComposite - the entity that is to be converted.

defaultFn - The default converter function. This can be used to delegate non-special cases, or simply return to do all the conversions

Returns:

The function to do the conversion. It MUST NOT return null, and if no conversion is wanted, return the defaultFn.