fr.ifremer.adagio.core.dao.referential.taxon

Class AuthorDaoBase

java.lang.Object

org.springframework.dao.support.DaoSupport

org.springframework.orm.hibernate3.support.HibernateDaoSupport

fr.ifremer.adagio.core.dao.referential.taxon.AuthorDaoBase

All Implemented Interfaces:

AuthorDao, org.springframework.beans.factory.InitializingBean

Direct Known Subclasses:

AuthorDaoImpl

public abstract class AuthorDaoBase
extends org.springframework.orm.hibernate3.support.HibernateDaoSupport
implements AuthorDao

Base Spring DAO Class: is able to create, update, remove, load, and find objects of type fr.ifremer.adagio.core.dao.referential.taxon.Author.

See Also:

Author

Field Summary

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

logger

Fields inherited from interface fr.ifremer.adagio.core.dao.referential.taxon.AuthorDao

TRANSFORM_NONE

Constructor Summary

Constructors

Constructor and Description
AuthorDaoBase()

Method Summary

Methods

Modifier and Type	Method and Description
Author	create(Author author) Creates an instance of fr.ifremer.adagio.core.dao.referential.taxon.Author and adds it to the persistent store.
Collection<Author>	create(Collection<Author> entities) Creates a new instance of fr.ifremer.adagio.core.dao.referential.taxon.Author and adds from the passed in entities collection
Author	create(Date creationDate, Status status) Creates a new fr.ifremer.adagio.core.dao.referential.taxon.Author instance from only required properties (attributes and association ends) and adds it to the persistent store.
Object	create(int transform, Author author) Does the same thing as AuthorDao.create(fr.ifremer.adagio.core.dao.referential.taxon.Author) with an additional flag called transform.
Collection<?>	create(int transform, Collection<Author> entities) Does the same thing as AuthorDao.create(fr.ifremer.adagio.core.dao.referential.taxon.Author) with an additional flag called transform.
Object	create(int transform, Date creationDate, Status status) Does the same thing as AuthorDao.create(java.util.Date,fr.ifremer.adagio.core.dao.referential.Status) with an additional flag called transform.
Object	create(int transform, String name, String location, String comments, Date creationDate, Timestamp updateDate, Collection<ReferenceDocument> referenceDocuments, Status status) Does the same thing as #create(java.lang.String,java.lang.String,java.lang.String,java.util.Date,java.sql.Timestamp,java.util.Collection,fr.ifremer.adagio.core.dao.referential.Status) with an additional flag called transform.
Author	create(String name, String location, String comments, Date creationDate, Timestamp updateDate, Collection<ReferenceDocument> referenceDocuments, Status status) Creates a new fr.ifremer.adagio.core.dao.referential.taxon.Author instance from all attributes and properties and adds it to the persistent store.
protected Principal	getPrincipal() Gets the current principal if one has been set, otherwise returns null.
Author	load(Integer id) Loads an instance of fr.ifremer.adagio.core.dao.referential.taxon.Author from the persistent store.
Object	load(int transform, Integer id) Does the same thing as AuthorDao.load(java.lang.Integer) with an additional flag called transform.
Collection<Author>	loadAll() Loads all entities of type Author.
Collection<?>	loadAll(int transform) Does the same thing as AuthorDao.loadAll() with an additional flag called transform.
Collection<?>	loadAll(int pageNumber, int pageSize) Does the same thing as AuthorDao.loadAll() with an additional two arguments called pageNumber and pageSize.
Collection<?>	loadAll(int transform, int pageNumber, int pageSize) Does the same thing as AuthorDao.loadAll(int) with an additional two arguments called pageNumber and pageSize.
void	remove(Author author) Removes the instance of fr.ifremer.adagio.core.dao.referential.taxon.Author from the persistent store.
void	remove(Collection<Author> entities) Removes all entities in the given entities collection.
void	remove(Integer id) Removes the instance of fr.ifremer.adagio.core.dao.referential.taxon.Author having the given identifier from the persistent store.
PaginationResult	search(int transform, int pageNumber, int pageSize, Search search) Does the same thing as {@link #search(int, fr.ifremer.adagio.core.dao.Search) but with an additional two flags called pageNumber and pageSize.
PaginationResult	search(int pageNumber, int pageSize, Search search) Does the same thing as {@link #search(fr.ifremer.adagio.core.dao.Search) but with an additional two flags called pageNumber and pageSize.
Set<?>	search(int transform, Search search) Does the same thing as AuthorDao.search(fr.ifremer.adagio.core.dao.Search) but with an additional flag called transform.
Set<Author>	search(Search search) Performs a search using the parameters specified in the given search object.
protected Author	toEntity(Object[] row)
protected void	transformEntities(int transform, Collection<?> entities) Transforms a collection of entities using the transformEntity(int,fr.ifremer.adagio.core.dao.referential.taxon.Author) method.
protected Object	transformEntity(int transform, Author 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 fr.ifremer.adagio.core.dao.referential.taxon.AuthorDao, please note that the AuthorDao.TRANSFORM_NONE constant denotes no transformation, so the entity itself will be returned.
void	update(Author author) Updates the author instance in the persistent store.
void	update(Collection<Author> 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

AuthorDaoBase

public AuthorDaoBase()

Method Detail

load

public Object load(int transform,
          Integer id)

Description copied from interface: AuthorDao

Does the same thing as AuthorDao.load(java.lang.Integer) 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 AuthorDao

id - identifier of the entity to load

Returns:

either the entity or the object transformed from the entity.

See Also:

AuthorDao.load(int, java.lang.Integer)

load

public Author load(Integer id)

Description copied from interface: AuthorDao

Loads an instance of fr.ifremer.adagio.core.dao.referential.taxon.Author from the persistent store.

Specified by:

load in interface AuthorDao

See Also:

AuthorDao.load(java.lang.Integer)

loadAll

public Collection<Author> loadAll()

Description copied from interface: AuthorDao

Loads all entities of type Author.

Specified by:

loadAll in interface AuthorDao

Returns:

the loaded entities.

See Also:

AuthorDao.loadAll()

loadAll

public Collection<?> loadAll(int transform)

Description copied from interface: AuthorDao

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

Parameters:

transform - the flag indicating what transformation to use.

Returns:

the loaded entities.

See Also:

AuthorDao.loadAll(int)

loadAll

public Collection<?> loadAll(int pageNumber,
                    int pageSize)

Description copied from interface: AuthorDao

Does the same thing as AuthorDao.loadAll() with an additional two arguments called pageNumber and pageSize. The pageNumber argument allows you to specify the page number when you are paging the results and the pageSize allows you to specify the size of the page retrieved.

Specified by:

loadAll in interface AuthorDao

Parameters:

pageNumber - the page number to retrieve when paging results.

pageSize - the size of the page to retrieve when paging results.

Returns:

the loaded entities.

See Also:

AuthorDao.loadAll(int, int)

loadAll

public Collection<?> loadAll(int transform,
                    int pageNumber,
                    int pageSize)

Description copied from interface: AuthorDao

Does the same thing as AuthorDao.loadAll(int) with an additional two arguments called pageNumber and pageSize. The pageNumber argument allows you to specify the page number when you are paging the results and the pageSize allows you to specify the size of the page retrieved.

Specified by:

loadAll in interface AuthorDao

Parameters:

transform - the flag indicating what transformation to use.

pageNumber - the page number to retrieve when paging results.

pageSize - the size of the page to retrieve when paging results.

Returns:

the loaded entities.

See Also:

AuthorDao.loadAll(int, int, int)

create

public Author create(Author author)

Description copied from interface: AuthorDao

Creates an instance of fr.ifremer.adagio.core.dao.referential.taxon.Author and adds it to the persistent store.

Specified by:

create in interface AuthorDao

See Also:

AuthorDao.create(fr.ifremer.adagio.core.dao.referential.taxon.Author)

create

public Object create(int transform,
            Author author)

Description copied from interface: AuthorDao

Does the same thing as AuthorDao.create(fr.ifremer.adagio.core.dao.referential.taxon.Author) 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 AuthorDao

See Also:

AuthorDao.create(int transform, fr.ifremer.adagio.core.dao.referential.taxon.Author)

create

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

Description copied from interface: AuthorDao

Creates a new instance of fr.ifremer.adagio.core.dao.referential.taxon.Author and adds from the passed in entities collection

Specified by:

create in interface AuthorDao

Parameters:

entities - the collection of fr.ifremer.adagio.core.dao.referential.taxon.Author instances to create.

Returns:

the created instances.

See Also:

fr.ifremer.adagio.core.dao.referential.taxon.AuthorDao#create(java.util.Collection)

create

public Collection<?> create(int transform,
                   Collection<Author> entities)

Description copied from interface: AuthorDao

Does the same thing as AuthorDao.create(fr.ifremer.adagio.core.dao.referential.taxon.Author) 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 AuthorDao

See Also:

fr.ifremer.adagio.core.dao.referential.taxon.AuthorDao#create(int, java.util.Collection)

create

public Author create(String name,
            String location,
            String comments,
            Date creationDate,
            Timestamp updateDate,
            Collection<ReferenceDocument> referenceDocuments,
            Status status)

Description copied from interface: AuthorDao

Creates a new fr.ifremer.adagio.core.dao.referential.taxon.Author instance from all attributes and properties and adds it to the persistent store.

Specified by:

create in interface AuthorDao

See Also:

fr.ifremer.adagio.core.dao.referential.taxon.AuthorDao#create(java.lang.String,java.lang.String,java.lang.String,java.util.Date,java.sql.Timestamp,java.util.Collection,fr.ifremer.adagio.core.dao.referential.Status)

create

public Object create(int transform,
            String name,
            String location,
            String comments,
            Date creationDate,
            Timestamp updateDate,
            Collection<ReferenceDocument> referenceDocuments,
            Status status)

Description copied from interface: AuthorDao

Does the same thing as #create(java.lang.String,java.lang.String,java.lang.String,java.util.Date,java.sql.Timestamp,java.util.Collection,fr.ifremer.adagio.core.dao.referential.Status) 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 AuthorDao

See Also:

fr.ifremer.adagio.core.dao.referential.taxon.AuthorDao#create(int, java.lang.String,java.lang.String,java.lang.String,java.util.Date,java.sql.Timestamp,java.util.Collection,fr.ifremer.adagio.core.dao.referential.Status)

create

public Author create(Date creationDate,
            Status status)

Description copied from interface: AuthorDao

Creates a new fr.ifremer.adagio.core.dao.referential.taxon.Author instance from only required properties (attributes and association ends) and adds it to the persistent store.

Specified by:

create in interface AuthorDao

See Also:

AuthorDao.create(java.util.Date,fr.ifremer.adagio.core.dao.referential.Status)

create

public Object create(int transform,
            Date creationDate,
            Status status)

Description copied from interface: AuthorDao

Does the same thing as AuthorDao.create(java.util.Date,fr.ifremer.adagio.core.dao.referential.Status) with an additional flag called transform. If this flag is set to TRANSFORM_NONE then the returned entity will NOTWILL 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 AuthorDao

See Also:

AuthorDao.create(int, java.util.Date,fr.ifremer.adagio.core.dao.referential.Status)

update

public void update(Author author)

Description copied from interface: AuthorDao

Updates the author instance in the persistent store.

Specified by:

update in interface AuthorDao

See Also:

AuthorDao.update(fr.ifremer.adagio.core.dao.referential.taxon.Author)

update

public void update(Collection<Author> entities)

Description copied from interface: AuthorDao

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

Specified by:

update in interface AuthorDao

See Also:

fr.ifremer.adagio.core.dao.referential.taxon.AuthorDao#update(java.util.Collection)

remove

public void remove(Author author)

Description copied from interface: AuthorDao

Removes the instance of fr.ifremer.adagio.core.dao.referential.taxon.Author from the persistent store.

Specified by:

remove in interface AuthorDao

See Also:

AuthorDao.remove(fr.ifremer.adagio.core.dao.referential.taxon.Author)

remove

public void remove(Integer id)

Description copied from interface: AuthorDao

Removes the instance of fr.ifremer.adagio.core.dao.referential.taxon.Author having the given identifier from the persistent store.

Specified by:

remove in interface AuthorDao

See Also:

AuthorDao.remove(java.lang.Integer)

remove

public void remove(Collection<Author> entities)

Description copied from interface: AuthorDao

Removes all entities in the given entities collection.

Specified by:

remove in interface AuthorDao

See Also:

fr.ifremer.adagio.core.dao.referential.taxon.AuthorDao#remove(java.util.Collection)

transformEntity

protected Object transformEntity(int transform,
                     Author 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 fr.ifremer.adagio.core.dao.referential.taxon.AuthorDao, please note that the AuthorDao.TRANSFORM_NONE constant denotes no transformation, so the entity itself will be returned. If the integer argument value is unknown AuthorDao.TRANSFORM_NONE is assumed.

Parameters:

transform - one of the constants declared in AuthorDao

entity - an entity that was found

Returns:

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

See Also:

transformEntities(int,java.util.Collection)

transformEntities

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

Transforms a collection of entities using the transformEntity(int,fr.ifremer.adagio.core.dao.referential.taxon.Author) 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 fr.ifremer.adagio.core.dao.referential.taxon.AuthorDao

entities - the collection of entities to transform

See Also:

transformEntity(int,fr.ifremer.adagio.core.dao.referential.taxon.Author)

toEntity

protected Author toEntity(Object[] row)

getPrincipal

protected Principal getPrincipal()

Gets the current principal if one has been set, otherwise returns null.

Returns:

the current principal

search

public PaginationResult search(int transform,
                      int pageNumber,
                      int pageSize,
                      Search search)

Description copied from interface: AuthorDao

Does the same thing as {@link #search(int, fr.ifremer.adagio.core.dao.Search) but with an additional two flags called pageNumber and pageSize. These flags allow you to limit your data to a specified page number and size.

Specified by:

search in interface AuthorDao

Parameters:

transform - the transformation flag.

pageNumber - the page number in the data to retrieve

pageSize - the size of the page to retrieve.

search - the search object which provides the search parameters and pagination specification.

Returns:

any found results from the search wrapped in a PaginationResult instance.

See Also:

AuthorDao.search(int, int, int, fr.ifremer.adagio.core.dao.Search)

search

public PaginationResult search(int pageNumber,
                      int pageSize,
                      Search search)

Description copied from interface: AuthorDao

Does the same thing as {@link #search(fr.ifremer.adagio.core.dao.Search) but with an additional two flags called pageNumber and pageSize. These flags allow you to limit your data to a specified page number and size.

Specified by:

search in interface AuthorDao

Parameters:

pageNumber - the page number in the data to retrieve

pageSize - the size of the page to retrieve.

search - the search object which provides the search parameters and pagination specification.

Returns:

any found results from the search wrapped in a PaginationResult instance.

See Also:

AuthorDao.search(int, int, fr.ifremer.adagio.core.dao.Search)

search

public Set<?> search(int transform,
            Search search)

Description copied from interface: AuthorDao

Does the same thing as AuthorDao.search(fr.ifremer.adagio.core.dao.Search) but with an additional flag called transform. If this flag is set to TRANSFORM_NONE then finder results will NOT be transformed during retrieval. If this flag is any of the other constants defined here then results 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:

search in interface AuthorDao

Parameters:

transform - the transformation flag.

search - the search object which provides the search parameters and pagination specification.

Returns:

any found results from the search.

See Also:

AuthorDao.search(int, fr.ifremer.adagio.core.dao.Search)

search

public Set<Author> search(Search search)

Description copied from interface: AuthorDao

Performs a search using the parameters specified in the given search object.

Specified by:

search in interface AuthorDao

Parameters:

search - the search object which provides the search parameters and pagination specification.

Returns:

any found results from the search.

See Also:

AuthorDao.search(fr.ifremer.adagio.core.dao.Search)