fr.gouv.vitam.metadata.core

Class MetaDataImpl

java.lang.Object

fr.gouv.vitam.metadata.core.MetaDataImpl

All Implemented Interfaces:

MetaData

public class MetaDataImpl
extends Object
implements MetaData

MetaDataImpl implements a MetaData interface

Field Summary

Fields

Modifier and Type	Field and Description
static String	COUNT
static String	ORIGINATING_AGENCY
static String	QUALIFIER_VERSION_OPI
static String	SP
static String	TOTAL_GOT
static String	TOTAL_OBJECT
static String	TOTAL_SIZE

Constructor Summary

Constructors

Constructor and Description
MetaDataImpl(MongoDbAccessMetadataImpl mongoDbAccess)

Method Summary

Modifier and Type	Method and Description
List<org.bson.Document>	createAccessionRegisterSymbolic(Integer tenant) Creates the AccessionRegisterSymbolics from ElasticSearch aggregations and nested aggregation request.
void	deleteObjectGroups(List<String> idList) delete objectsGroups
void	deleteUnits(List<String> idList) delete units
MongoDbAccessMetadataImpl	getMongoDbAccess()
void	insertObjectGroup(com.fasterxml.jackson.databind.JsonNode objectGroupRequest) Insert an objectGroup
void	insertObjectGroups(List<com.fasterxml.jackson.databind.JsonNode> objectGroupRequest)
void	insertUnit(com.fasterxml.jackson.databind.JsonNode insertRequest) insert Unit
void	insertUnits(List<com.fasterxml.jackson.databind.JsonNode> insertRequests)
static MetaData	newMetadata(MongoDbAccessMetadataImpl mongoDbAccessMetadata) Get a new MetaDataImpl instance
void	refreshObjectGroup() Flush ObjectGroup Index
void	refreshUnit() Flush Unit Index
IndexationResult	reindex(IndexParameters indexParam) Reindex one or more collections
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
List<ObjectGroupPerOriginatingAgency>	selectOwnAccessionRegisterOnObjectGroupByOperationId(String operationId) Select an Accession Register linked to an Operation
List<FacetBucket>	selectOwnAccessionRegisterOnUnitByOperationId(String operationId) find the number of archive unit per originating agency for a operationId
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 updateQuery, 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 :{
RequestResponse<com.fasterxml.jackson.databind.JsonNode>	updateUnits(com.fasterxml.jackson.databind.JsonNode updateQuery) Update UNITs by Ids UpdateMultiQueryQuery for this method, the roots will be filled for example request :{
RequestResponse<com.fasterxml.jackson.databind.JsonNode>	updateUnitsRules(com.fasterxml.jackson.databind.JsonNode updateQuery, Map<String,DurationData> bindRuleToDuration) Update UNITs Rules by Ids UpdateMultiQueryQuery for this method, the roots will be filled for example request : { "dslRequest": {"$roots":[{id:"id1"},{id:"id2"}],"$query":[]}, "ruleActions": {"add":[{"AppraisalRule":{"Rules":[{"Rule":"APP-00001","StartDate":"1982-09-01"}],"FinalAction":"Keep"}} ] } }

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ORIGINATING_AGENCY

public static final String ORIGINATING_AGENCY

See Also:

Constant Field Values

QUALIFIER_VERSION_OPI

public static final String QUALIFIER_VERSION_OPI

See Also:

Constant Field Values

TOTAL_SIZE

public static final String TOTAL_SIZE

See Also:

Constant Field Values

TOTAL_OBJECT

public static final String TOTAL_OBJECT

See Also:

Constant Field Values

TOTAL_GOT

public static final String TOTAL_GOT

See Also:

Constant Field Values

COUNT

public static final String COUNT

See Also:

Constant Field Values

SP

public static final String SP

See Also:

Constant Field Values

Constructor Detail

MetaDataImpl

public MetaDataImpl(MongoDbAccessMetadataImpl mongoDbAccess)

Parameters:

mongoDbAccess -

Method Detail

getMongoDbAccess

public MongoDbAccessMetadataImpl getMongoDbAccess()

Returns:

the MongoDbAccessMetadataImpl

newMetadata

public static MetaData newMetadata(MongoDbAccessMetadataImpl mongoDbAccessMetadata)

Get a new MetaDataImpl instance

Parameters:

mongoDbAccessMetadata -

Returns:

a new instance of MetaDataImpl

insertUnit

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

Description copied from interface: MetaData

insert Unit

Specified by:

insertUnit in interface MetaData

Parameters:

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

Throws:

InvalidParseOperationException - Throw if json format is not correct

MetaDataExecutionException - Throw if error occurs when send Unit to database

MetaDataAlreadyExistException - Throw if Unit id already exists

MetaDataNotFoundException - Throw if parent of this unit is not found

insertUnits

public void insertUnits(List<com.fasterxml.jackson.databind.JsonNode> insertRequests)
                 throws InvalidParseOperationException,
                        MetaDataExecutionException,
                        MetaDataAlreadyExistException,
                        MetaDataNotFoundException

Specified by:

insertUnits in interface MetaData

Throws:

InvalidParseOperationException

MetaDataExecutionException

MetaDataAlreadyExistException

MetaDataNotFoundException

deleteUnits

public void deleteUnits(List<String> idList)
                 throws IllegalArgumentException,
                        MetaDataExecutionException

Description copied from interface: MetaData

delete units

Specified by:

deleteUnits in interface MetaData

Parameters:

idList - idsList

Throws:

IllegalArgumentException

MetaDataExecutionException

deleteObjectGroups

public void deleteObjectGroups(List<String> idList)
                        throws IllegalArgumentException,
                               MetaDataExecutionException

Description copied from interface: MetaData

delete objectsGroups

Specified by:

deleteObjectGroups in interface MetaData

Parameters:

idList - idsList

Throws:

IllegalArgumentException

MetaDataExecutionException

insertObjectGroup

public void insertObjectGroup(com.fasterxml.jackson.databind.JsonNode objectGroupRequest)
                       throws InvalidParseOperationException,
                              MetaDataExecutionException,
                              MetaDataAlreadyExistException

Description copied from interface: MetaData

Insert an objectGroup

Specified by:

insertObjectGroup in interface MetaData

Parameters:

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

Throws:

InvalidParseOperationException - Throw if json format is not correct

MetaDataExecutionException - Throw if error occurs when send Unit to database

MetaDataAlreadyExistException - Throw if Unit id already exists

insertObjectGroups

public void insertObjectGroups(List<com.fasterxml.jackson.databind.JsonNode> objectGroupRequest)
                        throws InvalidParseOperationException,
                               MetaDataExecutionException,
                               MetaDataAlreadyExistException

Specified by:

insertObjectGroups in interface MetaData

Throws:

InvalidParseOperationException

MetaDataExecutionException

MetaDataAlreadyExistException

selectOwnAccessionRegisterOnUnitByOperationId

public List<FacetBucket> selectOwnAccessionRegisterOnUnitByOperationId(String operationId)
                                                                throws MetaDataExecutionException

Description copied from interface: MetaData

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

Specified by:

selectOwnAccessionRegisterOnUnitByOperationId in interface MetaData

Parameters:

operationId - operation id

Returns:

List of FacetBucket

Throws:

MetaDataExecutionException

createAccessionRegisterSymbolic

public List<org.bson.Document> createAccessionRegisterSymbolic(Integer tenant)

Description copied from interface: MetaData

Creates the AccessionRegisterSymbolics from ElasticSearch aggregations and nested aggregation request. Because the AccessionRegisterSymbolic is not available from this package, it is a list of Document which is returned.

Specified by:

createAccessionRegisterSymbolic in interface MetaData

Parameters:

tenant - on related to the symbolic accession register to create

Returns:

a list of AccessionRegisterSymbolic

selectOwnAccessionRegisterOnObjectGroupByOperationId

public List<ObjectGroupPerOriginatingAgency> selectOwnAccessionRegisterOnObjectGroupByOperationId(String operationId)

Description copied from interface: MetaData

Select an Accession Register linked to an Operation

Specified by:

selectOwnAccessionRegisterOnObjectGroupByOperationId in interface MetaData

Parameters:

operationId - the operation identifier

Returns:

the list of documents

selectUnitsByQuery

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

Description copied from interface: MetaData

Search UNITs by Select SelectQuery

Specified by:

selectUnitsByQuery in interface MetaData

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:

MetaDataExecutionException - Throw if error occurs when send Unit to database

InvalidParseOperationException - Thrown when json format is not correct

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

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

Description copied from interface: MetaData

Search ObjectGroups by Select SelectQuery

Specified by:

selectObjectGroupsByQuery in interface MetaData

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:

MetaDataExecutionException - Throw if error occurs when send Unit to database

InvalidParseOperationException - Thrown when json format is not correct

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

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

Description copied from interface: MetaData

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

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

,
$query{}, ..}

Specified by:

selectUnitsById in interface MetaData

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

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

Description copied from interface: MetaData

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

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

,
$query{}, ..}

