fr.ifremer.adagio.core.dao.data.batch

Interface CatchBatchExtendDao

All Superinterfaces:

CatchBatchDao

All Known Implementing Classes:

CatchBatchDaoImpl

public interface CatchBatchExtendDao
extends CatchBatchDao

Field Summary

Fields

Modifier and Type	Field and Description
static String	PMFM_ID Property name used to walk in a sorting batch identified by a pmfm.
static String	REFERENCE_TAXON_ID Property name used to walk in a sorting batch identified by a reference taxon.

Fields inherited from interface CatchBatchDao

TRANSFORM_NONE

Method Summary

Methods

Modifier and Type	Method and Description
SortingBatch	createSortingBatch(SortingBatch sortingBatch, CatchBatch parentCatchBatch) Create a new batch
List<Integer>	getAllChildrenIds(Integer batchId) Walk throw the batch given by the id and grab ids of all his shell.
Integer	getIdByFishingOperationId(Integer fishingOperationId) Retrieve a catch batch Id, from a fishing operation id
Integer	getIdBySortingBatchId(Integer sortingBatchId) Retrieve a catch batch Id, from a sorting batch id
SortingMeasurement	getInheritedSortingMeasurement(SortingBatch sortingBatch, Integer pmfmId)
QuantificationMeasurement	getQuantificationMeasurement(Batch batch, Integer pmfmId, Integer recorderDepartmentId, boolean createIfNotExists)
SortingBatch	getSortingBatch(Collection<Batch> batchs, Object... params) retrieve a sorting batch, from path give in params. i.e: getSortingBatch(sortingBatchCollection, PMFM_ID, PmfmId.SEX, QualitativeValueId.FEMALE)
SortingBatch	getSortingBatchById(CatchBatch catchBatch, Integer sortingBatchId) Retrieve a child (in all tree depth) of the given catch batch, using an sorting batch id.
SortingMeasurement	getSortingMeasurement(SortingBatch sortingBatch, Integer pmfmId, Integer recorderDepartmentId, boolean createIfNotExists)
boolean	isCatchBatchExistsForFishingOperation(Integer fishingOperationId)
CatchBatch	loadFullTree(Integer catchBatchId) Load a catch batch and all its childrens.
CatchBatch	loadFullTree(Integer catchBatchId, boolean validate, boolean quickFix) Load a catch batch and all its childrens.
CatchBatch	loadFullTreeWithCache(Integer catchBatchId, boolean useCache, boolean forceReload) Method typically using by other loadFullTree() methods.
SortingBatch	loadSortingBatch(Integer sortingBatchId, CatchBatch parentCatchBatch) Load a batch.
void	registerCatchBatchValidator(CatchBatchValidator validator)
void	remove(Integer catchBatchId) Remove a batch and evict all the cache
void	removeWithChildren(Integer batchId) Remove a batch, with all children (could be CatchBatch or a SortingBatch) -> Method NOT optimize for cache using in loadFullTree : will evict all the cache
void	removeWithChildren(Integer batchId, CatchBatch parentCatchBatch) Remove a batch, with all children (could be CatchBatch or a SortingBatch) -> Method optimize for cache using in loadFullTree()
QuantificationMeasurement	setQuantificationMeasurement(Batch batch, Integer pmfmId, Integer recorderDepartmentId, Float weightValue, boolean isReferenceQuantitification)
void	setSortingBatchReferenceTaxon(String batchId, Integer referenceTaxonId) Change the species of a batch. -> Method NOT optimize for cache using in loadFullTree : will evict all the cache
void	unregisterCatchBatchValidator(CatchBatchValidator validator)
void	update(CatchBatch catchBatch) Updates the catchBatch instance in the persistent store.
void	updateSortingBatch(List<SortingBatch> sortingBatchs, CatchBatch parentCatchBatch)
void	updateSortingBatch(SortingBatch sortingBatch, CatchBatch parentCatchBatch)
List<CatchBatchValidationError>	validate(CatchBatch catchBatch) Validate a catch batch, using all registered validators that are enable for this catchBatch

Methods inherited from interface CatchBatchDao

create, create, create, create, create, create, create, create, get, get, load, load, loadAll, loadAll, loadAll, loadAll, remove, remove, search, search, search, search, toEntities, transformEntities, transformEntity, update

