Unit (Vitam API Reference (1.10.0-1))

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`	`ELIMINATION` elimination
`static String`	`END` Rule end date (computed)
`static String`	`GRAPH`
`static String`	`HISTORY`
`static String`	`MANAGEMENT` Management : { various rules per themes }
`static String`	`MAXDEPTH` MAXDEPTH : max
`static String`	`MINDEPTH` MINDEPTH : min
`static String`	`PARENT_ORIGINATING_AGENCIES`
`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 String`	`UNIT_TYPE` UnitType : normal or holding scheme
`static String`	`UNITDEPTHS` UNITDEPTHS : { depth1: [UUID1], depth2: [UUID2, UUID3] }
`static String`	`UNITUPS` UNITUPS : [ UUID1, UUID2 ]

Fields inherited from class fr.gouv.vitam.metadata.core.database.collections.MetadataDocument
ES_PROJECTION, GRAPH_LAST_PERSISTED_DATE, NBCHILD, OG, OPI, OPS, ORIGINATING_AGENCIES, ORIGINATING_AGENCY, QUALIFIERS, TYPE, UP

Fields inherited from class fr.gouv.vitam.common.database.server.mongodb.VitamDocument
ES_FILTER_OUT, ID, IMPLEMENTATIONVERSION, SCORE, SEDAVERSION, 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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected com.mongodb.client.MongoCollection<Unit>`	`getCollection()`
`protected MetadataCollections`	`getMetadataCollections()`
`void`	`mergeWith(UnitGraphModel unitGraphModel)` add graph information into unit.
`MetadataDocument<Unit>`	`newInstance(com.fasterxml.jackson.databind.JsonNode content)` Make a new instance of the document with the given json

Methods inherited from class fr.gouv.vitam.metadata.core.database.collections.MetadataDocument
checkId, delete, getCollectionOrEmpty, getId, getMapOrEmpty, getSp, getUp, insert, 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 : { depth1: [UUID1], depth2: [UUID2, UUID3] }
    
    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
  - ELIMINATION
```
public static final String ELIMINATION
```
    elimination
    
    See Also:
    
    Constant Field Values
  - UNIT_TYPE
```
public static final String UNIT_TYPE
```
    UnitType : normal or holding scheme
    
    See Also:
    
    Constant Field Values
  - GRAPH
```
public static final String GRAPH
```
    See Also:
    
    Constant Field Values
  - PARENT_ORIGINATING_AGENCIES
```
public static final String PARENT_ORIGINATING_AGENCIES
```
    See Also:
    
    Constant Field Values
  - HISTORY
```
public static final String HISTORY
```
    See Also:
    
    Constant Field Values
  - UNIT_ES_PROJECTION
```
public static final com.mongodb.BasicDBObject UNIT_ES_PROJECTION
```
    Es projection (no UPS)
  - 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
  - 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
  - mergeWith
```
public void mergeWith(UnitGraphModel unitGraphModel)
```
    add graph information into unit.
    
    Parameters:
    
    unitGraphModel -

Class Unit

Nested Class Summary

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

Field Summary

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class org.bson.Document

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Field Detail

UNITDEPTHS

UNITUPS

MINDEPTH

MAXDEPTH

MANAGEMENT

ELIMINATION

UNIT_TYPE

GRAPH

PARENT_ORIGINATING_AGENCIES

HISTORY

UNIT_ES_PROJECTION

STORAGERULE

APPRAISALRULE

ACCESSRULE

DISSEMINATIONRULE

REUSERULE

CLASSIFICATIONRULE

RULE

END

STORAGERULES

STORAGEEND

APPRAISALRULES

APPRAISALEND

ACCESSRULES

ACCESSEND

DISSEMINATIONRULES

DISSEMINATIONEND

REUSERULES

REUSEEND

CLASSIFICATIONRULES

CLASSIFICATIONEND

Constructor Detail

Unit

Unit

Unit

Unit

Method Detail

newInstance

getCollection

getMetadataCollections

mergeWith