MetadataDocument (Vitam API Reference (1.0.0))

java.lang.Object
- org.bson.Document
- - fr.gouv.vitam.common.database.server.mongodb.VitamDocument<E>
  - - fr.gouv.vitam.metadata.core.database.collections.MetadataDocument<E>

Type Parameters:

E - Class associated with this Document

All Implemented Interfaces:

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

Direct Known Subclasses:

ObjectGroup, Unit
```
public abstract class MetadataDocument<E>
extends VitamDocument<E>
```
The default Vitam Type object to be stored in the database (MongoDb/ElasticSearch mode)

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[]`	`ES_PROJECTION` Quick projection for ID and ObjectGroup Only
`static String`	`NBCHILD` Number of copies or Number of Immediate child (Unit)
`static String`	`OG` ObjectGroup link (Unit to ObjectGroup)
`static String`	`OPI` Initial Operation (both Unit and ObjectGroup)
`static String`	`OPS` Array of operations (both Unit and ObjectGroup)
`static String`	`ORIGINATING_AGENCIES` ORIGINATING_AGENCIES : list of all originating agencies for unit
`static String`	`ORIGINATING_AGENCY` ORIGINATING_AGENCy : Principal originating agency for unit
`static String`	`QUALIFIERS` Object Type (text, audio, video, document, image, ...) Unit Type (facture, paye, ...)
`static String`	`TYPE` Object Type (text, audio, video, document, image, ...) Unit Type (facture, paye, ...)
`static String`	`UNUSED` Unused field
`static String`	`UP` Parents link (Units or ObjectGroup to parent Units)

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

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`MetadataDocument<E>`	`checkId()` Create a new ID
`MetadataDocument<E>`	`delete()` Delete the current object
`abstract MetadataDocument<E>`	`getAfterLoad()` To be called after any automatic load or loadFromJson to update HashMap values.
`protected abstract com.mongodb.client.MongoCollection<E>`	`getCollection()`
`int`	`getDomainId()`
`static int`	`getGUIDObjectTypeId()`
`String`	`getId()`
`protected abstract MetadataCollections`	`getMetadataCollections()`
`protected MetadataDocument<E>`	`insert()` Insert the document (only for new): should not be called elsewhere
`abstract boolean`	`load()` load the object from the database, ignoring any previous data, except ID
`MetadataDocument<E>`	`load(String json)` Load from a JSON String
`abstract MetadataDocument<E>`	`putBeforeSave()` To be called before any collection.insert() or update if HashMap values is changed.
`abstract MetadataDocument<E>`	`save()` Save the object.
`String`	`toStringDebug()`
`String`	`toStringDirect()`
`MetadataDocument<E>`	`update(org.bson.conversions.Bson update)` Update the object to the database
`protected abstract boolean`	`updated()` try to update the object if necessary (difference from the current value in the database)

Methods inherited from class fr.gouv.vitam.common.database.server.mongodb.VitamDocument
getConcernedDiffLines, getTenantId, getUnifiedDiff, getVersion, newInstance, 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
  - QUALIFIERS
```
public static final String QUALIFIERS
```
    Object Type (text, audio, video, document, image, ...) Unit Type (facture, paye, ...)
    
    See Also:
    
    Constant Field Values
  - NBCHILD
```
public static final String NBCHILD
```
    Number of copies or
    Number of Immediate child (Unit)
    
    See Also:
    
    Constant Field Values
  - TYPE
```
public static final String TYPE
```
    Object Type (text, audio, video, document, image, ...) Unit Type (facture, paye, ...)
    
    See Also:
    
    Constant Field Values
  - UP
```
public static final String UP
```
    Parents link (Units or ObjectGroup to parent Units)
    
    See Also:
    
    Constant Field Values
  - UNUSED
```
public static final String UNUSED
```
    Unused field
    
    See Also:
    
    Constant Field Values
  - OG
```
public static final String OG
```
    ObjectGroup link (Unit to ObjectGroup)
    
    See Also:
    
    Constant Field Values
  - OPS
```
public static final String OPS
```
    Array of operations (both Unit and ObjectGroup)
    
    See Also:
    
    Constant Field Values
  - OPI
```
public static final String OPI
```
    Initial Operation (both Unit and ObjectGroup)
    
    See Also:
    
    Constant Field Values
  - ORIGINATING_AGENCY
```
public static final String ORIGINATING_AGENCY
```
    ORIGINATING_AGENCy : Principal originating agency for unit
    
    See Also:
    
    Constant Field Values
  - ORIGINATING_AGENCIES
```
public static final String ORIGINATING_AGENCIES
```
    ORIGINATING_AGENCIES : list of all originating agencies for unit
    
    See Also:
    
    Constant Field Values
  - ES_PROJECTION
```
public static final String[] ES_PROJECTION
```
    Quick projection for ID and ObjectGroup Only
- Constructor Detail
  - MetadataDocument
```
public MetadataDocument()
```
    Empty constructor
  - MetadataDocument
```
public MetadataDocument(com.fasterxml.jackson.databind.JsonNode content)
```
    Constructor from Json
    
    Parameters:
    
    content - in JsonNode format for building MetadataDocument
  - MetadataDocument
```
public MetadataDocument(org.bson.Document content)
```
    Constructor from Document
    
    Parameters:
    
    content - in Document format for building MetadataDocument
  - MetadataDocument
```
public MetadataDocument(String content)
```
    Constructor from Json as text
    
    Parameters:
    
    content - in String format for building MetadataDocument
- Method Detail
  - getGUIDObjectTypeId
```
public static int getGUIDObjectTypeId()
```
    Returns:
    
    the associated GUIDObjectType
  - checkId
```
public MetadataDocument<E> checkId()
```
    Create a new ID
    
    Overrides:
    
    checkId in class VitamDocument<E>
    
    Returns:
    
    this MetadataDocument
  - getId
```
public final String getId()
```
    Overrides:
    
    getId in class VitamDocument<E>
    
    Returns:
    
    the ID
  - getDomainId
```
public final int getDomainId()
```
    Returns:
    
    the domainId
  - load
```
public final MetadataDocument<E> load(String json)
```
    Load from a JSON String
    
    Parameters:
    
    json - in String format for building MetadataDocument
    
    Returns:
    
    this
  - getAfterLoad
```
public abstract MetadataDocument<E> getAfterLoad()
```
    To be called after any automatic load or loadFromJson to update HashMap values.
    
    Returns:
    
    this
  - putBeforeSave
```
public abstract MetadataDocument<E> putBeforeSave()
```
    To be called before any collection.insert() or update if HashMap values is changed.
    
    Returns:
    
    this
  - getCollection
```
protected abstract com.mongodb.client.MongoCollection<E> getCollection()
```
    Returns:
    
    the associated collection
  - getMetadataCollections
```
protected abstract MetadataCollections getMetadataCollections()
```
    Returns:
    
    the associated VitamCollection
  - save
```
public abstract MetadataDocument<E> save()
                                  throws MetaDataExecutionException
