fr.gouv.vitam.metadata.core.database.collections

Class MongoDbMetadataHelper

java.lang.Object

fr.gouv.vitam.metadata.core.database.collections.MongoDbMetadataHelper

public class MongoDbMetadataHelper
extends Object

MongoDb Helper for Metadata

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ADD_TO_SET
static com.mongodb.BasicDBObject	ID_PROJECTION Quick projection for ID Only

Method Summary

Modifier and Type	Method and Description
protected static com.mongodb.BasicDBObject	addLink(MetadataDocument obj1, fr.gouv.vitam.metadata.core.database.collections.VitamLinks relation, MetadataDocument obj2) Add a Link according to relation defined, where the relation is defined in obj1->obj2 way by default (even if symmetric)
static Result	createOneResult(BuilderToken.FILTERARGS type)
static Result	createOneResult(BuilderToken.FILTERARGS type, Collection<String> set)
static com.mongodb.client.result.DeleteResult	delete(MetadataCollections collection, org.bson.conversions.Bson condition, int nb)
static boolean	exists(MetadataCollections col, String id) OK with native id for Results
static MetadataDocument	findOne(MetadataCollections col, String id) Find the corresponding id in col collection if it exists.
static MetadataDocument	findOne(MetadataCollections col, String field, String ref) Calls getAfterLoad
static MetadataDocument	findOneNoAfterLoad(MetadataCollections metadataCollections, String ref) Does not call getAfterLoad
static MetadataDocument	loadFromDocument(MetadataCollections coll, org.bson.Document obj) Load a Document into MetadataDocument.
static org.bson.conversions.Bson	queryForAncestorsOrSame(Collection<String> targetIds, Collection<String> ancestorIds) Used to filter Units/OG according to some Units ancestors
static org.bson.conversions.Bson	queryForImmediateAncestors(Collection<String> targetIds, Collection<String> ancestorIds) Used to filter Units/OG according to immediate Unit ancestors
static org.bson.conversions.Bson	queryObjectGroupForAncestors(Collection<String> targetIds, Collection<String> ancestorIds) Used to filter Units according to some OG and some Units ancestors
static com.mongodb.client.FindIterable<?>	select(MetadataCollections collection, org.bson.conversions.Bson condition, org.bson.conversions.Bson projection) Does not call getAfterLoad.
static com.mongodb.client.FindIterable<?>	select(MetadataCollections collection, org.bson.conversions.Bson condition, org.bson.conversions.Bson projection, org.bson.conversions.Bson orderBy, int offset, int limit) Does not call getAfterLoad.
static com.mongodb.client.FindIterable<?>	selectFiltered(com.mongodb.client.FindIterable<?> find, org.bson.conversions.Bson orderBy, int offset, int limit) Aff orderBy and offset and limit if not null or not -1
static com.mongodb.client.result.UpdateResult	update(MetadataCollections collection, org.bson.conversions.Bson condition, org.bson.conversions.Bson data, int nb)
protected static com.mongodb.BasicDBObject	updateLink(MetadataDocument obj1, MetadataDocument vtReloaded, fr.gouv.vitam.metadata.core.database.collections.VitamLinks relation, boolean src) Update the link (1 link type)
protected static com.mongodb.BasicDBObject	updateLinkset(MetadataDocument obj1, MetadataDocument vtReloaded, fr.gouv.vitam.metadata.core.database.collections.VitamLinks relation, boolean src) Update the linkset (N link type)

Methods inherited from class java.lang.Object

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

Field Detail

ID_PROJECTION

public static final com.mongodb.BasicDBObject ID_PROJECTION

Quick projection for ID Only

ADD_TO_SET

protected static final String ADD_TO_SET

See Also:

Constant Field Values

Method Detail

findOneNoAfterLoad

public static final MetadataDocument findOneNoAfterLoad(MetadataCollections metadataCollections,
                                                        String ref)

Does not call getAfterLoad

Parameters:

metadataCollections - (not results except if already hashed)

ref - the reference of MetadataDocument object

Returns:

a MetadataDocument generic object from ID = ref value

loadFromDocument

public static final MetadataDocument loadFromDocument(MetadataCollections coll,
                                                      org.bson.Document obj)
                                               throws InstantiationException,
                                                      IllegalAccessException

Load a Document into MetadataDocument. Calls getAfterLoad

Parameters:

coll - the working collection

obj - the document

Returns:

the MetadataDocument casted object

Throws:

InstantiationException - when collection class instantiation exception occurred

IllegalAccessException - when illegal access exception occurred

findOne

public static final MetadataDocument findOne(MetadataCollections col,
                                             String field,
                                             String ref)

Calls getAfterLoad

Parameters:

col - metadata collection (not Results except if already hashed)

field - of collection

ref - reference of collection field

Returns:

the MetadataDocument casted object using field = ref

findOne

public static final MetadataDocument findOne(MetadataCollections col,
                                             String id)

Find the corresponding id in col collection if it exists. Calls getAfterLoad

Parameters:

col - (not results except if already hashed) the working collection

id - the id value for searching in collection field

Returns:

the MetadataDocument casted object using ID = id

exists

public static final boolean exists(MetadataCollections col,
                                   String id)

OK with native id for Results

