fr.ifremer.adagio.core.dao.referential.pmfm

Class PmfmDaoBase

Object

HibernateDaoSupport

PmfmDaoBase

All Implemented Interfaces:

PmfmDao

Direct Known Subclasses:

PmfmDaoImpl

public abstract class PmfmDaoBase
extends HibernateDaoSupport
implements PmfmDao

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

See Also:

Pmfm

Field Summary

Fields inherited from class HibernateDaoSupport

debugEntityLoad, logger

Fields inherited from interface PmfmDao

TRANSFORM_NONE

Constructor Summary

Constructors

Constructor and Description
PmfmDaoBase()

Method Summary

Methods

Modifier and Type	Method and Description
protected int	calculateFirstResult(int pageNumber, int pageSize) firstResult = (pageNumber - 1) * pageSize
Pmfm	create(AggregationLevel aggregationLevel, Date creationDate, Fraction fraction, Matrix matrix, Method method, Parameter parameter, Status status, Unit unit, Timestamp updateDate, ValidityStatus validityStatus) Creates a new Pmfm instance from only required properties (attributes and association ends) and adds it to the persistent store.
Collection<Pmfm>	create(Collection<Pmfm> entities) Creates a new instance of Pmfm and adds from the passed in entities collection
Object	create(int transform, AggregationLevel aggregationLevel, Date creationDate, Fraction fraction, Matrix matrix, Method method, Parameter parameter, Status status, Unit unit, Timestamp updateDate, ValidityStatus validityStatus) Does the same thing as #create(Date, Timestamp) with an additional flag called transform.
Collection<?>	create(int transform, Collection<Pmfm> entities) Does the same thing as PmfmDao.create(Pmfm) with an additional flag called transform.
Pmfm	create(Integer signifFiguresNumber, Integer maximumNumberDecimals, Float detectionThreshold, Float minValue, Float maxValue, Float precision, Float defaultValue, Date creationDate, String description, String comments, Timestamp updateDate) Creates a new Pmfm instance from all attributes and adds it to the persistent store.
Object	create(int transform, Integer signifFiguresNumber, Integer maximumNumberDecimals, Float detectionThreshold, Float minValue, Float maxValue, Float precision, Float defaultValue, Date creationDate, String description, String comments, Timestamp updateDate) Does the same thing as PmfmDao.create(Integer, Integer, Float, Float, Float, Float, Float, Date, String, String, Timestamp) with an additional flag called transform.
Object	create(int transform, Pmfm pmfm) Does the same thing as PmfmDao.create(Pmfm) with an additional flag called transform.
Pmfm	create(Pmfm pmfm) Creates an instance of Pmfm and adds it to the persistent store.
Pmfm	get(Integer id) Gets an instance of Pmfm from the persistent store.
Object	get(int transform, Integer id) Does the same thing as PmfmDao.get(Integer) with an additional flag called transform.
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.
Pmfm	load(Integer id) Loads an instance of Pmfm from the persistent store.
Object	load(int transform, Integer id) Does the same thing as PmfmDao.load(Integer) with an additional flag called transform.
Collection<Pmfm>	loadAll() Loads all entities of type Pmfm.
Collection<?>	loadAll(int transform) Does the same thing as PmfmDao.loadAll() with an additional flag called transform.
Collection<?>	loadAll(int pageNumber, int pageSize) Does the same thing as PmfmDao.loadAll() with an additional two arguments called pageNumber and pageSize.
Collection<?>	loadAll(int transform, int pageNumber, int pageSize) Does the same thing as PmfmDao.loadAll(int) with an additional two arguments called pageNumber and pageSize.
void	remove(Collection<Pmfm> entities) Removes all entities in the given entities collection.
void	remove(Integer id) Removes the instance of Pmfm having the given identifier from the persistent store.
void	remove(Pmfm pmfm) Removes the instance of Pmfm from the persistent store.
PaginationResult	search(int transform, int pageNumber, int pageSize, Search search) Does the same thing as PmfmDao.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 PmfmDao.search(Search) but with an additional two flags called pageNumber and pageSize.
Set<?>	search(int transform, Search search) Does the same thing as PmfmDao.search(Search) but with an additional flag called transform.
Set<Pmfm>	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 Pmfm instances (this is useful when the returned results contains a row of data and you want just entities only).
protected Pmfm	toEntity(Object[] row)
void	transformEntities(int transform, Collection<?> entities) Transforms a collection of entities using the PmfmDao.transformEntity(int,Pmfm) method.
Object	transformEntity(int transform, Pmfm 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 PmfmDao, please note that the PmfmDao.TRANSFORM_NONE constant denotes no transformation, so the entity itself will be returned.
void	update(Collection<Pmfm> entities) Updates all instances in the entities collection in the persistent store.
void	update(Pmfm pmfm) Updates the pmfm 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

PmfmDaoBase

public PmfmDaoBase()

Method Detail

get

public Object get(int transform,
         Integer id)

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

get in interface PmfmDao

Parameters:

transform - flag to determine transformation type.

id - the identifier of the entity to get.

Returns:

either the entity or the object transformed from the entity.

get

public Pmfm get(Integer id)

Gets an instance of Pmfm from the persistent store.

Specified by:

get in interface PmfmDao

Returns:

Pmfm

load

public Object load(int transform,
          Integer id)

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

Parameters:

transform - flag to determine transformation type.

id - the identifier of the entity to load.

Returns:

either the entity or the object transformed from the entity.

load

public Pmfm load(Integer id)

Loads an instance of Pmfm from the persistent store.

Specified by:

load in interface PmfmDao

Returns:

Pmfm

loadAll

public Collection<Pmfm> loadAll()

Loads all entities of type Pmfm.

Specified by:

loadAll in interface PmfmDao

Returns:

the loaded entities.

loadAll

public Collection<?> loadAll(int transform)

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

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

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

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 Pmfm create(Pmfm pmfm)

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

Specified by:

create in interface PmfmDao

Returns:

Pmfm

create

public Object create(int transform,
            Pmfm pmfm)

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

Returns:

Object

create

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

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

Specified by:

create in interface PmfmDao

Parameters:

entities - the collection of Pmfm instances to create.

Returns:

the created instances.

create

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

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

Returns:

Collection

create

public Pmfm create(Integer signifFiguresNumber,
          Integer maximumNumberDecimals,
          Float detectionThreshold,
          Float minValue,
          Float maxValue,
          Float precision,
          Float defaultValue,
          Date creationDate,
          String description,
          String comments,
          Timestamp updateDate)

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

Specified by:

create in interface PmfmDao

Parameters:

signifFiguresNumber - Nombre de chiffres significatifs en tout du résultat pour le quadruplet concerné.

maximumNumberDecimals - Nombre de décimales significatives pour le résultat mesuré/analysé suivant le quadruplet lié.

detectionThreshold - Seuil de détection des instruments de mesure et de la méthode associée.

minValue - Valeur mimimale autorisée par défaut (peut etre redéfini dans les stratégies).

maxValue - Valeur maximale autorisée par défaut (peut etre redéfini dans les stratégies).

defaultValue - Précision de la mesure associé pour le PSFM.Typiquement, cette précision est utile lors de la saisie de plusieursinstruments et de la méthode associée.

Returns:

Pmfm

create

public Object create(int transform,
            Integer signifFiguresNumber,
            Integer maximumNumberDecimals,
            Float detectionThreshold,
            Float minValue,
            Float maxValue,
            Float precision,
            Float defaultValue,
            Date creationDate,
            String description,
            String comments,
            Timestamp updateDate)

Does the same thing as PmfmDao.create(Integer, Integer, Float, Float, Float, Float, Float, Date, String, String, 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 PmfmDao

signifFiguresNumber - Nombre de chiffres significatifs en tout du résultat pour le quadruplet concerné.

maximumNumberDecimals - Nombre de décimales significatives pour le résultat mesuré/analysé suivant le quadruplet lié.

detectionThreshold - Seuil de détection des instruments de mesure et de la méthode associée.

minValue - Valeur mimimale autorisée par défaut (peut etre redéfini dans les stratégies).

maxValue - Valeur maximale autorisée par défaut (peut etre redéfini dans les stratégies).

defaultValue - Précision de la mesure associé pour le PSFM.Typiquement, cette précision est utile lors de la saisie de plusieursinstruments et de la méthode associée.

Returns:

Pmfm

create

public Pmfm create(AggregationLevel aggregationLevel,
          Date creationDate,
          Fraction fraction,
          Matrix matrix,
          Method method,
          Parameter parameter,
          Status status,
          Unit unit,
          Timestamp updateDate,
          ValidityStatus validityStatus)

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

Specified by:

create in interface PmfmDao

Returns:

Pmfm

create

public Object create(int transform,
            AggregationLevel aggregationLevel,
            Date creationDate,
            Fraction fraction,
            Matrix matrix,
            Method method,
            Parameter parameter,
            Status status,
            Unit unit,
            Timestamp updateDate,
            ValidityStatus validityStatus)

Does the same thing as #create(Date, 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 PmfmDao

Parameters:

transform - flag to determine transformation type.

Returns:

Object

update

public void update(Pmfm pmfm)

Updates the pmfm instance in the persistent store.

Specified by:

update in interface PmfmDao

update

public void update(Collection<Pmfm> entities)

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

Specified by:

update in interface PmfmDao

remove

public void remove(Pmfm pmfm)

Removes the instance of Pmfm from the persistent store.

Specified by:

remove in interface PmfmDao

remove

public void remove(Integer id)

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

Specified by:

remove in interface PmfmDao

remove

public void remove(Collection<Pmfm> entities)

Removes all entities in the given entities collection.

Specified by:

remove in interface PmfmDao

transformEntity

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

Specified by:

transformEntity in interface PmfmDao

Parameters:

transform - one of the constants declared in PmfmDao

entity - an entity that was found

Returns:

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

See Also:

PmfmDao.transformEntity(int, Pmfm)

transformEntities

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

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

This method is to be used internally only.

Specified by:

transformEntities in interface PmfmDao

Parameters:

transform - one of the constants declared in fr.ifremer.adagio.core.dao.referential.pmfm.PmfmDao

entities - the collection of entities to transform

See Also:

PmfmDao.transformEntity(int,Pmfm)

toEntities

public void toEntities(Collection<?> results)

Description copied from interface: PmfmDao

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

Specified by:

toEntities in interface PmfmDao

Parameters:

results - the query results.

See Also:

PmfmDao.toEntities(Collection)

toEntity

protected Pmfm toEntity(Object[] row)

Parameters:

row -

Returns:

Pmfm

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

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

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

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

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

Specified by:

search in interface PmfmDao

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