com.communote.server.persistence.user.client

Class ClientDaoBase

java.lang.Object

org.springframework.dao.support.DaoSupport

org.springframework.orm.hibernate3.support.HibernateDaoSupport

com.communote.server.persistence.user.client.ClientDaoBase

All Implemented Interfaces:

ClientDao, org.springframework.beans.factory.InitializingBean

Direct Known Subclasses:

ClientDaoImpl

public abstract class ClientDaoBase
extends org.springframework.orm.hibernate3.support.HibernateDaoSupport
implements ClientDao

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

Author:

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

See Also:

Client

Field Summary

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

logger

Fields inherited from interface com.communote.server.persistence.user.client.ClientDao

TRANSFORM_NONE

Constructor Summary

Constructors

Constructor and Description
ClientDaoBase()

Method Summary

Modifier and Type	Method and Description
Client	changeClientStatus(String clientId, ClientStatus newStatus, ClientStatus oldStatus)
Client	create(Client client) Creates an instance of com.communote.server.persistence.user.client.Client and adds it to the persistent store.
Collection<Client>	create(Collection<Client> entities) Creates a new instance of com.communote.server.persistence.user.client.Client and adds from the passed in entities collection
Object	create(int transform, Client client) Does the same thing as ClientDao.create(com.communote.server.model.client.Client) with an additional flag called transform.
Collection<Client>	create(int transform, Collection<Client> entities) Does the same thing as ClientDao.create(com.communote.server.model.client.Client) with an additional flag called transform.
void	evict(Client entity) Evicts (removes) the entity from the hibernate cache
Client	findByClientId(String clientId) Find the client by its id
Client	findByClientIdForWriting(String clientId) Find the client by its id and obtain a write lock
protected abstract Client	handleChangeClientStatus(String clientId, ClientStatus newStatus, ClientStatus oldStatus) Performs the core logic for changeClientStatus(String, com.communote.server.model.client.ClientStatus, com.communote.server.model.client.ClientStatus)
protected abstract Client	handleFindByClientId(String clientId) Performs the core logic for findByClientId(String)
protected abstract Client	handleFindByClientIdForWriting(String clientId) Performs the core logic for findByClientIdForWriting(String)
Object	load(int transform, Long id) Does the same thing as ClientDao.load(Long) with an additional flag called transform.
Client	load(Long id) Loads an instance of com.communote.server.persistence.user.client.Client from the persistent store.
Collection<Client>	loadAll() Loads all entities of type Client.
Collection<?>	loadAll(int transform) Does the same thing as ClientDao.loadAll() with an additional flag called transform.
void	remove(Client client) Removes the instance of com.communote.server.persistence.user.client.Client from the persistent store.
void	remove(Collection<Client> entities) Removes all entities in the given entities collection.
void	remove(Long id) Removes the instance of com.communote.server.persistence.user.client.Client having the given identifier from the persistent store.
protected void	transformEntities(int transform, Collection<?> entities) Transforms a collection of entities using the transformEntity(int,com.communote.server.model.client.Client) method.
protected Object	transformEntity(int transform, Client 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.client.ClientDao, please note that the ClientDao.TRANSFORM_NONE constant denotes no transformation, so the entity itself will be returned.
void	update(Client client) Updates the client instance in the persistent store.
void	update(Collection<Client> entities) Updates all instances in the entities collection in the persistent store.

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

Constructor Detail

ClientDaoBase

public ClientDaoBase()

Method Detail

changeClientStatus

public Client changeClientStatus(String clientId,
                                 ClientStatus newStatus,
                                 ClientStatus oldStatus)

Specified by:

changeClientStatus in interface ClientDao

See Also:

ClientDao.changeClientStatus(String, com.communote.server.model.client.ClientStatus, com.communote.server.model.client.ClientStatus)

create

public Client create(Client client)

Description copied from interface: ClientDao

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

Specified by:

create in interface ClientDao

See Also:

ClientDao.create(com.communote.server.model.client.Client)

create

public Object create(int transform,
                     Client client)

Description copied from interface: ClientDao

Does the same thing as ClientDao.create(com.communote.server.model.client.Client) 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 ClientDao

See Also:

com.communote.server.persistence.user.client.ClientDao#create(int transform, com.communote.server.persistence.user.client.Client)

create

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

Description copied from interface: ClientDao

Does the same thing as ClientDao.create(com.communote.server.model.client.Client) 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 ClientDao

See Also:

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

create

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

Description copied from interface: ClientDao

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

Specified by:

create in interface ClientDao

Parameters:

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

Returns:

the created instances.

See Also:

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

evict

public void evict(Client entity)

Evicts (removes) the entity from the hibernate cache

Specified by:

evict in interface ClientDao

Parameters:

entity - the entity to evict

findByClientId

public Client findByClientId(String clientId)

Description copied from interface: ClientDao

Find the client by its id

Specified by:

findByClientId in interface ClientDao

See Also:

ClientDao.findByClientId(String)

findByClientIdForWriting

public Client findByClientIdForWriting(String clientId)

Description copied from interface: ClientDao

Find the client by its id and obtain a write lock

Specified by:

findByClientIdForWriting in interface ClientDao

See Also:

ClientDao.findByClientIdForWriting(String)

handleChangeClientStatus

protected abstract Client handleChangeClientStatus(String clientId,
                                                   ClientStatus newStatus,
                                                   ClientStatus oldStatus)

Performs the core logic for changeClientStatus(String, com.communote.server.model.client.ClientStatus, com.communote.server.model.client.ClientStatus)

handleFindByClientId

protected abstract Client handleFindByClientId(String clientId)

Performs the core logic for findByClientId(String)

handleFindByClientIdForWriting

protected abstract Client handleFindByClientIdForWriting(String clientId)

Performs the core logic for findByClientIdForWriting(String)

load

public Object load(int transform,
                   Long id)

Description copied from interface: ClientDao

Does the same thing as ClientDao.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 ClientDao

id - the identifier of the entity to load.

Returns:

either the entity or the object transformed from the entity.

See Also:

ClientDao.load(int, Long)

load

public Client load(Long id)

Description copied from interface: ClientDao

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

Specified by:

load in interface ClientDao

See Also:

ClientDao.load(Long)

loadAll

public Collection<Client> loadAll()

Description copied from interface: ClientDao

Loads all entities of type Client.

Specified by:

loadAll in interface ClientDao

Returns:

the loaded entities.

See Also:

ClientDao.loadAll()

loadAll

public Collection<?> loadAll(int transform)

Description copied from interface: ClientDao

Does the same thing as ClientDao.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 ClientDao

Parameters:

transform - the flag indicating what transformation to use.

Returns:

the loaded entities.

See Also:

ClientDao.loadAll(int)

remove

public void remove(Client client)

Description copied from interface: ClientDao

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

Specified by:

remove in interface ClientDao

See Also:

ClientDao.remove(com.communote.server.model.client.Client)

remove

public void remove(Collection<Client> entities)

Description copied from interface: ClientDao

Removes all entities in the given entities collection.

Specified by:

remove in interface ClientDao

See Also:

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

remove

public void remove(Long id)

Description copied from interface: ClientDao

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

Specified by:

remove in interface ClientDao

See Also:

ClientDao.remove(Long)

transformEntities

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

Transforms a collection of entities using the transformEntity(int,com.communote.server.model.client.Client) 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.client.ClientDao

entities - the collection of entities to transform

See Also:

transformEntity(int,com.communote.server.model.client.Client)

transformEntity

protected Object transformEntity(int transform,
                                 Client 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.client.ClientDao, please note that the ClientDao.TRANSFORM_NONE constant denotes no transformation, so the entity itself will be returned. If the integer argument value is unknown ClientDao.TRANSFORM_NONE is assumed.

Parameters:

transform - one of the constants declared in ClientDao

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(Client client)

Description copied from interface: ClientDao

Updates the client instance in the persistent store.

Specified by:

update in interface ClientDao

See Also:

ClientDao.update(com.communote.server.model.client.Client)

update

public void update(Collection<Client> entities)

Description copied from interface: ClientDao

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

Specified by:

update in interface ClientDao

See Also:

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