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

Class Unit

java.lang.Object

org.bson.Document

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

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

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

All Implemented Interfaces:

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

public class Unit
extends MetadataDocument<Unit>

Unit class:

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	ACCESSEND
static String	ACCESSRULE Access Rule
static String	ACCESSRULES
static String	APPRAISALEND
static String	APPRAISALRULE Appraisal Rule
static String	APPRAISALRULES
static String	CLASSIFICATIONEND
static String	CLASSIFICATIONRULE Classification Rule
static String	CLASSIFICATIONRULES
static String	DISSEMINATIONEND
static String	DISSEMINATIONRULE Dissemination Rule
static String	DISSEMINATIONRULES
static String	END Rule end date (computed)
static String	MANAGEMENT Management : { various rules per themes }
static String	MAXDEPTH MAXDEPTH : max
static String	MINDEPTH MINDEPTH : min
static String	REUSEEND
static String	REUSERULE Reuse Rule
static String	REUSERULES
static String	RULE Rule
static String	STORAGEEND
static String	STORAGERULE Storage Rule
static String	STORAGERULES
static com.mongodb.BasicDBObject	UNIT_ES_PROJECTION Es projection (no UPS)
static com.mongodb.BasicDBObject	UNIT_OBJECTGROUP_PROJECTION Quick projection for ID and ObjectGroup Only
static String	UNIT_TYPE UnitType : normal or holding scheme
static com.mongodb.BasicDBObject	UNIT_VITAM_MANAGEMENT_PROJECTION Unit Id, Vitam and Management fields Only projection (no content)
static com.mongodb.BasicDBObject	UNIT_VITAM_PROJECTION Unit Id, Vitam fields Only projection (no content nor management)
static String	UNITDEPTHS UNITDEPTHS : { UUID1 : depth2, UUID2 : depth2 }
static String	UNITDEPTHS_POINT
static String	UNITUPS UNITUPS : [ UUID1, UUID2 ]

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
Unit() Empty constructor
Unit(org.bson.Document content) Constructor from Document
Unit(com.fasterxml.jackson.databind.JsonNode content) Constructor from Json
Unit(String content) Constructor from Json as Text

Method Summary

Modifier and Type	Method and Description
protected static void	addIndexes()
Unit	addObjectGroup(ObjectGroup data) Add the link 1-N between Unit and ObjectGroup (update both Unit and ObjectGroup)
Unit	addUnit(Unit unit) Add the link (N)-N between this Unit and sub Unit (update only subUnit)
Unit	addUnits(List<Unit> units) Add the link (N)-N between Unit and List of sub Units (update only subUnits)
void	cleanStructure(boolean all) Used in loop operation to clean the object
protected static void	dropIndexes()
Unit	getAfterLoad() To be called after any automatic load or loadFromJson to update HashMap values.
List<String>	getChildrenUnitIdsFromParent()
protected com.mongodb.client.MongoCollection<Unit>	getCollection()
Map<String,Integer>	getDepths()
List<String>	getFathersUnitIds(boolean remove)
static int	getGUIDObjectTypeId()
int	getMaxDepth()
protected MetadataCollections	getMetadataCollections()
int	getMinDepth()
String	getObjectGroupId(boolean remove)
List<org.bson.conversions.Bson>	getSubDepthList() Used in ingest (get the next uds including itself with depth +1 for all)
List<org.bson.conversions.Bson>	getSubDepthList(List<Unit> units) Used in ingest (get the next uds including itself with depth +1 for all)
List<String>	getSubUnitUps() Used in ingest (get the next ups including itself)
boolean	isImmediateParent(String other) Check if the current Unit has other Unit as immediate parent
boolean	load() load the object from the database, ignoring any previous data, except ID
MetadataDocument<Unit>	newInstance(com.fasterxml.jackson.databind.JsonNode content) Make a new instance of the document with the given json
Unit	putBeforeSave() To be called before any collection.insert() or update if HashMap values is changed.
Unit	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

UNITDEPTHS

public static final String UNITDEPTHS

UNITDEPTHS : { UUID1 : depth2, UUID2 : depth2 }

See Also:

Constant Field Values

UNITDEPTHS_POINT

public static final String UNITDEPTHS_POINT

See Also:

Constant Field Values

UNITUPS

public static final String UNITUPS

UNITUPS : [ UUID1, UUID2 ]

See Also:

Constant Field Values

MINDEPTH

public static final String MINDEPTH

MINDEPTH : min

See Also:

Constant Field Values

MAXDEPTH

public static final String MAXDEPTH

MAXDEPTH : max

See Also:

Constant Field Values

MANAGEMENT

public static final String MANAGEMENT

Management : { various rules per themes }

See Also:

Constant Field Values

UNIT_TYPE

public static final String UNIT_TYPE

UnitType : normal or holding scheme

See Also:

Constant Field Values

UNIT_OBJECTGROUP_PROJECTION

public static final com.mongodb.BasicDBObject UNIT_OBJECTGROUP_PROJECTION

Quick projection for ID and ObjectGroup Only

UNIT_ES_PROJECTION

public static final com.mongodb.BasicDBObject UNIT_ES_PROJECTION

Es projection (no UPS)

UNIT_VITAM_PROJECTION

public static final com.mongodb.BasicDBObject UNIT_VITAM_PROJECTION

Unit Id, Vitam fields Only projection (no content nor management)

UNIT_VITAM_MANAGEMENT_PROJECTION

public static final com.mongodb.BasicDBObject UNIT_VITAM_MANAGEMENT_PROJECTION

Unit Id, Vitam and Management fields Only projection (no content)

STORAGERULE

public static final String STORAGERULE

Storage Rule

See Also:

