com.communote.server.persistence.user

Class UserProfileDaoBase

java.lang.Object

org.springframework.dao.support.DaoSupport

org.springframework.orm.hibernate3.support.HibernateDaoSupport

com.communote.server.persistence.user.UserProfileDaoBase

All Implemented Interfaces:

UserProfileDao, org.springframework.beans.factory.InitializingBean

Direct Known Subclasses:

UserProfileDaoImpl

public abstract class UserProfileDaoBase
extends org.springframework.orm.hibernate3.support.HibernateDaoSupport
implements UserProfileDao

Base Spring DAO Class: is able to create, update, remove, load, and find objects of type com.communote.server.persistence.user.KenmeiUserProfile.

Author:

Communote GmbH - http://www.communote.com/

See Also:

UserProfile

Field Summary

Fields inherited from class org.springframework.dao.support.DaoSupport

logger

Fields inherited from interface com.communote.server.persistence.user.UserProfileDao

TRANSFORM_KENMEIUSERPROFILEVO, TRANSFORM_NONE

Constructor Summary

Constructors

Constructor and Description
UserProfileDaoBase()

Method Summary

Modifier and Type	Method and Description
Collection<UserProfile>	create(Collection<UserProfile> entities) Creates a new instance of com.communote.server.persistence.user.KenmeiUserProfile and adds from the passed in entities collection
Collection<UserProfile>	create(int transform, Collection<UserProfile> entities) Does the same thing as UserProfileDao.create(com.communote.server.model.user.UserProfile) with an additional flag called transform.
Object	create(int transform, UserProfile kenmeiUserProfile) Does the same thing as UserProfileDao.create(com.communote.server.model.user.UserProfile) with an additional flag called transform.
UserProfile	create(UserProfile kenmeiUserProfile) Creates an instance of com.communote.server.persistence.user.KenmeiUserProfile and adds it to the persistent store.
void	evict(UserProfile entity) Evicts (removes) the entity from the hibernate cache
void	kenmeiUserProfileVOToEntityCollection(Collection instances) Converts a Collection of instances of type UserProfileVO to this DAO's entity.
Object	load(int transform, Long id) Does the same thing as UserProfileDao.load(Long) with an additional flag called transform.
UserProfile	load(Long id) Loads an instance of com.communote.server.persistence.user.KenmeiUserProfile from the persistent store.
Collection<UserProfile>	loadAll() Loads all entities of type UserProfile.
Collection<?>	loadAll(int transform) Does the same thing as UserProfileDao.loadAll() with an additional flag called transform.
void	remove(Collection<UserProfile> entities) Removes all entities in the given entities collection.
void	remove(Long id) Removes the instance of com.communote.server.persistence.user.KenmeiUserProfile having the given identifier from the persistent store.
void	remove(UserProfile kenmeiUserProfile) Removes the instance of com.communote.server.persistence.user.KenmeiUserProfile from the persistent store.
protected UserProfileVO	toKenmeiUserProfileVO(Object[] row) Default implementation for transforming the results of a report query into a value object.
void	toKenmeiUserProfileVOCollection(Collection entities) Converts this DAO's entity to a Collection of instances of type UserProfileVO.
UserProfileVO	toUserProfileVO(UserProfile entity) Converts this DAO's entity to an object of type UserProfileVO.
void	toUserProfileVO(UserProfile source, UserProfileVO target) Copies the fields of the specified entity to the target value object.
protected void	transformEntities(int transform, Collection<?> entities) Transforms a collection of entities using the transformEntity(int,com.communote.server.model.user.UserProfile) method.
protected Object	transformEntity(int transform, UserProfile entity) Allows transformation of entities into value objects (or something else for that matter), when the transform flag is set to one of the constants defined in com.communote.server.persistence.user.UserProfileDao, please note that the UserProfileDao.TRANSFORM_NONE constant denotes no transformation, so the entity itself will be returned.
void	update(Collection<UserProfile> entities) Updates all instances in the entities collection in the persistent store.
void	update(UserProfile kenmeiUserProfile) Updates the kenmeiUserProfile instance in the persistent store.
void	userProfileVOToEntity(UserProfileVO source, UserProfile target, boolean copyIfNull) Copies the fields of UserProfileVO to the specified entity.

Methods inherited from class org.springframework.orm.hibernate3.support.HibernateDaoSupport

checkDaoConfig, convertHibernateAccessException, createHibernateTemplate, getHibernateTemplate, getSession, getSession, getSessionFactory, releaseSession, setHibernateTemplate, setSessionFactory

Methods inherited from class org.springframework.dao.support.DaoSupport

afterPropertiesSet, initDao

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.communote.server.persistence.user.UserProfileDao

userProfileVOToEntity

Constructor Detail

UserProfileDaoBase

