MethodDaoBase (SIH-Adagio :: Core 3.5.6 API)

Object
- HibernateDaoSupport
- - MethodDaoBase

All Implemented Interfaces:

MethodDao

Direct Known Subclasses:

MethodDaoImpl
```
public abstract class MethodDaoBase
extends HibernateDaoSupport
implements MethodDao
```
Base Spring DAO Class: is able to create, update, remove, load, and find objects of type Method.

See Also:
Method

Field Summary
- Fields inherited from class HibernateDaoSupport
  debugEntityLoad, logger
- Fields inherited from interface MethodDao
  TRANSFORM_NONE

Constructor Summary

Constructors
Constructor and Description

MethodDaoBase()

Constructors
Constructor and Description
`MethodDaoBase()`

Method Summary

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

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MethodDaoBase
```
public MethodDaoBase()
```
- Method Detail
  - get
```
public Object get(int transform,
         Integer id)
```
    Does the same thing as MethodDao.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 MethodDao
    
    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 Method get(Integer id)
```
    Gets an instance of Method from the persistent store.
    
    Specified by:
    
    get in interface MethodDao
    
    Returns:
    Method
  - load
```
public Object load(int transform,
          Integer id)
```
    Does the same thing as MethodDao.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 MethodDao
    
    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 Method load(Integer id)
```
    Loads an instance of Method from the persistent store.
    
    Specified by:
    
    load in interface MethodDao
    
    Returns:
    Method
  - loadAll
```
public Collection<Method> loadAll()
```
    Loads all entities of type Method.
    
    Specified by:
    
    loadAll in interface MethodDao
    
    Returns:
    the loaded entities.
  - loadAll
```
public Collection<?> loadAll(int transform)
```
    Does the same thing as MethodDao.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 MethodDao
    
    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 MethodDao.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 MethodDao
    
    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 MethodDao.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 MethodDao
    
    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 Method create(Method method)
```
    Creates an instance of Method and adds it to the persistent store.
    
    Specified by:
    
    create in interface MethodDao
    
    Returns:
    Method
  - create
```
public Object create(int transform,
            Method method)
```
    Does the same thing as MethodDao.create(Method) 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 MethodDao
    
    Returns:
    Object
  - create
```
public Collection<Method> create(Collection<Method> entities)
```
    Creates a new instance of Method and adds from the passed in entities collection
    
    Specified by:
    
    create in interface MethodDao
    
    Parameters:
    entities - the collection of Method instances to create.
    
    Returns:
    the created instances.
  - create
```
public Collection<?> create(int transform,
                   Collection<Method> entities)
```
    Does the same thing as MethodDao.create(Method) 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 MethodDao
    
    Returns:
    Collection
  - create
```
public Method create(String name,
            String description,
            String conditioning,
            String preparation,
            String conservation,
            String reference,
            String rank,
            String handbookPath,
            Date creationDate,
            Timestamp updateDate)
```
    Creates a new Method instance from all attributes and adds it to the persistent store.
    
    Specified by:
    
    create in interface MethodDao
    
    Parameters:
    name - Description courte de la méthode.
    description - Description longue de la méthode.
    conditioning - Description du conditionnement des échantillons ou des prélèvements en vue de leur analyse.
    preparation - Description de la préparation des échantillons ou des prélèvements en vue de leur analyse.
    conservation - Description de la méthode de conservation des échantillons ou des prélèvements en vue de leur analyse.
    reference - Référence nationale ou internationale de la méthode. Référence à l'origine de la méthode. Par exemple : - "Bradford M., 1976. A rapid method for quantification of protein utilizing the principle of dye binding. Anal. Biochem. 72 : 248-264" - "Circulaire 1988 Mer/Agriculture" Nombre de lignes : 500
    rank - Numéro de la méthode pour pouvoir "chainer" les méthodes. Il est saisi par l'administrateur.
    handbookPath - Lien vers un fichier PDF décrivant plus précisemment la méthode.
    creationDate - Date système de création de la méthode. Cette date est renseignée automatiquement.
    updateDate - Date de mise à jour de création de la méthode. Cette date est renseignée automatiquement.
    
    Returns:
    Method
  - create
```
public Object create(int transform,
            String name,
            String description,
            String conditioning,
            String preparation,
            String conservation,
            String reference,
            String rank,
            String handbookPath,
            Date creationDate,
            Timestamp updateDate)