Field Detail

PMFM_ID

static final String PMFM_ID

Property name used to walk in a sorting batch identified by a pmfm.

Since:

3.3.6

See Also:

getSortingBatch(Collection, Object...), Constant Field Values

REFERENCE_TAXON_ID

static final String REFERENCE_TAXON_ID

Property name used to walk in a sorting batch identified by a reference taxon.

Since:

3.3.6

See Also:

getSortingBatch(Collection, Object...), Constant Field Values

Method Detail

registerCatchBatchValidator

void registerCatchBatchValidator(CatchBatchValidator validator)

unregisterCatchBatchValidator

void unregisterCatchBatchValidator(CatchBatchValidator validator)

loadFullTree

CatchBatch loadFullTree(Integer catchBatchId)

Load a catch batch and all its childrens. (No validation)

Parameters:

catchBatchId - id of the catch batch to load

Returns:

the catch batch with all children, or null if not found

loadFullTree

CatchBatch loadFullTree(Integer catchBatchId,
                      boolean validate,
                      boolean quickFix)
                        throws CatchBatchValidationException

Load a catch batch and all its childrens.

Parameters:

catchBatchId - id of the catch batch to load

validate - if true, method validate() is typically called

quickFix - if true, will try to quick fix validation error

Returns:

the catch batch with all children

Throws:

CatchBatchValidationException - only if valaidate = true, and error found (with gravity ERROR or FATAL)

loadFullTreeWithCache

@Cacheable(value="fr.ifremer.adagio.core.dao.data.batch.CatchBatchCache",
           key="#catchBatchId",
           condition="#useCache == true")
@CacheEvict(value="fr.ifremer.adagio.core.dao.data.batch.CatchBatchCache",
            beforeInvocation=true,
            key="#catchBatchId",
            condition="#useCache==true and #forceReload==true")
CatchBatch loadFullTreeWithCache(Integer catchBatchId,
                                                    boolean useCache,
                                                    boolean forceReload)

Method typically using by other loadFullTree() methods. Please do not call directly, but throw other methods.

Parameters:

catchBatchId - id of the catch batch to load

useCache - must the be enable ?

forceReload - is cache is enable, force a eviction to refresh the cache

Returns:

A full batch tree

validate

List<CatchBatchValidationError> validate(CatchBatch catchBatch)

Validate a catch batch, using all registered validators that are enable for this catchBatch

Parameters:

catchBatch - batch to validate

Returns:

null if validation has no errors, or a list of errors found.

getSortingBatch

SortingBatch getSortingBatch(Collection<Batch> batchs,
                           Object... params)

retrieve a sorting batch, from path give in params. i.e:
getSortingBatch(sortingBatchCollection,
PMFM_ID, PmfmId.SEX, QualitativeValueId.FEMALE)

Parameters:

batchs - incoming batchs to filter

params -

Returns:

getSortingBatchById

SortingBatch getSortingBatchById(CatchBatch catchBatch,
                               Integer sortingBatchId)

Retrieve a child (in all tree depth) of the given catch batch, using an sorting batch id.

Parameters:

catchBatch -

sortingBatchId - id of the sorting batch to retrieve

Returns:

the sorting batch found

Throws:

DataRetrievalFailureException - if the sorting batch could not be found

isCatchBatchExistsForFishingOperation

boolean isCatchBatchExistsForFishingOperation(Integer fishingOperationId)

Parameters:

fishingOperationId - id of the fishing operation

Returns:

true if there is a catchBatch for the given fishing operation, false otherwise.

Since:

3.3.6

getIdByFishingOperationId

Integer getIdByFishingOperationId(Integer fishingOperationId)
                                  throws DataRetrievalFailureException

Retrieve a catch batch Id, from a fishing operation id

Parameters:

fishingOperationId - id of the fishing operation

Returns:

the fid of the catch batch associated with the fishing operation

Throws:

DataRetrievalFailureException - if catch batch id not found

getIdBySortingBatchId

Integer getIdBySortingBatchId(Integer sortingBatchId)
                              throws DataRetrievalFailureException

Retrieve a catch batch Id, from a sorting batch id

Parameters:

sortingBatchId -

Returns:

Throws:

DataRetrievalFailureException - if catch batch id not found

removeWithChildren

