com.neurosys.user.etl

Class UserFormTransformer<U extends User,UA extends UserAttribute>

java.lang.Object

com.neurosys.user.etl.UserFormTransformer<U,UA>

All Implemented Interfaces:

org.apache.commons.collections.Transformer

Direct Known Subclasses:

UserFormTransformer

public class UserFormTransformer<U extends User,UA extends UserAttribute>
extends Object
implements org.apache.commons.collections.Transformer

A Transformer that takes in a Map. Where the keys can take on any User or UserAttribute instance.
Additionally using context variables it can derive additional details about the user session if set in the input map. The context variables are defined in WebMapToEntitiesTransformer

It returns a Map with the entities replaced by the merged or transformed versions.

Note on validation: This Transformer does not perform validation. One can put a MapTransformer that validates every entity before this one is called.

Override getSessionUser(HttpServletRequest) if you want to use this in a non Wicket environment.

Author:

Arjun Dhar

See Also:

ServletRequestToEntitiesTransformer, (for more advanced merge dynamic scenarios)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UserFormTransformer.UserIdSetter

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	mergeWithCurrentSessionUser If true The form input are assumed to represent the user with the Current Web Session.
protected UserAttributesDao<UA>	userAttributesDao
protected UserDao<U>	userDao

Constructor Summary

Constructors

Constructor and Description
UserFormTransformer()

Method Summary

Modifier and Type	Method and Description
String	getServletRequestContextAccessor() Expected name of the key/accessor in the input Map that will contain the HttpServletRequest context variable
protected U	getSessionUser(javax.servlet.http.HttpServletRequest r)
UserAttributesDao<UA>	getUserAttributesDao()
UserDao<U>	getUserDao()
boolean	isMergeWithCurrentSessionUser() If true The form input are assumed to represent the user with the Current Web Session.
Map	merge(Map entityMap, U user)
protected U	saveUser(U userObject, U userSessionObject) Identify if the entity is a fresh independent entity or an update of an existing one. Persist accordingly
protected UA	saveUserAttribute(UA userAttribObject, U userSessionObject) The resultant object is a merged object to ensure an update can be performed if the userSessioObject is valid and related to this user Persist accordingly
void	setMergeWithCurrentSessionUser(boolean mergeWithCurrentSessionUser) If true The form input are assumed to represent the user with the Current Web Session.
void	setServletRequestContextAccessor(String servletRequestContextAccessor) Expected name of the key/accessor in the input Map that will contain the HttpServletRequest context variable
void	setUserAttributesDao(UserAttributesDao<UA> userAttributesDao)
void	setUserDao(UserDao<U> userDao)
Object	transform(Object input)
protected void	updateExisting(UA userAttribObject, U userSessionObject) To ensure if the attribute being saved is updated, we need to check for existing attribute for the userSessionObject and accordingly set it up to be updated or keep it an insert operation.
protected void	validate(U user) Custom Validation for raw input User
protected void	validate(UA userAttribute) Custom Validation for raw input UserAttribute

Methods inherited from class java.lang.Object

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

Field Detail

userAttributesDao

protected UserAttributesDao<UA extends UserAttribute> userAttributesDao

userDao

protected UserDao<U extends User> userDao

mergeWithCurrentSessionUser

protected boolean mergeWithCurrentSessionUser

If true The form input are assumed to represent the user with the Current Web Session. it will force the user object to only use current session user details

Default value:

true

Constructor Detail

UserFormTransformer

public UserFormTransformer()

Method Detail

validate

protected void validate(U user)

Custom Validation for raw input User

Parameters:

user - as U

validate

protected void validate(UA userAttribute)

Custom Validation for raw input UserAttribute

Parameters:

userAttribute - as UA

saveUser

@Transactional(readOnly=false)
protected U saveUser(U userObject,
                                                    U userSessionObject)

Identify if the entity is a fresh independent entity or an update of an existing one.
Persist accordingly

Parameters:

userObject - as U

userSessionObject - as User

Returns:

@Nuallable true - Remove entity if its not aplicable to be merged/saved

updateExisting

protected void updateExisting(UA userAttribObject,
                              U userSessionObject)

To ensure if the attribute being saved is updated, we need to check for existing attribute for the userSessionObject and accordingly set it up to be updated or keep it an insert operation.

Parameters:

userAttribObject - as UA

userSessionObject - as U

saveUserAttribute

@Transactional(readOnly=false)
protected UA saveUserAttribute(UA userAttribObject,
                                                              U userSessionObject)

The resultant object is a merged object to ensure an update can be performed if the userSessioObject is valid and related to this user
Persist accordingly

Parameters:

userObject - as U

userSessionObject - as User

Returns:

transform

@Transactional(readOnly=false)
public Object transform(Object input)

Specified by:

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

getSessionUser

protected U getSessionUser(javax.servlet.http.HttpServletRequest r)

merge

@Transactional(readOnly=false)
public Map merge(Map entityMap,
                                                U user)

getUserAttributesDao

public UserAttributesDao<UA> getUserAttributesDao()

setUserAttributesDao

public void setUserAttributesDao(UserAttributesDao<UA> userAttributesDao)

getUserDao

public UserDao<U> getUserDao()

setUserDao

public void setUserDao(UserDao<U> userDao)

isMergeWithCurrentSessionUser

public boolean isMergeWithCurrentSessionUser()

If true The form input are assumed to represent the user with the Current Web Session. it will force the user object to only use current session user details

Default value:

true

setMergeWithCurrentSessionUser

public void setMergeWithCurrentSessionUser(boolean mergeWithCurrentSessionUser)

If true The form input are assumed to represent the user with the Current Web Session. it will force the user object to only use current session user details

Default value:

true

getServletRequestContextAccessor

public String getServletRequestContextAccessor()

Expected name of the key/accessor in the input Map that will contain the HttpServletRequest context variable

setServletRequestContextAccessor

public void setServletRequestContextAccessor(String servletRequestContextAccessor)

Expected name of the key/accessor in the input Map that will contain the HttpServletRequest context variable