Specified by:

selectObjectGroupById in interface MetaData

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

MetaDataDocumentSizeException - Throw if Unit size is too big

MetaDataExecutionException - Throw if error occurs when send Unit to database

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

updateObjectGroupId

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

Description copied from interface: MetaData

Update an object group

Specified by:

updateObjectGroupId in interface MetaData

Parameters:

updateQuery - 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

updateUnits

public RequestResponse<com.fasterxml.jackson.databind.JsonNode> updateUnits(com.fasterxml.jackson.databind.JsonNode updateQuery)
                                                                     throws InvalidParseOperationException

Description copied from interface: MetaData

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

$roots:[{id:"id1"}, {id:"id2"}]

,
$query{}, ..}

Specified by:

updateUnits in interface MetaData

Parameters:

updateQuery - the update query as JsonNode containing unitIds in root parts

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

updateUnitsRules

public RequestResponse<com.fasterxml.jackson.databind.JsonNode> updateUnitsRules(com.fasterxml.jackson.databind.JsonNode updateQuery,
                                                                                 Map<String,DurationData> bindRuleToDuration)
                                                                          throws InvalidParseOperationException

Description copied from interface: MetaData

Update UNITs Rules by Ids UpdateMultiQueryQuery
for this method, the roots will be filled
for example request : {
"dslRequest": {"$roots":[{id:"id1"},{id:"id2"}],"$query":[]},
"ruleActions": {"add":[{"AppraisalRule":{"Rules":[{"Rule":"APP-00001","StartDate":"1982-09-01"}],"FinalAction":"Keep"}} ] }
}

