fr.gouv.vitam.metadata.api

Interface MetaData

All Known Implementing Classes:

MetaDataImpl

public interface MetaData

MetaData interface for database operations

Method Summary

Modifier and Type	Method and Description
void	flushObjectGroup() Flush ObjectGroup Index
void	flushUnit() Flush Unit Index
void	insertObjectGroup(com.fasterxml.jackson.databind.JsonNode objectRequest) Insert an objectGroup
void	insertUnit(com.fasterxml.jackson.databind.JsonNode insertRequest) insert Unit
IndexationResult	reindex(IndexParameters indexParam) Reindex one or more collections
List<org.bson.Document>	selectAccessionRegisterOnObjectGroupByOperationId(String operationId) Select an Accession Register linked to an Operation
List<org.bson.Document>	selectAccessionRegisterOnUnitByOperationId(String operationId) find the number of archive unit per originating agency for a operationId
RequestResponse<com.fasterxml.jackson.databind.JsonNode>	selectObjectGroupById(com.fasterxml.jackson.databind.JsonNode selectQuery, String objectGroupId) Search ObjectGroups by its Id and a Select Query for this method, the roots will be filled for example request :{
RequestResponse<com.fasterxml.jackson.databind.JsonNode>	selectObjectGroupsByQuery(com.fasterxml.jackson.databind.JsonNode selectQuery) Search ObjectGroups by Select SelectQuery
RequestResponse<com.fasterxml.jackson.databind.JsonNode>	selectUnitsById(com.fasterxml.jackson.databind.JsonNode selectQuery, String unitId) Search UNITs by Id SelectQuery for this method, the roots will be filled for example request :{
RequestResponse<com.fasterxml.jackson.databind.JsonNode>	selectUnitsByQuery(com.fasterxml.jackson.databind.JsonNode selectQuery) Search UNITs by Select SelectQuery
void	switchIndex(String alias, String newIndexName) Switch indexes for one or more collections
void	updateObjectGroupId(com.fasterxml.jackson.databind.JsonNode updateRequest, String objectId) Update an object group
RequestResponse<com.fasterxml.jackson.databind.JsonNode>	updateUnitbyId(com.fasterxml.jackson.databind.JsonNode updateQuery, String unitId) Update UNITs by Id UpdateMultiQueryQuery for this method, the roots will be filled for example request :{

Method Detail

insertUnit

void insertUnit(com.fasterxml.jackson.databind.JsonNode insertRequest)
         throws InvalidParseOperationException,
                IllegalArgumentException,
                MetaDataNotFoundException,
                MetaDataAlreadyExistException,
                MetaDataExecutionException,
                MetaDataDocumentSizeException,
                VitamDBException

insert Unit

Parameters:

insertRequest - as String { $roots: roots, $query : query, $filter : multi, $data : data}

Throws:

InvalidParseOperationException - Throw if json format is not correct

IllegalArgumentException - Throw if arguments of insert query is invalid

MetaDataNotFoundException - Throw if parent of this unit is not found

MetaDataAlreadyExistException - Throw if Unit id already exists

MetaDataExecutionException - Throw if error occurs when send Unit to database

MetaDataDocumentSizeException - Throw if Unit size is too big

VitamDBException - in case a desynchro is recorded between Mongo and ES

selectAccessionRegisterOnObjectGroupByOperationId

List<org.bson.Document> selectAccessionRegisterOnObjectGroupByOperationId(String operationId)

Select an Accession Register linked to an Operation

Parameters:

operationId - the operation identifier

Returns:

the list of documents

selectUnitsByQuery

RequestResponse<com.fasterxml.jackson.databind.JsonNode> selectUnitsByQuery(com.fasterxml.jackson.databind.JsonNode selectQuery)
                                                                     throws InvalidParseOperationException,
                                                                            MetaDataExecutionException,
                                                                            MetaDataDocumentSizeException,
                                                                            MetaDataNotFoundException,
                                                                            BadRequestException,
                                                                            VitamDBException

Search UNITs by Select SelectQuery

Parameters:

selectQuery - the query of type JsonNode

Returns:

JsonNode {$hits{},$context{},$result:[{}....{}],}
$context will be added later (Access)
$result array of units(can be empty)

Throws:

InvalidParseOperationException - Thrown when json format is not correct

MetaDataExecutionException - Throw if error occurs when send Unit to database

MetaDataDocumentSizeException - Throw if Unit size is too big

MetaDataNotFoundException - Throw if unit by id not found

BadRequestException - if a bad request is being used

VitamDBException - in case a desynchro is recorded between Mongo and ES

selectObjectGroupsByQuery

RequestResponse<com.fasterxml.jackson.databind.JsonNode> selectObjectGroupsByQuery(com.fasterxml.jackson.databind.JsonNode selectQuery)
                                                                            throws MetaDataExecutionException,
                                                                                   InvalidParseOperationException,
                                                                                   MetaDataDocumentSizeException,
                                                                                   MetaDataNotFoundException,
                                                                                   BadRequestException,
                                                                                   VitamDBException

Search ObjectGroups by Select SelectQuery

Parameters:

selectQuery - the query of type JsonNode

Returns:

JsonNode {$hits{},$context{},$result:[{}....{}],}
$context will be added later (Access)
$result array of units(can be empty)

Throws:

InvalidParseOperationException - Thrown when json format is not correct

MetaDataExecutionException - Throw if error occurs when send Unit to database

MetaDataDocumentSizeException - Throw if Unit size is too big

MetaDataNotFoundException - Throw if unit by id not found

BadRequestException - if a bad request is being used

VitamDBException - in case a desynchro is recorded between Mongo and ES

selectUnitsById

RequestResponse<com.fasterxml.jackson.databind.JsonNode> selectUnitsById(com.fasterxml.jackson.databind.JsonNode selectQuery,
                                                                         String unitId)
                                                                  throws InvalidParseOperationException,
                                                                         MetaDataExecutionException,
                                                                         MetaDataDocumentSizeException,
                                                                         MetaDataNotFoundException,
                                                                         BadRequestException,
                                                                         VitamDBException

Search UNITs by Id SelectQuery
for this method, the roots will be filled
for example request :{

$roots:[{id:"id"}]

,
$query{}, ..}

Parameters:

selectQuery - the select query of type JsonNode

unitId - the unit id for query

Returns:

JsonNode {$hits{},$context{},$result:[{}....{}],}
$context will be added later (Access)
$result array of units(can be empty)

Throws:

InvalidParseOperationException - Thrown when json format is not correct

MetaDataExecutionException - Throw if error occurs when send Unit to database

MetaDataDocumentSizeException - Throw if Unit size is too big

MetaDataNotFoundException - Throw if unit by id not found

BadRequestException - if a bad request is being used

VitamDBException - in case a desynchro is recorded between Mongo and ES

selectObjectGroupById

RequestResponse<com.fasterxml.jackson.databind.JsonNode> selectObjectGroupById(com.fasterxml.jackson.databind.JsonNode selectQuery,
                                                                               String objectGroupId)
                                                                        throws InvalidParseOperationException,
                                                                               MetaDataDocumentSizeException,
                                                                               MetaDataExecutionException,
                                                                               MetaDataNotFoundException,
                                                                               BadRequestException,
                                                                               VitamDBException

Search ObjectGroups by its Id and a Select Query
for this method, the roots will be filled
for example request :{

$roots:[{id:"id"}]

,
$query{}, ..}

Parameters:

selectQuery - the query to filter results and make projections

objectGroupId - the objectgroup id

Returns:

JsonNode {$hits{},$context{},$result:[{}....{}],}
$context will be added later (Access)
$result array of objectgroups(can be empty)

Throws:

InvalidParseOperationException - Thrown when json format is not correct

MetaDataExecutionException - Throw if error occurs when send Unit to database

MetaDataDocumentSizeException - Throw if Unit size is too big

MetaDataNotFoundException - Thrown if no objectGroup is found

BadRequestException - if a bad request is being used

VitamDBException - in case a desynchro is recorded between Mongo and ES

updateUnitbyId

RequestResponse<com.fasterxml.jackson.databind.JsonNode> updateUnitbyId(com.fasterxml.jackson.databind.JsonNode updateQuery,
                                                                        String unitId)
                                                                 throws MetaDataNotFoundException,
                                                                        InvalidParseOperationException,
                                                                        MetaDataExecutionException,
                                                                        MetaDataDocumentSizeException,
                                                                        VitamDBException

Update UNITs by Id UpdateMultiQueryQuery
for this method, the roots will be filled
for example request :{

$roots:[{id:"id"}]

,
$query{}, ..}

Parameters:

updateQuery - the update query as JsonNode

unitId - the id of Unit for query

Returns:

JsonNode {$hits{},$context{},$result:[{}....{}],}
$context will be added later (Access)
$result array of units(can be empty)

Throws:

InvalidParseOperationException - Thrown when json format is not correct

MetaDataExecutionException - Throw if error occurs when send Unit to database

MetaDataDocumentSizeException - Throw if Unit size is too big

MetaDataNotFoundException - Throw if unit does not exist

VitamDBException - in case a desynchro is recorded between Mongo and ES

insertObjectGroup

void insertObjectGroup(com.fasterxml.jackson.databind.JsonNode objectRequest)
                throws InvalidParseOperationException,
                       MetaDataNotFoundException,
                       MetaDataAlreadyExistException,
                       MetaDataExecutionException,
                       MetaDataDocumentSizeException

Insert an objectGroup

Parameters:

objectRequest - as JsonNode { $roots: roots, $query : query, $filter : multi, $data : data}

Throws:

InvalidParseOperationException - Throw if json format is not correct

MetaDataNotFoundException - Throw if parent of this unit is not found

MetaDataAlreadyExistException - Throw if Unit id already exists

MetaDataExecutionException - Throw if error occurs when send Unit to database

MetaDataDocumentSizeException - Throw if Unit size is too big

selectAccessionRegisterOnUnitByOperationId

List<org.bson.Document> selectAccessionRegisterOnUnitByOperationId(String operationId)

find the number of archive unit per originating agency for a operationId

Parameters:

operationId - operation id

Returns:

the list of documents

updateObjectGroupId

void updateObjectGroupId(com.fasterxml.jackson.databind.JsonNode updateRequest,
                         String objectId)
                  throws InvalidParseOperationException,
                         MetaDataExecutionException,
                         VitamDBException

Update an object group

Parameters:

updateRequest - the request as a json

objectId - the id of the object to be updated

Throws:

InvalidParseOperationException - Thrown when json format is not correct

MetaDataExecutionException - Thrown if error occurs when send Unit to database

VitamDBException - in case a desynchro is recorded between Mongo and ES

flushUnit

void flushUnit()
        throws IllegalArgumentException,
               VitamThreadAccessException

Flush Unit Index

Throws:

IllegalArgumentException - if tenant is wrong

VitamThreadAccessException - if tenant is wrong

flushObjectGroup

void flushObjectGroup()
               throws IllegalArgumentException,
                      VitamThreadAccessException

Flush ObjectGroup Index

Throws:

IllegalArgumentException - if tenant is wrong

VitamThreadAccessException - if tenant is wrong

reindex

IndexationResult reindex(IndexParameters indexParam)

Reindex one or more collections

Parameters:

indexParam - the parameters specifying what to reindex

Returns:

the reindexation result as a IndexationResult Object

switchIndex

void switchIndex(String alias,
                 String newIndexName)
          throws DatabaseException

Switch indexes for one or more collections

Parameters:

alias - the alias name

newIndexName - the new index to be pointed on

Throws:

DatabaseException - in case error with database occurs