com.neurosys.etl.common.transformers

Class ParamsRequestToEntitiesTransformer<T>

java.lang.Object

com.neurosys.etl.common.transformers.ParamsRequestToEntitiesTransformer<T>

All Implemented Interfaces:

FunctionTransformer, Function, org.apache.commons.collections.Transformer

Direct Known Subclasses:

MapToEntitiesTransformer, ServletRequestToEntitiesTransformer

public abstract class ParamsRequestToEntitiesTransformer<T>
extends Object
implements FunctionTransformer

Creates a Mapping of 'Param type class' representing the entity to the actual entities instance. If retainOriginalInputParams is true then it will also retain all the original input params in the output Map
An entry for the raw input request, is also added to the Map with the key String INPUT_KEY for easy access; since one cannot always be sure of the input type.

Please ensure the entities are beans with fields having public property descriptors

Author:

Arjun Dhar

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ParamsRequestToEntitiesTransformer.PropertyBinding

Field Summary

Fields

Modifier and Type	Field and Description
static String	INPUT_KEY Access the raw input to this Transformer

Constructor Summary

Constructors

Constructor and Description
ParamsRequestToEntitiesTransformer()

Method Summary

Modifier and Type	Method and Description
List<Class>	getEntities() List of classes representing entities to bind the request to.
Map<String,EntityFieldSetter>	getEntityFieldSetters() Map form field to an EntityFieldSetter where conventionally BeanUtils cannot work over the entity field to set it
protected abstract List<String>	getParamNames(T input)
Map<String,List<ParamsRequestToEntitiesTransformer.PropertyBinding>>	getPropertyBindings() Map of Request field name to the ParamsRequestToEntitiesTransformer.PropertyBinding binding(s).
Map<String,org.apache.commons.collections.Transformer>	getTransformPropertyBindings() Map Form field name to a Transformer, whose transformed value will be supplied to the Field name mentioned in bindings
protected abstract Object	getValue(T input, String paramName)
boolean	isIgnoreUnMappedFields() If true; the binding process will ignore any fields that are specified in the input form post and not mapped on server
boolean	isRetainOriginalInputParams() If true will also add the original raw input params in the transformed output Map
protected List<ParamsRequestToEntitiesTransformer.PropertyBinding>	resolveParamNameToBinding(String paramName) This method will return a ParamsRequestToEntitiesTransformer.PropertyBinding name for a given parameter.
void	setEntities(List<Class> entities) List of classes representing entities to bind the request to.
void	setEntityFieldSetters(Map<String,EntityFieldSetter> entityFieldSetters) Map form field to an EntityFieldSetter where conventionally BeanUtils cannot work over the entity field to set it
void	setIgnoreUnMappedFields(boolean ignoreUnMappedFields) If true; the binding process will ignore any fields that are specified in the input form post and not mapped on server
void	setPropertyBindings(Map<String,List<ParamsRequestToEntitiesTransformer.PropertyBinding>> propertyBindings) Map of Request field name to the ParamsRequestToEntitiesTransformer.PropertyBinding binding(s).
void	setRetainOriginalInputParams(boolean retainOriginalInputParams) If true will also add the original raw input params in the transformed output Map
void	setTransformPropertyBindings(Map<String,org.apache.commons.collections.Transformer> transformPropertyBindings) Map Form field name to a Transformer, whose transformed value will be supplied to the Field name mentioned in bindings
protected void	setupContextVariables(Map instanceMap, T input)
Object	transform(Object input)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.neurosys.etl.common.transformers.FunctionTransformer

apply

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Field Detail

INPUT_KEY

public static final String INPUT_KEY

Access the raw input to this Transformer

See Also:

Constant Field Values

Constructor Detail

ParamsRequestToEntitiesTransformer

public ParamsRequestToEntitiesTransformer()

Method Detail

resolveParamNameToBinding

protected List<ParamsRequestToEntitiesTransformer.PropertyBinding> resolveParamNameToBinding(String paramName)

This method will return a ParamsRequestToEntitiesTransformer.PropertyBinding name for a given parameter. If the mapping involved nested entities then it will return the binding to the most nested field available.

Parameters:

paramName -

Returns:

List of ParamsRequestToEntitiesTransformer.PropertyBinding

Throws:

NoSuchFieldException

getParamNames

protected abstract List<String> getParamNames(T input)

getValue

protected abstract Object getValue(T input,
                                   String paramName)

setupContextVariables

protected void setupContextVariables(Map instanceMap,
                                     T input)

transform

public Object transform(Object input)

Specified by:

transform in interface org.apache.commons.collections.Transformer

getEntities

public List<Class> getEntities()

List of classes representing entities to bind the request to. All entity classes must be accompanied by a default constructor.

setEntities

public void setEntities(List<Class> entities)

List of classes representing entities to bind the request to. All entity classes must be accompanied by a default constructor.

getPropertyBindings

public Map<String,List<ParamsRequestToEntitiesTransformer.PropertyBinding>> getPropertyBindings()

Map of Request field name to the ParamsRequestToEntitiesTransformer.PropertyBinding binding(s). Ther same field name may have multiple bindings hence the value is a List
The auto binding process with try to figure the type and type case the String to the appropriate type. If it fails, use a Transformer in transformPropertyBindings to fine the transformation from the request to the entity.

Note: If any property bindings are derived they are added to the Map by resolveParamNameToBinding(String)

setPropertyBindings

public void setPropertyBindings(Map<String,List<ParamsRequestToEntitiesTransformer.PropertyBinding>> propertyBindings)

Map of Request field name to the ParamsRequestToEntitiesTransformer.PropertyBinding binding(s). Ther same field name may have multiple bindings hence the value is a List
The auto binding process with try to figure the type and type case the String to the appropriate type. If it fails, use a Transformer in transformPropertyBindings to fine the transformation from the request to the entity.

Note: If any property bindings are derived they are added to the Map by resolveParamNameToBinding(String)

getTransformPropertyBindings

public Map<String,org.apache.commons.collections.Transformer> getTransformPropertyBindings()

Map Form field name to a Transformer, whose transformed value will be supplied to the Field name mentioned in bindings

setTransformPropertyBindings

public void setTransformPropertyBindings(Map<String,org.apache.commons.collections.Transformer> transformPropertyBindings)

Map Form field name to a Transformer, whose transformed value will be supplied to the Field name mentioned in bindings

isIgnoreUnMappedFields

public boolean isIgnoreUnMappedFields()

If true; the binding process will ignore any fields that are specified in the input form post and not mapped on server

setIgnoreUnMappedFields

public void setIgnoreUnMappedFields(boolean ignoreUnMappedFields)

If true; the binding process will ignore any fields that are specified in the input form post and not mapped on server

getEntityFieldSetters

public Map<String,EntityFieldSetter> getEntityFieldSetters()

Map form field to an EntityFieldSetter where conventionally BeanUtils cannot work over the entity field to set it

setEntityFieldSetters

public void setEntityFieldSetters(Map<String,EntityFieldSetter> entityFieldSetters)

Map form field to an EntityFieldSetter where conventionally BeanUtils cannot work over the entity field to set it

isRetainOriginalInputParams

public boolean isRetainOriginalInputParams()

If true will also add the original raw input params in the transformed output Map

setRetainOriginalInputParams

public void setRetainOriginalInputParams(boolean retainOriginalInputParams)

If true will also add the original raw input params in the transformed output Map