Specified by:

updateUnitsRules in interface MetaData

Parameters:

updateQuery - the update query as JsonNode containing unitIds in root parts and updates in ruleActions part

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

updateUnitbyId

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

Description copied from interface: MetaData

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

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

,
$query{}, ..}

Specified by:

updateUnitbyId in interface MetaData

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:

MetaDataNotFoundException - Throw if unit does not exist

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

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

refreshUnit

public void refreshUnit()
                 throws IllegalArgumentException,
                        VitamThreadAccessException

Description copied from interface: MetaData

Flush Unit Index

Specified by:

refreshUnit in interface MetaData

Throws:

IllegalArgumentException - if tenant is wrong

VitamThreadAccessException - if tenant is wrong

refreshObjectGroup

public void refreshObjectGroup()
                        throws IllegalArgumentException,
                               VitamThreadAccessException

Description copied from interface: MetaData

Flush ObjectGroup Index

Specified by:

refreshObjectGroup in interface MetaData

Throws:

IllegalArgumentException - if tenant is wrong

VitamThreadAccessException - if tenant is wrong

reindex

public IndexationResult reindex(IndexParameters indexParam)

Description copied from interface: MetaData

Reindex one or more collections

Specified by:

reindex in interface MetaData

Parameters:

indexParam - the parameters specifying what to reindex

Returns:

the reindexation result as a IndexationResult Object

switchIndex

public void switchIndex(String alias,
                        String newIndexName)
                 throws DatabaseException

Description copied from interface: MetaData

Switch indexes for one or more collections

Specified by:

switchIndex in interface MetaData

Parameters:

alias - the alias name

newIndexName - the new index to be pointed on

Throws:

DatabaseException - in case error with database occurs