```
    Does the same thing as MethodDao.create(String, String, String, String, String, String, String, String, 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 MethodDao
    
    name - Description courte de la méthode.
    description - Description longue de la méthode.
    conditioning - Description du conditionnement des échantillons ou des prélèvements en vue de leur analyse.
    preparation - Description de la préparation des échantillons ou des prélèvements en vue de leur analyse.
    conservation - Description de la méthode de conservation des échantillons ou des prélèvements en vue de leur analyse.
    reference - Référence nationale ou internationale de la méthode. Référence à l'origine de la méthode. Par exemple : - "Bradford M., 1976. A rapid method for quantification of protein utilizing the principle of dye binding. Anal. Biochem. 72 : 248-264" - "Circulaire 1988 Mer/Agriculture" Nombre de lignes : 500
    rank - Numéro de la méthode pour pouvoir "chainer" les méthodes. Il est saisi par l'administrateur.
    handbookPath - Lien vers un fichier PDF décrivant plus précisemment la méthode.
    creationDate - Date système de création de la méthode. Cette date est renseignée automatiquement.
    updateDate - Date de mise à jour de création de la méthode. Cette date est renseignée automatiquement.
    
    Returns:
    Method
  - create
```
public Method create(Date creationDate,
            String name,
            String rank,
            Status status,
            Timestamp updateDate)
```
    Creates a new Method instance from only required properties (attributes and association ends) and adds it to the persistent store.
    
    Specified by:
    
    create in interface MethodDao
    
    Returns:
    Method
  - create
```
public Object create(int transform,
            Date creationDate,
            String name,
            String rank,
            Status status,
            Timestamp updateDate)
```
    Does the same thing as #create(String, String, 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 MethodDao
    
    Parameters:
    transform - flag to determine transformation type.
    
    Returns:
    Object
  - update
```
public void update(Method method)
```
    Updates the method instance in the persistent store.
    
    Specified by:
    
    update in interface MethodDao
  - update
```
public void update(Collection<Method> entities)
```
    Updates all instances in the entities collection in the persistent store.
    
    Specified by:
    
    update in interface MethodDao
  - remove
```
public void remove(Method method)
```
    Removes the instance of Method from the persistent store.
    
    Specified by:
    
    remove in interface MethodDao
  - remove
```
public void remove(Integer id)
```
    Removes the instance of Method having the given identifier from the persistent store.
    
    Specified by:
    
    remove in interface MethodDao
  - remove
```
public void remove(Collection<Method> entities)
```
    Removes all entities in the given entities collection.
    
    Specified by:
    
    remove in interface MethodDao
  - transformEntity
```
public Object transformEntity(int transform,
                     Method 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 MethodDao, please note that the MethodDao.TRANSFORM_NONE constant denotes no transformation, so the entity itself will be returned. If the integer argument value is unknown MethodDao.TRANSFORM_NONE is assumed.
    
    Specified by:
    
    transformEntity in interface MethodDao
    
    Parameters:
    transform - one of the constants declared in MethodDao
    entity - an entity that was found
    
    Returns:
    the transformed entity (i.e. new value object, etc)
    See Also:
    MethodDao.transformEntity(int, Method)
  - transformEntities
```
public void transformEntities(int transform,
                     Collection<?> entities)
```
    Transforms a collection of entities using the MethodDao.transformEntity(int,Method) method. This method does not instantiate a new collection.
    This method is to be used internally only.
    
    Specified by:
    
    transformEntities in interface MethodDao
    
    Parameters:
    transform - one of the constants declared in fr.ifremer.adagio.core.dao.referential.pmfm.MethodDao
    entities - the collection of entities to transform
    See Also:
    MethodDao.transformEntity(int,Method)
  - toEntities
```
public void toEntities(Collection<?> results)
```
    Description copied from interface: MethodDao
    
    Transforms the given results to a collection of Method instances (this is useful when the returned results contains a row of data and you want just entities only).
    
    Specified by:
    
    toEntities in interface MethodDao
    
    Parameters:
    results - the query results.
    See Also:
    MethodDao.toEntities(Collection)
  - toEntity
```
protected Method toEntity(Object[] row)
```
    Parameters:
    row -
    
    Returns:
    Method
  - 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 MethodDao.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 MethodDao
    
    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 MethodDao.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 MethodDao
    
    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 MethodDao.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 MethodDao
    
    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<Method> search(Search search)
```
    Performs a search using the parameters specified in the given search object.
    
    Specified by:
    
    search in interface MethodDao
    
    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

Class MethodDaoBase

Field Summary

Fields inherited from class HibernateDaoSupport

Fields inherited from interface MethodDao

Constructor Summary

Method Summary

Methods inherited from class HibernateDaoSupport

Methods inherited from class Object

Constructor Detail

MethodDaoBase

Method Detail

get

get

load

load

loadAll

loadAll

loadAll

loadAll

calculateFirstResult

create

create

create

create

create

create

create

create

update

update

remove

remove

remove

transformEntity

transformEntities

toEntities

toEntity

getPrincipal

search

search

search

search

getPaginationResult