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

Class ObjectGroup

java.lang.Object

org.bson.Document

fr.gouv.vitam.common.database.server.mongodb.VitamDocument<E>

fr.gouv.vitam.metadata.core.database.collections.MetadataDocument<ObjectGroup>

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

All Implemented Interfaces:

Serializable, Map<String,Object>, org.bson.conversions.Bson

public class ObjectGroup
extends MetadataDocument<ObjectGroup>

ObjectGroup:

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static String	COPIES Copies
static String	DATAOBJECTVERSION DataObjectVersion
static String	OBJECTCOPIES Copies
static String	OBJECTDIGEST Digest
static String	OBJECTDIGEST_TYPE Digest Type
static String	OBJECTDIGEST_VALUE Digest Value
static String	OBJECTFORMAT Object format
static com.mongodb.BasicDBObject	OBJECTGROUP_VITAM_PROJECTION Unit Id, Vitam fields Only projection (no usage)
static String	OBJECTID Object UUID
static String	OBJECTSIZE Object size
static String	OBJECTSTORAGE Storage Id
static String	OBJECTSTRATEHY Storage Id
static String	OBJECTVERSION Version
static String	OGDEPTHS depths
static String	STORAGE Storage Id
static String	USAGES Usages
static String	VERSIONS Versions
static String	VERSIONS_STORAGE storage to objectGroup

Fields inherited from class fr.gouv.vitam.metadata.core.database.collections.MetadataDocument

ES_PROJECTION, NBCHILD, OG, OPI, OPS, ORIGINATING_AGENCIES, ORIGINATING_AGENCY, QUALIFIERS, TYPE, UNUSED, UP

Fields inherited from class fr.gouv.vitam.common.database.server.mongodb.VitamDocument

ES_FILTER_OUT, ID, SCORE, TENANT_ID, VERSION

Constructor Summary

Constructors

Constructor and Description
ObjectGroup() Empty constructor
ObjectGroup(org.bson.Document content) Constructor from Document
ObjectGroup(com.fasterxml.jackson.databind.JsonNode content) Constructor from Json
ObjectGroup(String content) Constructor from Json as Text

Method Summary

Modifier and Type	Method and Description
protected static void	addIndexes()
void	cleanStructure(boolean all) Used in loop operation to clean the object
protected static void	dropIndexes()
ObjectGroup	getAfterLoad() To be called after any automatic load or loadFromJson to update HashMap values.
protected com.mongodb.client.MongoCollection<ObjectGroup>	getCollection()
List<String>	getFathersUnitIds(boolean remove)
static int	getGUIDObjectTypeId()
protected MetadataCollections	getMetadataCollections()
boolean	isImmediateParent(String unit) Check if the current ObjectGroup has Unit as immediate parent
boolean	load() load the object from the database, ignoring any previous data, except ID
MetadataDocument<ObjectGroup>	newInstance(com.fasterxml.jackson.databind.JsonNode content) Make a new instance of the document with the given json
String	newObjectGuid()
ObjectGroup	putBeforeSave() To be called before any collection.insert() or update if HashMap values is changed.
ObjectGroup	save() Save the object.
protected boolean	updated() try to update the object if necessary (difference from the current value in the database)

Methods inherited from class fr.gouv.vitam.metadata.core.database.collections.MetadataDocument

checkId, delete, getDomainId, getId, insert, load, toStringDebug, toStringDirect, update

Methods inherited from class fr.gouv.vitam.common.database.server.mongodb.VitamDocument

getConcernedDiffLines, getTenantId, getUnifiedDiff, getVersion, toString

Methods inherited from class org.bson.Document

append, clear, containsKey, containsValue, entrySet, equals, get, get, getBoolean, getBoolean, getDate, getDouble, getInteger, getInteger, getLong, getObjectId, getString, hashCode, isEmpty, keySet, parse, parse, put, putAll, remove, size, toBsonDocument, toJson, toJson, toJson, toJson, values

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Field Detail

USAGES

public static final String USAGES

Usages

See Also:

Constant Field Values

STORAGE

public static final String STORAGE

Storage Id

See Also:

Constant Field Values

OBJECTGROUP_VITAM_PROJECTION

public static final com.mongodb.BasicDBObject OBJECTGROUP_VITAM_PROJECTION

Unit Id, Vitam fields Only projection (no usage)

VERSIONS

public static final String VERSIONS

Versions

See Also:

Constant Field Values

DATAOBJECTVERSION

public static final String DATAOBJECTVERSION

DataObjectVersion

See Also:

Constant Field Values

VERSIONS_STORAGE

public static final String VERSIONS_STORAGE

storage to objectGroup

See Also:

Constant Field Values

OBJECTCOPIES

public static final String OBJECTCOPIES

Copies