@CacheEvict(value="fr.ifremer.adagio.core.dao.data.batch.CatchBatchCache",
            key="#parentCatchBatch.id")
void removeWithChildren(Integer batchId,
                                 CatchBatch parentCatchBatch)

Remove a batch, with all children (could be CatchBatch or a SortingBatch) -> Method optimize for cache using in loadFullTree()

Parameters:

batchId - id of the batch to remove

removeWithChildren

@CacheEvict(value="fr.ifremer.adagio.core.dao.data.batch.CatchBatchCache",
            allEntries=true)
void removeWithChildren(Integer batchId)

Remove a batch, with all children (could be CatchBatch or a SortingBatch) -> Method NOT optimize for cache using in loadFullTree : will evict all the cache

Parameters:

batchId - id of the batch to remove

remove

@CacheEvict(value="fr.ifremer.adagio.core.dao.data.batch.CatchBatchCache",
            allEntries=true)
void remove(Integer catchBatchId)

Remove a batch and evict all the cache

Specified by:

remove in interface CatchBatchDao

Parameters:

catchBatchId - id of the catch batch to remove

getAllChildrenIds

List<Integer> getAllChildrenIds(Integer batchId)

Walk throw the batch given by the id and grab ids of all his shell. Note: Will use a postorder traversal (child before parent) to keep ids.

Parameters:

batchId - id of the batch to scan

Returns:

list of all children ids in postorder traversal order

Since:

3.3.6

getSortingMeasurement

SortingMeasurement getSortingMeasurement(SortingBatch sortingBatch,
                                       Integer pmfmId,
                                       Integer recorderDepartmentId,
                                       boolean createIfNotExists)

getQuantificationMeasurement

QuantificationMeasurement getQuantificationMeasurement(Batch batch,
                                                     Integer pmfmId,
                                                     Integer recorderDepartmentId,
                                                     boolean createIfNotExists)

setQuantificationMeasurement

QuantificationMeasurement setQuantificationMeasurement(Batch batch,
                                                     Integer pmfmId,
                                                     Integer recorderDepartmentId,
                                                     Float weightValue,
                                                     boolean isReferenceQuantitification)

getInheritedSortingMeasurement

SortingMeasurement getInheritedSortingMeasurement(SortingBatch sortingBatch,
                                                Integer pmfmId)

setSortingBatchReferenceTaxon

@CacheEvict(value="fr.ifremer.adagio.core.dao.data.batch.CatchBatchCache",
            allEntries=true)
void setSortingBatchReferenceTaxon(String batchId,
                                            Integer referenceTaxonId)

Change the species of a batch. -> Method NOT optimize for cache using in loadFullTree : will evict all the cache

Parameters:

batchId -

referenceTaxonId -

update

@CacheEvict(value="fr.ifremer.adagio.core.dao.data.batch.CatchBatchCache",
            key="#catchBatch.id")
void update(CatchBatch catchBatch)

Description copied from interface: CatchBatchDao

Updates the catchBatch instance in the persistent store.

Specified by:

update in interface CatchBatchDao

createSortingBatch

@CacheEvict(value="fr.ifremer.adagio.core.dao.data.batch.CatchBatchCache",
            key="#parentCatchBatch.id")
SortingBatch createSortingBatch(SortingBatch sortingBatch,
                                         CatchBatch parentCatchBatch)

Create a new batch

Parameters:

sortingBatch -

parentCatchBatch -

loadSortingBatch

SortingBatch loadSortingBatch(Integer sortingBatchId,
                            CatchBatch parentCatchBatch)

Load a batch. If the given catchBatch has been load using loadFullTree, this method will use cache stored inside the catchBatch

Parameters:

sortingBatchId -

parentCatchBatch -

Returns:

updateSortingBatch

@CacheEvict(value="fr.ifremer.adagio.core.dao.data.batch.CatchBatchCache",
            key="#parentCatchBatch.id")
void updateSortingBatch(SortingBatch sortingBatch,
                                 CatchBatch parentCatchBatch)

updateSortingBatch

@CacheEvict(value="fr.ifremer.adagio.core.dao.data.batch.CatchBatchCache",
            key="#parentCatchBatch.id")
void updateSortingBatch(List<SortingBatch> sortingBatchs,
                                 CatchBatch parentCatchBatch)