ProduceDaoBase (SIH-Adagio :: Core 3.5.6 API)

Object
- HibernateDaoSupport
- - ProduceDaoBase

All Implemented Interfaces:

ProduceDao

Direct Known Subclasses:

ProduceDaoImpl
```
public abstract class ProduceDaoBase
extends HibernateDaoSupport
implements ProduceDao
```
Base Spring DAO Class: is able to create, update, remove, load, and find objects of type Produce.

See Also:
Produce

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

Constructor Summary

Constructors
Constructor and Description

ProduceDaoBase()

Constructors
Constructor and Description
`ProduceDaoBase()`

Method Summary

Methods
Modifier and Type	Method and Description
`protected int`	`calculateFirstResult(int pageNumber, int pageSize)` firstResult = (pageNumber - 1) * pageSize
`Produce`	`create(Boolean isDiscard, Collection<ProduceQuantificationMeasurement> produceQuantificationMeasurements, QualityFlag qualityFlag, TaxonGroup taxonGroup)` Creates a new `Produce` instance from only required properties (attributes and association ends) and adds it to the persistent store.
`Produce`	`create(Boolean isDiscard, Float subgroupCount, Short individualCount, String taxonGroupOtherInformation, Date controlDate, Date validationDate, Date qualificationDate, String qualificationComments, Float weight, Float cost)` Creates a new `Produce` instance from all attributes and adds it to the persistent store.
`Collection<Produce>`	`create(Collection<Produce> entities)` Creates a new instance of Produce and adds from the passed in `entities` collection
`Object`	`create(int transform, Boolean isDiscard, Collection<ProduceQuantificationMeasurement> produceQuantificationMeasurements, QualityFlag qualityFlag, TaxonGroup taxonGroup)` Does the same thing as `#create(Boolean)` with an additional flag called `transform`.
`Object`	`create(int transform, Boolean isDiscard, Float subgroupCount, Short individualCount, String taxonGroupOtherInformation, Date controlDate, Date validationDate, Date qualificationDate, String qualificationComments, Float weight, Float cost)` Does the same thing as `ProduceDao.create(Boolean, Float, Short, String, Date, Date, Date, String, Float, Float)` with an additional flag called `transform`.
`Collection<?>`	`create(int transform, Collection<Produce> entities)` Does the same thing as `ProduceDao.create(Produce)` with an additional flag called `transform`.
`Object`	`create(int transform, Produce produce)` Does the same thing as `ProduceDao.create(Produce)` with an additional flag called `transform`.
`Produce`	`create(Produce produce)` Creates an instance of Produce and adds it to the persistent store.
`Produce`	`get(Integer id)` Gets an instance of Produce from the persistent store.
`Object`	`get(int transform, Integer id)` Does the same thing as `ProduceDao.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`.
`Produce`	`load(Integer id)` Loads an instance of Produce from the persistent store.
`Object`	`load(int transform, Integer id)` Does the same thing as `ProduceDao.load(Integer)` with an additional flag called `transform`.
`Collection<Produce>`	`loadAll()` Loads all entities of type `Produce`.
`Collection<?>`	`loadAll(int transform)` Does the same thing as `ProduceDao.loadAll()` with an additional flag called `transform`.
`Collection<?>`	`loadAll(int pageNumber, int pageSize)` Does the same thing as `ProduceDao.loadAll()` with an additional two arguments called `pageNumber` and `pageSize`.
`Collection<?>`	`loadAll(int transform, int pageNumber, int pageSize)` Does the same thing as `ProduceDao.loadAll(int)` with an additional two arguments called `pageNumber` and `pageSize`.
`void`	`remove(Collection<Produce> entities)` Removes all entities in the given `entities` collection.
`void`	`remove(Integer id)` Removes the instance of Produce having the given `identifier` from the persistent store.
`void`	`remove(Produce produce)` Removes the instance of Produce from the persistent store.
`PaginationResult`	`search(int transform, int pageNumber, int pageSize, Search search)` Does the same thing as `ProduceDao.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 `ProduceDao.search(Search)` but with an additional two flags called `pageNumber` and `pageSize`.
`Set<?>`	`search(int transform, Search search)` Does the same thing as `ProduceDao.search(Search)` but with an additional flag called `transform`.
`Set<Produce>`	`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 `Produce` instances (this is useful when the returned results contains a row of data and you want just entities only).
`protected Produce`	`toEntity(Object[] row)`
`void`	`transformEntities(int transform, Collection<?> entities)` Transforms a collection of entities using the `ProduceDao.transformEntity(int,Produce)` method.
`Object`	`transformEntity(int transform, Produce 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 `ProduceDao`, please note that the `ProduceDao.TRANSFORM_NONE` constant denotes no transformation, so the entity itself will be returned.
`void`	`update(Collection<Produce> entities)` Updates all instances in the `entities` collection in the persistent store.
`void`	`update(Produce produce)` Updates the `produce` instance in the persistent store.

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

- Constructor Detail
  - ProduceDaoBase
```
public ProduceDaoBase()
```
- Method Detail
  - get
```
public Object get(int transform,
         Integer id)
