fr.ifremer.adagio.core.dao.data.survey.sale

Class SaleOriginDaoBase

Object

HibernateDaoSupport

SaleOriginDaoBase

All Implemented Interfaces:

SaleOriginDao

Direct Known Subclasses:

SaleOriginDaoImpl

public abstract class SaleOriginDaoBase
extends HibernateDaoSupport
implements SaleOriginDao

Base Spring DAO Class: is able to create, update, remove, load, and find objects of type SaleOrigin.

See Also:

SaleOrigin

Field Summary

Fields inherited from class HibernateDaoSupport

debugEntityLoad, logger

Fields inherited from interface SaleOriginDao

TRANSFORM_NONE

Constructor Summary

Constructors

Constructor and Description
SaleOriginDaoBase()

Method Summary

Methods

Modifier and Type	Method and Description
protected int	calculateFirstResult(int pageNumber, int pageSize) firstResult = (pageNumber - 1) * pageSize
Collection<SaleOrigin>	create(Collection<SaleOrigin> entities) Creates a new instance of SaleOrigin and adds from the passed in entities collection
Collection<?>	create(int transform, Collection<SaleOrigin> entities) Does the same thing as SaleOriginDao.create(SaleOrigin) with an additional flag called transform.
Object	create(int transform, Program program, Sale sale) Does the same thing as #create() with an additional flag called transform.
Object	create(int transform, SaleOrigin saleOrigin) Does the same thing as SaleOriginDao.create(SaleOrigin) with an additional flag called transform.
SaleOrigin	create(Program program, Sale sale) Creates a new SaleOrigin instance from only required properties (attributes and association ends) and adds it to the persistent store.
SaleOrigin	create(SaleOrigin saleOrigin) Creates an instance of SaleOrigin and adds it to the persistent store.
Object	get(int transform, SaleOriginPK saleOriginPk) Does the same thing as SaleOriginDao.get(SaleOriginPK) with an additional flag called transform.
SaleOrigin	get(SaleOriginPK saleOriginPk) Gets an instance of SaleOrigin from the persistent store.
protected PaginationResult	getPaginationResult(Query queryObject, int transform, int pageNumber, int pageSize) Executes and returns the given Hibernate queryObject as a PaginationResult instance.
protected Principal	getPrincipal() Gets the current principal if one has been set, otherwise returns null.
Object	load(int transform, SaleOriginPK saleOriginPk) Does the same thing as SaleOriginDao.load(SaleOriginPK) with an additional flag called transform.
SaleOrigin	load(SaleOriginPK saleOriginPk) Loads an instance of SaleOrigin from the persistent store.
Collection<SaleOrigin>	loadAll() Loads all entities of type SaleOrigin.
Collection<?>	loadAll(int transform) Does the same thing as SaleOriginDao.loadAll() with an additional flag called transform.
Collection<?>	loadAll(int pageNumber, int pageSize) Does the same thing as SaleOriginDao.loadAll() with an additional two arguments called pageNumber and pageSize.
Collection<?>	loadAll(int transform, int pageNumber, int pageSize) Does the same thing as SaleOriginDao.loadAll(int) with an additional two arguments called pageNumber and pageSize.
void	remove(Collection<SaleOrigin> entities) Removes all entities in the given entities collection.
void	remove(SaleOrigin saleOrigin) Removes the instance of SaleOrigin from the persistent store.
void	remove(SaleOriginPK saleOriginPk) Removes the instance of SaleOrigin having the given identifier from the persistent store.
PaginationResult	search(int transform, int pageNumber, int pageSize, Search search) Does the same thing as SaleOriginDao.search(int, Search) but with an additional two flags called pageNumber and pageSize.
PaginationResult	search(int pageNumber, int pageSize, Search search) Does the same thing as SaleOriginDao.search(Search) but with an additional two flags called pageNumber and pageSize.
Set<?>	search(int transform, Search search) Does the same thing as SaleOriginDao.search(Search) but with an additional flag called transform.
Set<SaleOrigin>	search(Search search) Performs a search using the parameters specified in the given search object.
void	toEntities(Collection<?> results) Transforms the given results to a collection of SaleOrigin instances (this is useful when the returned results contains a row of data and you want just entities only).
protected SaleOrigin	toEntity(Object[] row)
void	transformEntities(int transform, Collection<?> entities) Transforms a collection of entities using the SaleOriginDao.transformEntity(int,SaleOrigin) method.
Object	transformEntity(int transform, SaleOrigin 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 SaleOriginDao, please note that the SaleOriginDao.TRANSFORM_NONE constant denotes no transformation, so the entity itself will be returned.
void	update(Collection<SaleOrigin> entities) Updates all instances in the entities collection in the persistent store.
void	update(SaleOrigin saleOrigin) Updates the saleOrigin instance in the persistent store.

Methods inherited from class HibernateDaoSupport

convertDatabase2UI, convertUI2DatabaseMandatoryDate, createQuery, dateOfYearWithOneMiliSecond, dateOfYearWithOneMiliSecondInMili, dateWithNoMiliSecond, dateWithNoSecondAndMiliSecond, dateWithNoSecondAndOneMiliSecond, dateWithNoTime, dateWithOneMiliSecond, deleteAll, get, getSession, getSession, getSessionFactory, load, newCreateDate, queryIterator, queryIteratorTyped, queryIteratorWithPage, queryList, queryListTyped, queryUnique, queryUniqueTyped, queryUpdate, setQueryParams, setSessionFactory

Methods inherited from class Object

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

Constructor Detail

SaleOriginDaoBase

public SaleOriginDaoBase()

Method Detail

get

public Object get(int transform,
         SaleOriginPK saleOriginPk)

Does the same thing as SaleOriginDao.get(SaleOriginPK) 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:

get in interface SaleOriginDao

Parameters:

transform - flag to determine transformation type.

saleOriginPk - the identifier of the entity to get.

Returns:

either the entity or the object transformed from the entity.

get

public SaleOrigin get(SaleOriginPK saleOriginPk)

Gets an instance of SaleOrigin from the persistent store.

Specified by:

get in interface SaleOriginDao

Returns:

SaleOrigin

load

public Object load(int transform,
          SaleOriginPK saleOriginPk)

Does the same thing as SaleOriginDao.load(SaleOriginPK) 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 SaleOriginDao

Parameters:

transform - flag to determine transformation type.

saleOriginPk - the identifier of the entity to load.

Returns:

either the entity or the object transformed from the entity.

load

public SaleOrigin load(SaleOriginPK saleOriginPk)

Loads an instance of SaleOrigin from the persistent store.

Specified by:

load in interface SaleOriginDao

Returns:

SaleOrigin

loadAll

public Collection<SaleOrigin> loadAll()

Loads all entities of type SaleOrigin.

Specified by:

loadAll in interface SaleOriginDao

Returns:

the loaded entities.

loadAll

public Collection<?> loadAll(int transform)

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

Parameters:

transform - the flag indicating what transformation to use.

Returns:

the loaded entities.

loadAll

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

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

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.

loadAll

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

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

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.

calculateFirstResult

protected int calculateFirstResult(int pageNumber,
                       int pageSize)

firstResult = (pageNumber - 1) * pageSize

Parameters:

pageNumber -

pageSize -

Returns:

firstResult

create

public SaleOrigin create(SaleOrigin saleOrigin)

Creates an instance of SaleOrigin and adds it to the persistent store.

Specified by:

create in interface SaleOriginDao

Returns:

SaleOrigin

create

public Object create(int transform,
            SaleOrigin saleOrigin)

Does the same thing as SaleOriginDao.create(SaleOrigin) 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 SaleOriginDao

Returns:

Object

create

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

Creates a new instance of SaleOrigin and adds from the passed in entities collection

Specified by:

create in interface SaleOriginDao

Parameters:

entities - the collection of SaleOrigin instances to create.

Returns:

the created instances.

create

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

Does the same thing as SaleOriginDao.create(SaleOrigin) 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 SaleOriginDao

Returns:

Collection

create

public SaleOrigin create(Program program,
                Sale sale)

Creates a new SaleOrigin instance from only required properties (attributes and association ends) and adds it to the persistent store.

Specified by:

create in interface SaleOriginDao

Returns:

SaleOrigin

create

public Object create(int transform,
            Program program,
            Sale sale)

Does the same thing as #create() 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 SaleOriginDao

Parameters:

transform - flag to determine transformation type.

Returns:

Object

update

public void update(SaleOrigin saleOrigin)

Updates the saleOrigin instance in the persistent store.

Specified by:

update in interface SaleOriginDao

update

public void update(Collection<SaleOrigin> entities)

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

Specified by:

update in interface SaleOriginDao

remove

public void remove(SaleOrigin saleOrigin)

Removes the instance of SaleOrigin from the persistent store.

Specified by:

remove in interface SaleOriginDao

remove

public void remove(SaleOriginPK saleOriginPk)

Removes the instance of SaleOrigin having the given identifier from the persistent store.

Specified by:

remove in interface SaleOriginDao

remove

public void remove(Collection<SaleOrigin> entities)

Removes all entities in the given entities collection.

Specified by:

remove in interface SaleOriginDao

transformEntity

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

Specified by:

transformEntity in interface SaleOriginDao

Parameters:

transform - one of the constants declared in SaleOriginDao

entity - an entity that was found

Returns:

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

See Also:

SaleOriginDao.transformEntity(int, SaleOrigin)

transformEntities

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

Transforms a collection of entities using the SaleOriginDao.transformEntity(int,SaleOrigin) method. This method does not instantiate a new collection.

This method is to be used internally only.

Specified by:

transformEntities in interface SaleOriginDao

Parameters:

transform - one of the constants declared in fr.ifremer.adagio.core.dao.data.survey.sale.SaleOriginDao

entities - the collection of entities to transform

See Also:

SaleOriginDao.transformEntity(int,SaleOrigin)

toEntities

public void toEntities(Collection<?> results)

Description copied from interface: SaleOriginDao

Transforms the given results to a collection of SaleOrigin instances (this is useful when the returned results contains a row of data and you want just entities only).

Specified by:

toEntities in interface SaleOriginDao

Parameters:

results - the query results.

See Also:

SaleOriginDao.toEntities(Collection)

toEntity

protected SaleOrigin toEntity(Object[] row)

Parameters:

row -

Returns:

SaleOrigin

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)

Does the same thing as SaleOriginDao.search(int, 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 SaleOriginDao

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.

search

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

Does the same thing as SaleOriginDao.search(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 SaleOriginDao

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.

search

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

Does the same thing as SaleOriginDao.search(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 SaleOriginDao

Parameters:

transform - the transformation flag.

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

Returns:

any found results from the search.

search

public Set<SaleOrigin> search(Search search)

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

Specified by:

search in interface SaleOriginDao

Parameters:

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

Returns:

any found results from the search.

getPaginationResult

protected PaginationResult getPaginationResult(Query queryObject,
                                   int transform,
                                   int pageNumber,
                                   int pageSize)

Executes and returns the given Hibernate queryObject as a PaginationResult instance.

Parameters:

queryObject -

transform -

pageNumber -

pageSize -

Returns:

PaginationResult