public UserProfileDaoBase()

Method Detail

create

public UserProfile create(UserProfile kenmeiUserProfile)

Description copied from interface: UserProfileDao

Creates an instance of com.communote.server.persistence.user.KenmeiUserProfile and adds it to the persistent store.

Specified by:

create in interface UserProfileDao

See Also:

UserProfileDao.create(com.communote.server.model.user.UserProfile)

create

public Object create(int transform,
                     UserProfile kenmeiUserProfile)

Description copied from interface: UserProfileDao

Does the same thing as UserProfileDao.create(com.communote.server.model.user.UserProfile) with an additional flag called transform. If this flag is set to TRANSFORM_NONE then the returned entity will NOT be transformed. If this flag is any of the other constants defined here then the result WILL BE passed through an operation which can optionally transform the entity (into a value object for example). By default, transformation does not occur.

Specified by:

create in interface UserProfileDao

See Also:

com.communote.server.persistence.user.UserProfileDao#create(int transform, com.communote.server.persistence.user.KenmeiUserProfile)

create

public Collection<UserProfile> create(int transform,
                                      Collection<UserProfile> entities)

Description copied from interface: UserProfileDao

Does the same thing as UserProfileDao.create(com.communote.server.model.user.UserProfile) with an additional flag called transform. If this flag is set to TRANSFORM_NONE then the returned entity will NOT be transformed. If this flag is any of the other constants defined here then the result WILL BE passed through an operation which can optionally transform the entities (into value objects for example). By default, transformation does not occur.

Specified by:

create in interface UserProfileDao

See Also:

com.communote.server.persistence.user.UserProfileDao#create(int, java.util.Collection)

create

public Collection<UserProfile> create(Collection<UserProfile> entities)

Description copied from interface: UserProfileDao

Creates a new instance of com.communote.server.persistence.user.KenmeiUserProfile and adds from the passed in entities collection

Specified by:

create in interface UserProfileDao

Parameters:

entities - the collection of com.communote.server.persistence.user.KenmeiUserProfile instances to create.

Returns:

the created instances.

See Also:

com.communote.server.persistence.user.UserProfileDao#create(java.util.Collection)

evict

public void evict(UserProfile entity)

Evicts (removes) the entity from the hibernate cache

Specified by:

evict in interface UserProfileDao

Parameters:

entity - the entity to evict

kenmeiUserProfileVOToEntityCollection

public final void kenmeiUserProfileVOToEntityCollection(Collection instances)

Description copied from interface: UserProfileDao

Converts a Collection of instances of type UserProfileVO to this DAO's entity.

Specified by:

kenmeiUserProfileVOToEntityCollection in interface UserProfileDao

See Also:

UserProfileDao.kenmeiUserProfileVOToEntityCollection(java.util.Collection)

load

public Object load(int transform,
                   Long id)

Description copied from interface: UserProfileDao

Does the same thing as UserProfileDao.load(Long) with an additional flag called transform. If this flag is set to TRANSFORM_NONE then the returned entity will NOT be transformed. If this flag is any of the other constants defined in this class then the result WILL BE passed through an operation which can optionally transform the entity (into a value object for example). By default, transformation does not occur.

Specified by:

load in interface UserProfileDao

id - the identifier of the entity to load.

Returns:

either the entity or the object transformed from the entity.

See Also:

UserProfileDao.load(int, Long)

load

public UserProfile load(Long id)

Description copied from interface: UserProfileDao

Loads an instance of com.communote.server.persistence.user.KenmeiUserProfile from the persistent store.

Specified by:

load in interface UserProfileDao

See Also:

UserProfileDao.load(Long)

loadAll

public Collection<UserProfile> loadAll()

Description copied from interface: UserProfileDao

Loads all entities of type UserProfile.

Specified by:

loadAll in interface UserProfileDao

Returns:

the loaded entities.

See Also:

UserProfileDao.loadAll()

loadAll

public Collection<?> loadAll(int transform)

Description copied from interface: UserProfileDao

Does the same thing as UserProfileDao.loadAll() with an additional flag called transform. If this flag is set to TRANSFORM_NONE then the returned entity will NOT be transformed. If this flag is any of the other constants defined here then the result WILL BE passed through an operation which can optionally transform the entity (into a value object for example). By default, transformation does not occur.

Specified by:

loadAll in interface UserProfileDao

Parameters:

transform - the flag indicating what transformation to use.

Returns:

the loaded entities.

See Also:

UserProfileDao.loadAll(int)

remove

public void remove(UserProfile kenmeiUserProfile)

Description copied from interface: UserProfileDao

Removes the instance of com.communote.server.persistence.user.KenmeiUserProfile from the persistent store.

Specified by:

remove in interface UserProfileDao

See Also:

UserProfileDao.remove(com.communote.server.model.user.UserProfile)