```
    Does the same thing as ProduceDao.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 ProduceDao
    
    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 Produce get(Integer id)
```
    Gets an instance of Produce from the persistent store.
    
    Specified by:
    
    get in interface ProduceDao
    
    Returns:
    Produce
  - load
```
public Object load(int transform,
          Integer id)
```
    Does the same thing as ProduceDao.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 ProduceDao
    
    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 Produce load(Integer id)
```
    Loads an instance of Produce from the persistent store.
    
    Specified by:
    
    load in interface ProduceDao
    
    Returns:
    Produce
  - loadAll
```
public Collection<Produce> loadAll()
```
    Loads all entities of type Produce.
    
    Specified by:
    
    loadAll in interface ProduceDao
    
    Returns:
    the loaded entities.
  - loadAll
```
public Collection<?> loadAll(int transform)
```
    Does the same thing as ProduceDao.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 ProduceDao
    
    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 ProduceDao.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 ProduceDao
    
    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 ProduceDao.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 ProduceDao
    
    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 Produce create(Produce produce)
```
    Creates an instance of Produce and adds it to the persistent store.
    
    Specified by:
    
    create in interface ProduceDao
    
    Returns:
    Produce
  - create
```
public Object create(int transform,
            Produce produce)
```
    Does the same thing as ProduceDao.create(Produce) 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 ProduceDao
    
    Returns:
    Object
  - create
```
public Collection<Produce> create(Collection<Produce> entities)
```
    Creates a new instance of Produce and adds from the passed in entities collection
    
    Specified by:
    
    create in interface ProduceDao
    
    Parameters:
    entities - the collection of Produce instances to create.
    
    Returns:
    the created instances.
  - create
```
public Collection<?> create(int transform,
                   Collection<Produce> entities)
```
    Does the same thing as ProduceDao.create(Produce) 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 ProduceDao
    
    Returns:
    Collection
  - create
```
public Produce create(Boolean isDiscard,
             Float subgroupCount,
             Short individualCount,
             String taxonGroupOtherInformation,
             Date controlDate,
             Date validationDate,
             Date qualificationDate,
             String qualificationComments,
             Float weight,
             Float cost)
```
    Creates a new Produce instance from all attributes and adds it to the persistent store.
    
    Specified by:
    
    create in interface ProduceDao
    
    Parameters:
    isDiscard - Le produit est-il un rejet ou non ?
    subgroupCount - Nombre de sous ensembles ayant servit à la quantification. Par exemple il pourra s'agir d'un nombre de caisse servant à quantifié le produit. Par exemple, pour une détermination de la quantification par les volumes : - nombre_sous_ensembles_quantifiés = 3 - poids moyen par sous-ensemble = 5 kg => Poids total du lot = 3 x 5 = 15kg
    individualCount - Nombre d'individus (optionnel). Utile pour les très gros individu. Ex : 1 espadon de 150kg
    taxonGroupOtherInformation - Autre information sur l'espèce du produit. Utilisé dans SACROIS/RIC2, pour stocker des informations complémentaires issues du référentiel espèce du Réseau Inter Criée (RIC).
    weight - Poids total du lot/produit (en kg). Il peut s'agir d'une poids vif ou d'un poids brut, suivant si la la présence ou l'absence de l’état et de la présentation.
    cost - Prix total, exprimé dans l'unité utilisée par du système SIH (€, DH, SR, ...)
    
    Returns:
    Produce
  - create
```
public Object create(int transform,
            Boolean isDiscard,
            Float subgroupCount,
            Short individualCount,
            String taxonGroupOtherInformation,
            Date controlDate,
            Date validationDate,
            Date qualificationDate,
            String qualificationComments,
            Float weight,
            Float cost)
```
    Does the same thing as ProduceDao.create(Boolean, Float, Short, String, Date, Date, Date, String, Float, Float) 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 ProduceDao
    
    isDiscard - Le produit est-il un rejet ou non ?
    subgroupCount - Nombre de sous ensembles ayant servit à la quantification. Par exemple il pourra s'agir d'un nombre de caisse servant à quantifié le produit. Par exemple, pour une détermination de la quantification par les volumes : - nombre_sous_ensembles_quantifiés = 3 - poids moyen par sous-ensemble = 5 kg => Poids total du lot = 3 x 5 = 15kg
    individualCount - Nombre d'individus (optionnel). Utile pour les très gros individu. Ex : 1 espadon de 150kg
    taxonGroupOtherInformation - Autre information sur l'espèce du produit. Utilisé dans SACROIS/RIC2, pour stocker des informations complémentaires issues du référentiel espèce du Réseau Inter Criée (RIC).
    weight - Poids total du lot/produit (en kg). Il peut s'agir d'une poids vif ou d'un poids brut, suivant si la la présence ou l'absence de l’état et de la présentation.
    cost - Prix total, exprimé dans l'unité utilisée par du système SIH (€, DH, SR, ...)
    
    Returns:
    Produce
  - create