```
    Save the object. Implementation should call putBeforeSave before the real save operation (insert or update)
    
    Returns:
    
    this
    
    Throws:
    
    MetaDataExecutionException - if an exception on insert/update operations occurred
  - update
```
public MetadataDocument<E> update(org.bson.conversions.Bson update)
                           throws MetaDataExecutionException
```
    Update the object to the database
    
    Parameters:
    
    update - data of update operation
    
    Returns:
    
    this
    
    Throws:
    
    MetaDataExecutionException - if mongo exception query or illegal argument of query for update operation
  - updated
```
protected abstract boolean updated()
                            throws MetaDataExecutionException
```
    try to update the object if necessary (difference from the current value in the database)
    
    Returns:
    
    True if the object does not need any extra save operation
    
    Throws:
    
    MetaDataExecutionException
  - load
```
public abstract boolean load()
```
    load the object from the database, ignoring any previous data, except ID
    
    Returns:
    
    True if the object is loaded
  - insert
```
protected final MetadataDocument<E> insert()
                                    throws MetaDataExecutionException
```
    Insert the document (only for new): should not be called elsewhere
    
    Returns:
    
    this
    
    Throws:
    
    MetaDataExecutionException - if mongo exception query or illegal argument of query
  - delete
```
public final MetadataDocument<E> delete()
                                 throws MetaDataExecutionException
```
    Delete the current object
    
    Returns:
    
    MetadataDocument
    
    Throws:
    
    MetaDataExecutionException - if mongo exception delete request on collection
  - toStringDirect
```
public String toStringDirect()
```
    Overrides:
    
    toStringDirect in class VitamDocument<E>
    
    Returns:
    
    the bypass toString
  - toStringDebug
```
public String toStringDebug()
```
    Returns:
    
    the toString for Debug mode

Class MetadataDocument<E>

Nested Class Summary

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

Field Summary

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

Constructor Summary

Method Summary

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

QUALIFIERS

NBCHILD

TYPE

UP

UNUSED

OG

OPS

OPI

ORIGINATING_AGENCY

ORIGINATING_AGENCIES

ES_PROJECTION

Constructor Detail

MetadataDocument

MetadataDocument

MetadataDocument

MetadataDocument

Method Detail

getGUIDObjectTypeId

checkId

getId

getDomainId

load

getAfterLoad

putBeforeSave

getCollection

getMetadataCollections

save

update

updated

load

insert

delete

toStringDirect

toStringDebug