Constant Field Values

APPRAISALRULE

public static final String APPRAISALRULE

Appraisal Rule

See Also:

Constant Field Values

ACCESSRULE

public static final String ACCESSRULE

Access Rule

See Also:

Constant Field Values

DISSEMINATIONRULE

public static final String DISSEMINATIONRULE

Dissemination Rule

See Also:

Constant Field Values

REUSERULE

public static final String REUSERULE

Reuse Rule

See Also:

Constant Field Values

CLASSIFICATIONRULE

public static final String CLASSIFICATIONRULE

Classification Rule

See Also:

Constant Field Values

RULE

public static final String RULE

Rule

See Also:

Constant Field Values

END

public static final String END

Rule end date (computed)

See Also:

Constant Field Values

STORAGERULES

public static final String STORAGERULES

See Also:

Constant Field Values

STORAGEEND

public static final String STORAGEEND

See Also:

Constant Field Values

APPRAISALRULES

public static final String APPRAISALRULES

See Also:

Constant Field Values

APPRAISALEND

public static final String APPRAISALEND

See Also:

Constant Field Values

ACCESSRULES

public static final String ACCESSRULES

See Also:

Constant Field Values

ACCESSEND

public static final String ACCESSEND

See Also:

Constant Field Values

DISSEMINATIONRULES

public static final String DISSEMINATIONRULES

See Also:

Constant Field Values

DISSEMINATIONEND

public static final String DISSEMINATIONEND

See Also:

Constant Field Values

REUSERULES

public static final String REUSERULES

See Also:

Constant Field Values

REUSEEND

public static final String REUSEEND

See Also:

Constant Field Values

CLASSIFICATIONRULES

public static final String CLASSIFICATIONRULES

See Also:

Constant Field Values

CLASSIFICATIONEND

public static final String CLASSIFICATIONEND

See Also:

Constant Field Values

Constructor Detail

Unit

public Unit()

Empty constructor

Unit

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

Constructor from Json

Parameters:

content - of type JsonNode for building Unit

Unit

public Unit(org.bson.Document content)

Constructor from Document

Parameters:

content - of type Document for building Unit

Unit

public Unit(String content)

Constructor from Json as Text

Parameters:

content - of type String for building Unit

Method Detail

newInstance

public MetadataDocument<Unit> 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<Unit>

Parameters:

content - document structure as json

Returns:

new document with the json as content

getGUIDObjectTypeId

public static final int getGUIDObjectTypeId()

Returns:

the associated GUIDObjectType

getCollection

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

Specified by:

getCollection in class MetadataDocument<Unit>

Returns:

the associated collection

getMetadataCollections

protected MetadataCollections getMetadataCollections()

Specified by:

getMetadataCollections in class MetadataDocument<Unit>

Returns:

the associated VitamCollection

save

public Unit 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<Unit>

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

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

Returns:

True if the object is loaded

getAfterLoad

public Unit 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<Unit>

Returns:

this

putBeforeSave

public Unit 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<Unit>

Returns:

this

getSubDepthList

public List<org.bson.conversions.Bson> getSubDepthList()

Used in ingest (get the next uds including itself with depth +1 for all)

Returns:

a list of udpate query for new unitdepth for children

getSubDepthList

public List<org.bson.conversions.Bson> getSubDepthList(List<Unit> units)

Used in ingest (get the next uds including itself with depth +1 for all)

Parameters:

units - the list of unit to add

Returns:

a list of udpate query for new unitdepth for children

getSubUnitUps

public List<String> getSubUnitUps()

Used in ingest (get the next ups including itself)

Returns:

the new UNITUPS

getDepths

public Map<String,Integer> getDepths()

Returns:

the map of parent units with depth

getMaxDepth

public int getMaxDepth()

Returns:

the max depth of this node from existing parents

getMinDepth

public int getMinDepth()

Returns:

the min depth of this node from existing parents

addUnit

public Unit addUnit(Unit unit)
             throws MetaDataExecutionException

Add the link (N)-N between this Unit and sub Unit (update only subUnit)

Parameters:

unit - for adding the link

Returns:

Unit with link added

Throws:

MetaDataExecutionException - when adding exception occurred

addUnits

public Unit addUnits(List<Unit> units)
              throws MetaDataExecutionException

Add the link (N)-N between Unit and List of sub Units (update only subUnits)

Parameters:

units - list of units for adding the link

Returns:

Unit with links added

Throws:

MetaDataExecutionException - when adding exception occurred

getChildrenUnitIdsFromParent

public List<String> getChildrenUnitIdsFromParent()

Returns:

the list of UUID of children (database access)

getFathersUnitIds

public List<String> getFathersUnitIds(boolean remove)

Parameters:

remove - if remove the link between units

Returns:

the list of UUID of Unit parents (immediate)

addObjectGroup

public Unit addObjectGroup(ObjectGroup data)
                    throws MetaDataExecutionException

Add the link 1-N between Unit and ObjectGroup (update both Unit and ObjectGroup)

Parameters:

data - the objectgroup for adding link

Returns:

Unit with link added

Throws:

MetaDataExecutionException - when adding exception occurred

getObjectGroupId

public String getObjectGroupId(boolean remove)

Parameters:

remove - if remove the link

Returns:

the ObjectGroup UUID (may return null)

isImmediateParent

public boolean isImmediateParent(String other)

Check if the current Unit has other Unit as immediate parent

Parameters:

other - a unit that could be immediate parent of current unit

Returns:

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

cleanStructure

public final void cleanStructure(boolean all)

Used in loop operation to clean the object

Parameters:

all - If true, all items are cleaned

addIndexes

protected static void addIndexes()

dropIndexes

protected static void dropIndexes()