fr.ifremer.adagio.core.dao.referential.conversion

Class UnitConversionDaoBase

Object

HibernateDaoSupport

UnitConversionDaoBase

All Implemented Interfaces:

UnitConversionDao

Direct Known Subclasses:

UnitConversionDaoImpl

public abstract class UnitConversionDaoBase
extends HibernateDaoSupport
implements UnitConversionDao

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

See Also:

UnitConversion

Field Summary

Fields inherited from class HibernateDaoSupport

debugEntityLoad, logger

Fields inherited from interface UnitConversionDao

TRANSFORM_NONE

Constructor Summary

Constructors

Constructor and Description
UnitConversionDaoBase()

Method Summary

Methods

Modifier and Type	Method and Description
protected int	calculateFirstResult(int pageNumber, int pageSize) firstResult = (pageNumber - 1) * pageSize
Collection<UnitConversion>	create(Collection<UnitConversion> entities) Creates a new instance of UnitConversion and adds from the passed in entities collection
UnitConversion	create(Float conversionCoefficient, Timestamp updateDate) Creates a new UnitConversion instance from all attributes and adds it to the persistent store.
UnitConversion	create(Float conversionCoefficient, Unit fromUnit, Unit toUnit, Timestamp updateDate) Creates a new UnitConversion instance from only required properties (attributes and association ends) and adds it to the persistent store.
Collection<?>	create(int transform, Collection<UnitConversion> entities) Does the same thing as UnitConversionDao.create(UnitConversion) with an additional flag called transform.
Object	create(int transform, Float conversionCoefficient, Timestamp updateDate) Does the same thing as UnitConversionDao.create(Float, Timestamp) with an additional flag called transform.
Object	create(int transform, Float conversionCoefficient, Unit fromUnit, Unit toUnit, Timestamp updateDate) Does the same thing as UnitConversionDao.create(Float, Timestamp) with an additional flag called transform.
Object	create(int transform, UnitConversion unitConversion) Does the same thing as UnitConversionDao.create(UnitConversion) with an additional flag called transform.
UnitConversion	create(UnitConversion unitConversion) Creates an instance of UnitConversion and adds it to the persistent store.
Object	get(int transform, UnitConversionPK unitConversionPk) Does the same thing as UnitConversionDao.get(UnitConversionPK) with an additional flag called transform.
UnitConversion	get(UnitConversionPK unitConversionPk) Gets an instance of UnitConversion 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, UnitConversionPK unitConversionPk) Does the same thing as UnitConversionDao.load(UnitConversionPK) with an additional flag called transform.
UnitConversion	load(UnitConversionPK unitConversionPk) Loads an instance of UnitConversion from the persistent store.
Collection<UnitConversion>	loadAll() Loads all entities of type UnitConversion.
Collection<?>	loadAll(int transform) Does the same thing as UnitConversionDao.loadAll() with an additional flag called transform.
Collection<?>	loadAll(int pageNumber, int pageSize) Does the same thing as UnitConversionDao.loadAll() with an additional two arguments called pageNumber and pageSize.
Collection<?>	loadAll(int transform, int pageNumber, int pageSize) Does the same thing as UnitConversionDao.loadAll(int) with an additional two arguments called pageNumber and pageSize.
void	remove(Collection<UnitConversion> entities) Removes all entities in the given entities collection.
void	remove(UnitConversion unitConversion) Removes the instance of UnitConversion from the persistent store.
void	remove(UnitConversionPK unitConversionPk) Removes the instance of UnitConversion having the given identifier from the persistent store.
PaginationResult	search(int transform, int pageNumber, int pageSize, Search search) Does the same thing as UnitConversionDao.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 UnitConversionDao.search(Search) but with an additional two flags called pageNumber and pageSize.
Set<?>	search(int transform, Search search) Does the same thing as UnitConversionDao.search(Search) but with an additional flag called transform.
Set<UnitConversion>	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 UnitConversion instances (this is useful when the returned results contains a row of data and you want just entities only).
protected UnitConversion	toEntity(Object[] row)
void	transformEntities(int transform, Collection<?> entities) Transforms a collection of entities using the UnitConversionDao.transformEntity(int,UnitConversion) method.
Object	transformEntity(int transform, UnitConversion 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 UnitConversionDao, please note that the UnitConversionDao.TRANSFORM_NONE constant denotes no transformation, so the entity itself will be returned.
void	update(Collection<UnitConversion> entities) Updates all instances in the entities collection in the persistent store.
void	update(UnitConversion unitConversion) Updates the unitConversion 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

UnitConversionDaoBase

public UnitConversionDaoBase()

Method Detail

get

public Object get(int transform,
         UnitConversionPK unitConversionPk)

Does the same thing as UnitConversionDao.get(UnitConversionPK) 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 UnitConversionDao

Parameters:

transform - flag to determine transformation type.

unitConversionPk - the identifier of the entity to get.

Returns:

either the entity or the object transformed from the entity.

get

public UnitConversion get(UnitConversionPK unitConversionPk)

Gets an instance of UnitConversion from the persistent store.

Specified by:

get in interface UnitConversionDao

Returns:

UnitConversion

load

public Object load(int transform,
          UnitConversionPK unitConversionPk)

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

Parameters:

transform - flag to determine transformation type.

unitConversionPk - the identifier of the entity to load.

Returns:

either the entity or the object transformed from the entity.

load

public UnitConversion load(UnitConversionPK unitConversionPk)

Loads an instance of UnitConversion from the persistent store.

Specified by:

load in interface UnitConversionDao

Returns:

UnitConversion

loadAll

public Collection<UnitConversion> loadAll()

Loads all entities of type UnitConversion.

Specified by:

loadAll in interface UnitConversionDao

Returns:

the loaded entities.

loadAll

public Collection<?> loadAll(int transform)

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

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 UnitConversionDao.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 UnitConversionDao

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 UnitConversionDao.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 UnitConversionDao

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 UnitConversion create(UnitConversion unitConversion)

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

Specified by:

create in interface UnitConversionDao

Returns:

UnitConversion

create

public Object create(int transform,
            UnitConversion unitConversion)

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

Returns:

Object

create

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

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

Specified by:

create in interface UnitConversionDao

Parameters:

entities - the collection of UnitConversion instances to create.

Returns:

the created instances.

create

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

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

Returns:

Collection

create

public UnitConversion create(Float conversionCoefficient,
                    Timestamp updateDate)

Creates a new UnitConversion instance from all attributes and adds it to the persistent store.

Specified by:

create in interface UnitConversionDao

Returns:

UnitConversion

create

public Object create(int transform,
            Float conversionCoefficient,
            Timestamp updateDate)

Does the same thing as UnitConversionDao.create(Float, Timestamp) 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 UnitConversionDao

Returns:

UnitConversion

create

public UnitConversion create(Float conversionCoefficient,
                    Unit fromUnit,
                    Unit toUnit,
                    Timestamp updateDate)

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

Specified by:

create in interface UnitConversionDao

Returns:

UnitConversion

create

public Object create(int transform,
            Float conversionCoefficient,
            Unit fromUnit,
            Unit toUnit,
            Timestamp updateDate)

Does the same thing as UnitConversionDao.create(Float, Timestamp) 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 UnitConversionDao

Parameters:

transform - flag to determine transformation type.

Returns:

Object

update

public void update(UnitConversion unitConversion)

Updates the unitConversion instance in the persistent store.

Specified by:

update in interface UnitConversionDao

update

public void update(Collection<UnitConversion> entities)

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

Specified by:

update in interface UnitConversionDao

remove

public void remove(UnitConversion unitConversion)

Removes the instance of UnitConversion from the persistent store.

Specified by:

remove in interface UnitConversionDao

remove

public void remove(UnitConversionPK unitConversionPk)

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

Specified by:

remove in interface UnitConversionDao

remove

public void remove(Collection<UnitConversion> entities)

Removes all entities in the given entities collection.

Specified by:

remove in interface UnitConversionDao

transformEntity

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

Specified by:

transformEntity in interface UnitConversionDao

Parameters:

transform - one of the constants declared in UnitConversionDao

entity - an entity that was found

Returns:

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

See Also:

UnitConversionDao.transformEntity(int, UnitConversion)

transformEntities

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

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

This method is to be used internally only.

Specified by:

transformEntities in interface UnitConversionDao

Parameters:

transform - one of the constants declared in fr.ifremer.adagio.core.dao.referential.conversion.UnitConversionDao

entities - the collection of entities to transform

See Also:

UnitConversionDao.transformEntity(int,UnitConversion)

toEntities

public void toEntities(Collection<?> results)

Description copied from interface: UnitConversionDao

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

Specified by:

toEntities in interface UnitConversionDao

Parameters:

results - the query results.

See Also:

UnitConversionDao.toEntities(Collection)

toEntity

protected UnitConversion toEntity(Object[] row)

Parameters:

row -

Returns:

UnitConversion

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 UnitConversionDao.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 UnitConversionDao

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 UnitConversionDao.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 UnitConversionDao

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 UnitConversionDao.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 UnitConversionDao

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<UnitConversion> search(Search search)

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

Specified by:

search in interface UnitConversionDao

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