remove

public void remove(Collection<UserProfile> entities)

Description copied from interface: UserProfileDao

Removes all entities in the given entities collection.

Specified by:

remove in interface UserProfileDao

See Also:

com.communote.server.persistence.user.UserProfileDao#remove(java.util.Collection)

remove

public void remove(Long id)

Description copied from interface: UserProfileDao

Removes the instance of com.communote.server.persistence.user.KenmeiUserProfile having the given identifier from the persistent store.

Specified by:

remove in interface UserProfileDao

See Also:

UserProfileDao.remove(Long)

toKenmeiUserProfileVO

protected UserProfileVO toKenmeiUserProfileVO(Object[] row)

Default implementation for transforming the results of a report query into a value object. This implementation exists for convenience reasons only. It needs only be overridden in the UserProfileDaoImpl class if you intend to use reporting queries.

See Also:

UserProfileDao.toUserProfileVO(com.communote.server.model.user.UserProfile)

toKenmeiUserProfileVOCollection

public final void toKenmeiUserProfileVOCollection(Collection entities)

Description copied from interface: UserProfileDao

Converts this DAO's entity to a Collection of instances of type UserProfileVO.

Specified by:

toKenmeiUserProfileVOCollection in interface UserProfileDao

See Also:

UserProfileDao.toKenmeiUserProfileVOCollection(java.util.Collection)

toUserProfileVO

public UserProfileVO toUserProfileVO(UserProfile entity)

Description copied from interface: UserProfileDao

Converts this DAO's entity to an object of type UserProfileVO.

Specified by:

toUserProfileVO in interface UserProfileDao

See Also:

UserProfileDao.toUserProfileVO(com.communote.server.model.user.UserProfile)

toUserProfileVO

public void toUserProfileVO(UserProfile source,
                            UserProfileVO target)

Description copied from interface: UserProfileDao

Copies the fields of the specified entity to the target value object. This method is similar to toKenmeiUserProfileVO(), but it does not handle any attributes in the target value object that are "read-only" (as those do not have setter methods exposed).

Specified by:

toUserProfileVO in interface UserProfileDao

See Also:

UserProfileDao.toUserProfileVO(com.communote.server.model.user.UserProfile, com.communote.server.persistence.user.UserProfileVO)

transformEntities

protected void transformEntities(int transform,
                                 Collection<?> entities)

Transforms a collection of entities using the transformEntity(int,com.communote.server.model.user.UserProfile) method. This method does not instantiate a new collection.

This method is to be used internally only.

Parameters:

transform - one of the constants declared in com.communote.server.persistence.user.UserProfileDao

entities - the collection of entities to transform

See Also:

transformEntity(int,com.communote.server.model.user.UserProfile)

transformEntity

protected Object transformEntity(int transform,
                                 UserProfile entity)

Allows transformation of entities into value objects (or something else for that matter), when the transform flag is set to one of the constants defined in com.communote.server.persistence.user.UserProfileDao, please note that the UserProfileDao.TRANSFORM_NONE constant denotes no transformation, so the entity itself will be returned.

This method will return instances of these types:

• UserProfile - UserProfileDao.TRANSFORM_NONE
• UserProfileVO - TRANSFORM_KENMEIUSERPROFILEVO

If the integer argument value is unknown UserProfileDao.TRANSFORM_NONE is assumed.

Parameters:

transform - one of the constants declared in UserProfileDao

entity - an entity that was found

Returns:

the transformed entity (i.e. new value object, etc)

See Also:

transformEntities(int,java.util.Collection)

update

public void update(UserProfile kenmeiUserProfile)

Description copied from interface: UserProfileDao

Updates the kenmeiUserProfile instance in the persistent store.

Specified by:

update in interface UserProfileDao

See Also:

UserProfileDao.update(com.communote.server.model.user.UserProfile)

update

public void update(Collection<UserProfile> entities)

Description copied from interface: UserProfileDao

Updates all instances in the entities collection in the persistent store.

Specified by:

update in interface UserProfileDao

See Also:

com.communote.server.persistence.user.UserProfileDao#update(java.util.Collection)

userProfileVOToEntity

public void userProfileVOToEntity(UserProfileVO source,
                                  UserProfile target,
                                  boolean copyIfNull)

Description copied from interface: UserProfileDao

Copies the fields of UserProfileVO to the specified entity.

Specified by:

userProfileVOToEntity in interface UserProfileDao

copyIfNull - If FALSE, the value object's field will not be copied to the entity if the value is NULL. If TRUE, it will be copied regardless of its value.

See Also:

com.communote.server.persistence.user.UserProfileDao#kenmeiUserProfileVOToEntity(com.communote.server.persistence.user.UserProfileVO, com.communote.server.model.user.UserProfile)