Parameters:

col - the working collection

id - the id value for searching in collection field

Returns:

True if one MetadataDocument object exists with this id

select

public static final com.mongodb.client.FindIterable<?> select(MetadataCollections collection,
                                                              org.bson.conversions.Bson condition,
                                                              org.bson.conversions.Bson projection)

Does not call getAfterLoad.

Parameters:

collection - domain of request

condition - where condition

projection - select condition

Returns:

the FindIterable on the find request based on the given collection

select

public static final com.mongodb.client.FindIterable<?> select(MetadataCollections collection,
                                                              org.bson.conversions.Bson condition,
                                                              org.bson.conversions.Bson projection,
                                                              org.bson.conversions.Bson orderBy,
                                                              int offset,
                                                              int limit)

Does not call getAfterLoad.

Parameters:

collection - domain of request

condition - where condition

projection - select condition

orderBy - orderBy condition

offset - offset (0 by default)

limit - limit (0 for no limit)

Returns:

the FindIterable on the find request based on the given collection

selectFiltered

public static final com.mongodb.client.FindIterable<?> selectFiltered(com.mongodb.client.FindIterable<?> find,
                                                                      org.bson.conversions.Bson orderBy,
                                                                      int offset,
                                                                      int limit)

Aff orderBy and offset and limit if not null or not -1

Parameters:

find -

orderBy -

offset -

limit -

Returns:

the modified FindIterable

update

public static final com.mongodb.client.result.UpdateResult update(MetadataCollections collection,
                                                                  org.bson.conversions.Bson condition,
                                                                  org.bson.conversions.Bson data,
                                                                  int nb)
                                                           throws MetaDataExecutionException

Parameters:

collection - domain of request

condition - where condition

data - the update data

nb - number of item to update

Returns:

the UpdateResult on the update request based on the given collection

Throws:

MetaDataExecutionException - if a mongo operation exception occurred

delete

public static final com.mongodb.client.result.DeleteResult delete(MetadataCollections collection,
                                                                  org.bson.conversions.Bson condition,
                                                                  int nb)
                                                           throws MetaDataExecutionException

Parameters:

collection - domain of request

condition - where condition

nb - nb of item to delete

Returns:

the DeleteResult on the update request based on the given collection

Throws:

MetaDataExecutionException - if a mongo operation exception occurred

queryObjectGroupForAncestors

public static final org.bson.conversions.Bson queryObjectGroupForAncestors(Collection<String> targetIds,
                                                                           Collection<String> ancestorIds)

Used to filter Units according to some OG and some Units ancestors

Parameters:

targetIds - set of target ids

ancestorIds - set of ancestor ids

Returns:

the Filter condition to find if ancestorIds are ancestors of ObjectGroup targetIds

queryForImmediateAncestors

public static final org.bson.conversions.Bson queryForImmediateAncestors(Collection<String> targetIds,
                                                                         Collection<String> ancestorIds)

Used to filter Units/OG according to immediate Unit ancestors

Parameters:

targetIds - set of target id

ancestorIds - set of ancestor id

Returns:

the Filter condition to find if ancestorIds are ancestors of targetIds

queryForAncestorsOrSame

public static final org.bson.conversions.Bson queryForAncestorsOrSame(Collection<String> targetIds,
                                                                      Collection<String> ancestorIds)

Used to filter Units/OG according to some Units ancestors

Parameters:

targetIds - set of target ids

ancestorIds - set of ancestor ids

Returns:

the Filter condition to find if ancestorIds are ancestors of targetIds or equals to targetIds

addLink

protected static final com.mongodb.BasicDBObject addLink(MetadataDocument obj1,
                                                         fr.gouv.vitam.metadata.core.database.collections.VitamLinks relation,
                                                         MetadataDocument obj2)

Add a Link according to relation defined, where the relation is defined in obj1->obj2 way by default (even if symmetric)

Parameters:

obj1 -

relation -

obj2 -

Returns:

a BasicDBObject that hold a possible update part (may be null) as { $addToSet : { field : value } } or { field : value }

updateLink

protected static final com.mongodb.BasicDBObject updateLink(MetadataDocument obj1,
                                                            MetadataDocument vtReloaded,
                                                            fr.gouv.vitam.metadata.core.database.collections.VitamLinks relation,
                                                            boolean src)

Update the link (1 link type)

Parameters:

obj1 -

vtReloaded -

relation -

src -

Returns:

the update part as { field : value }

updateLinkset

protected static final com.mongodb.BasicDBObject updateLinkset(MetadataDocument obj1,
                                                               MetadataDocument vtReloaded,
                                                               fr.gouv.vitam.metadata.core.database.collections.VitamLinks relation,
                                                               boolean src)

Update the linkset (N link type)

Parameters:

obj1 - MetadataDocument object

vtReloaded - the MetadataDocument object loaded

relation -

src -

Returns:

the update part as { field : {$each : [value] } }

createOneResult

public static Result createOneResult(BuilderToken.FILTERARGS type)

Parameters:

type - of filter

Returns:

a new Result

createOneResult

public static Result createOneResult(BuilderToken.FILTERARGS type,
                                     Collection<String> set)

Parameters:

type - of filter

set - of collection for creating Result

Returns:

a new Result