See Also:

Constant Field Values

OBJECTSTORAGE

public static final String OBJECTSTORAGE

Storage Id

See Also:

Constant Field Values

OBJECTSTRATEHY

public static final String OBJECTSTRATEHY

Storage Id

See Also:

Constant Field Values

OBJECTVERSION

public static final String OBJECTVERSION

Version

See Also:

Constant Field Values

OBJECTID

public static final String OBJECTID

Object UUID

See Also:

Constant Field Values

OBJECTSIZE

public static final String OBJECTSIZE

Object size

See Also:

Constant Field Values

OBJECTFORMAT

public static final String OBJECTFORMAT

Object format

See Also:

Constant Field Values

OBJECTDIGEST

public static final String OBJECTDIGEST

Digest

See Also:

Constant Field Values

OBJECTDIGEST_VALUE

public static final String OBJECTDIGEST_VALUE

Digest Value

See Also:

Constant Field Values

OBJECTDIGEST_TYPE

public static final String OBJECTDIGEST_TYPE

Digest Type

See Also:

Constant Field Values

COPIES

public static final String COPIES

Copies

See Also:

Constant Field Values

OGDEPTHS

public static final String OGDEPTHS

depths

See Also:

Constant Field Values

Constructor Detail

ObjectGroup

public ObjectGroup()

Empty constructor

ObjectGroup

public ObjectGroup(com.fasterxml.jackson.databind.JsonNode content)

Constructor from Json

Parameters:

content - the objectgroup of JsonNode format

ObjectGroup

public ObjectGroup(org.bson.Document content)

Constructor from Document

Parameters:

content - the objectgroup of Document format

ObjectGroup

public ObjectGroup(String content)

Constructor from Json as Text

Parameters:

content - the objectgroup of String format

Method Detail

getGUIDObjectTypeId

public static final int getGUIDObjectTypeId()

Returns:

the associated GUIDObjectType

getMetadataCollections

protected MetadataCollections getMetadataCollections()

Specified by:

getMetadataCollections in class MetadataDocument<ObjectGroup>

Returns:

the associated VitamCollection

getCollection

protected com.mongodb.client.MongoCollection<ObjectGroup> getCollection()

Specified by:

getCollection in class MetadataDocument<ObjectGroup>

Returns:

the associated collection

newInstance

public MetadataDocument<ObjectGroup> newInstance(com.fasterxml.jackson.databind.JsonNode content)

Description copied from class: VitamDocument

Make a new instance of the document with the given json

Specified by:

newInstance in class VitamDocument<ObjectGroup>

Parameters:

content - document structure as json

Returns:

new document with the json as content

newObjectGuid

public String newObjectGuid()

Returns:

a new sub Object GUID

save

public ObjectGroup save()
                 throws MetaDataExecutionException

Description copied from class: MetadataDocument

Save the object. Implementation should call putBeforeSave before the real save operation (insert or update)

Specified by:

save in class MetadataDocument<ObjectGroup>

Returns:

this

Throws:

MetaDataExecutionException - if an exception on insert/update operations occurred

updated

protected boolean updated()
                   throws MetaDataExecutionException

Description copied from class: MetadataDocument

try to update the object if necessary (difference from the current value in the database)

Specified by:

updated in class MetadataDocument<ObjectGroup>

Returns:

True if the object does not need any extra save operation

Throws:

MetaDataExecutionException

load

public boolean load()

Description copied from class: MetadataDocument

load the object from the database, ignoring any previous data, except ID

Specified by:

load in class MetadataDocument<ObjectGroup>

Returns:

True if the object is loaded

getAfterLoad

public ObjectGroup getAfterLoad()

Description copied from class: MetadataDocument

To be called after any automatic load or loadFromJson to update HashMap values.

Specified by:

getAfterLoad in class MetadataDocument<ObjectGroup>

Returns:

this

putBeforeSave

public ObjectGroup putBeforeSave()

Description copied from class: MetadataDocument

To be called before any collection.insert() or update if HashMap values is changed.

Specified by:

putBeforeSave in class MetadataDocument<ObjectGroup>

Returns:

this

getFathersUnitIds

public List<String> getFathersUnitIds(boolean remove)

Parameters:

remove - if remove the link unit/objectgroup

Returns:

the list of parent Unit

cleanStructure

public final void cleanStructure(boolean all)

Used in loop operation to clean the object

Parameters:

all - If true, all items are cleaned

isImmediateParent

public boolean isImmediateParent(String unit)

Check if the current ObjectGroup has Unit as immediate parent

Parameters:

unit - the unit could be immediate parent of objectgroup

Returns:

True if immediate parent, else False (however could be a grand parent)

addIndexes

protected static void addIndexes()

dropIndexes

protected static void dropIndexes()