com.ervacon.springframework.web.servlet.mvc.webflow
Interface ModelMapper

All Known Implementing Classes:

ParameterizableModelMapper

public interface ModelMapper

Interface for model data mappers. These objects map model data from a parent flow to a sub flow and back again in a flow-state of a web flow.

Model mappers are configured as beans in a Spring application context. A mapper that is configured as a singleton bean in the application context should be thread safe! If you have a mapper that is not thread safe, make sure you add the singleton="false" parameter to its bean definition.
If a mapper needs access to the application context, it can implement an interface like ApplicationContextAware.

Note that mappers cannot generate checked exceptions since exceptions during model mapping normally indicate an unrecoverable error (e.g. a programming bug).

Author:

Erwin Vervaet

See Also:

WebFlow, ApplicationContext, ApplicationContextAware

Method Summary

void	mapFromSubFlow(java.util.Map parentFlowModel, java.util.Map subFlowModel) Map model data from the sub flow back to the parent flow.
void	mapToSubFlow(java.util.Map parentFlowModel, java.util.Map subFlowModel) Map model data from the parent flow to the sub flow.

Method Detail

mapToSubFlow

public void mapToSubFlow(java.util.Map parentFlowModel,
                         java.util.Map subFlowModel)

Map model data from the parent flow to the sub flow. This is called before the sub flow is started.

Parameters:

parentFlowModel - parent flow model

subFlowModel - sub flow model

mapFromSubFlow

public void mapFromSubFlow(java.util.Map parentFlowModel,
                           java.util.Map subFlowModel)

Map model data from the sub flow back to the parent flow. This is called after the sub flow completes and before the parent flow continues.

Parameters:

parentFlowModel - parent flow model

subFlowModel - sub flow model