```
public Produce create(Boolean isDiscard,
             Collection<ProduceQuantificationMeasurement> produceQuantificationMeasurements,
             QualityFlag qualityFlag,
             TaxonGroup taxonGroup)
```
    Creates a new Produce instance from only required properties (attributes and association ends) and adds it to the persistent store.
    
    Specified by:
    
    create in interface ProduceDao
    
    Returns:
    Produce
  - create
```
public Object create(int transform,
            Boolean isDiscard,
            Collection<ProduceQuantificationMeasurement> produceQuantificationMeasurements,
            QualityFlag qualityFlag,
            TaxonGroup taxonGroup)
```
    Does the same thing as #create(Boolean) 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 ProduceDao
    
    Parameters:
    transform - flag to determine transformation type.
    
    Returns:
    Object
  - update
```
public void update(Produce produce)
```
    Updates the produce instance in the persistent store.
    
    Specified by:
    
    update in interface ProduceDao
  - update
```
public void update(Collection<Produce> entities)
```
    Updates all instances in the entities collection in the persistent store.
    
    Specified by:
    
    update in interface ProduceDao
  - remove
```
public void remove(Produce produce)
```
    Removes the instance of Produce from the persistent store.
    
    Specified by:
    
    remove in interface ProduceDao
  - remove
```
public void remove(Integer id)
```
    Removes the instance of Produce having the given identifier from the persistent store.
    
    Specified by:
    
    remove in interface ProduceDao
  - remove
```
public void remove(Collection<Produce> entities)
```
    Removes all entities in the given entities collection.
    
    Specified by:
    
    remove in interface ProduceDao
  - transformEntity
```
public Object transformEntity(int transform,
                     Produce 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 ProduceDao, please note that the ProduceDao.TRANSFORM_NONE constant denotes no transformation, so the entity itself will be returned. If the integer argument value is unknown ProduceDao.TRANSFORM_NONE is assumed.
    
    Specified by:
    
    transformEntity in interface ProduceDao
    
    Parameters:
    transform - one of the constants declared in ProduceDao
    entity - an entity that was found
    
    Returns:
    the transformed entity (i.e. new value object, etc)
    See Also:
    ProduceDao.transformEntity(int, Produce)
  - transformEntities
```
public void transformEntities(int transform,
                     Collection<?> entities)
```
    Transforms a collection of entities using the ProduceDao.transformEntity(int,Produce) method. This method does not instantiate a new collection.
    This method is to be used internally only.
    
    Specified by:
    
    transformEntities in interface ProduceDao
    
    Parameters:
    transform - one of the constants declared in fr.ifremer.adagio.core.dao.data.produce.ProduceDao
    entities - the collection of entities to transform
    See Also:
    ProduceDao.transformEntity(int,Produce)
  - toEntities
```
public void toEntities(Collection<?> results)
```
    Description copied from interface: ProduceDao
    
    Transforms the given results to a collection of Produce instances (this is useful when the returned results contains a row of data and you want just entities only).
    
    Specified by:
    
    toEntities in interface ProduceDao
    
    Parameters:
    results - the query results.
    See Also:
    ProduceDao.toEntities(Collection)
  - toEntity
```
protected Produce toEntity(Object[] row)
```
    Parameters:
    row -
    
    Returns:
    Produce
  - 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 ProduceDao.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 ProduceDao
    
    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 ProduceDao.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 ProduceDao
    
    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 ProduceDao.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 ProduceDao
    
    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<Produce> search(Search search)
```
    Performs a search using the parameters specified in the given search object.
    
    Specified by:
    
    search in interface ProduceDao
    
    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 ProduceDaoBase

Field Summary

Fields inherited from class HibernateDaoSupport

Fields inherited from interface ProduceDao

Constructor Summary

Method Summary

Methods inherited from class HibernateDaoSupport

Methods inherited from class Object

Constructor Detail

ProduceDaoBase

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