java.lang.Object
- org.bson.Document
- - fr.gouv.vitam.common.database.server.mongodb.VitamDocument<Ontology>
  - - fr.gouv.vitam.functional.administration.common.Ontology

All Implemented Interfaces:

java.io.Serializable, java.util.Map<java.lang.String,java.lang.Object>, org.bson.conversions.Bson
```
public class Ontology
extends VitamDocument<Ontology>
```
Defines an ontology collection.

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K extends java.lang.Object,V extends java.lang.Object>

Field Summary

Fields
Modifier and Type	Field	Description
`static java.lang.String`	`APIFIELD`	the ontology api field
`static java.lang.String`	`COLLECTIONS`	Collections Tag
`static java.lang.String`	`CREATIONDATE`	the creation date of the ontology
`static java.lang.String`	`DESCRIPTION`	the ontology description
`static java.lang.String`	`IDENTIFIER`	the ontology identifier
`static java.lang.String`	`LAST_UPDATE`	the last update of ontology
`static java.lang.String`	`ORIGIN`	the ontology origin
`static java.lang.String`	`SEDAFIELD`	the ontology seda field
`static java.lang.String`	`SHORT_NAME`	ShortName Tag
`static java.lang.String`	`TYPE`	the ontology type

Fields inherited from class fr.gouv.vitam.common.database.server.mongodb.VitamDocument
ES_FILTER_OUT, ID, IMPLEMENTATIONVERSION, SCORE, SEDAVERSION, TENANT_ID, VERSION

Fields inherited from interface org.bson.conversions.Bson
DEFAULT_CODEC_REGISTRY

Constructor Summary

Constructors
Constructor	Description
`Ontology()`	Empty Constructor
`Ontology(com.fasterxml.jackson.databind.JsonNode content)`
`Ontology(java.lang.Integer tenantId)`
`Ontology(java.lang.String content)`
`Ontology(org.bson.Document document)`	Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`getApiField()`	The ontology api field
`java.util.List<java.lang.String>`	`getCollections()`
`java.lang.String`	`getCreationdate()`
`java.lang.String`	`getDescription()`	Get the ontology description
`java.lang.String`	`getIdentifier()`	The ontology id
`java.lang.String`	`getLastupdate()`
`OntologyOrigin`	`getOrigin()`	Get the ontology origin
`java.lang.String`	`getSedaField()`	The ontology seda field
`java.lang.String`	`getShortName()`	Get the ontology ShortName
`OntologyType`	`getType()`	Get the ontology type
`VitamDocument<Ontology>`	`newInstance(com.fasterxml.jackson.databind.JsonNode content)`	Make a new instance of the document with the given json
`Ontology`	`setApiField(java.lang.String apiField)`	Set or change the ontology api field
`Ontology`	`setCollections(java.util.List<java.lang.String> collections)`	Set or change the ontology collections
`Ontology`	`setCreationdate(java.lang.String creationdate)`
`Ontology`	`setDescription(java.lang.String description)`	Set or change the profile ontology
`Ontology`	`setId(java.lang.String id)`
`Ontology`	`setIdentifier(java.lang.String identifier)`	Set or change the ontology id, the identifier must be unique by tenant
`Ontology`	`setLastupdate(java.lang.String lastupdate)`
`Ontology`	`setOrigin(OntologyOrigin origin)`	Set or change the ontology origin
`Ontology`	`setSedaField(java.lang.String sedaField)`	Set or change the ontology seda field
`Ontology`	`setShortName(java.lang.String shortName)`	Set or change the ontology shortName
`Ontology`	`setType(OntologyType type)`	Set or change the ontology type

Methods inherited from class fr.gouv.vitam.common.database.server.mongodb.VitamDocument
checkId, getConcernedDiffLines, getId, getOriginalDiffLines, getTenantId, getUnifiedDiff, getVersion, toString, toStringDirect

Methods inherited from class org.bson.Document
append, clear, containsKey, containsValue, entrySet, equals, get, get, get, getBoolean, getBoolean, getDate, getDouble, getEmbedded, getEmbedded, getInteger, getInteger, getList, getList, 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 org.bson.conversions.Bson
toBsonDocument

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Field Detail
  - IDENTIFIER
```
public static final java.lang.String IDENTIFIER
```
    the ontology identifier
    
    See Also:
    
    Constant Field Values
  - SEDAFIELD
```
public static final java.lang.String SEDAFIELD
```
    the ontology seda field
    
    See Also:
    
    Constant Field Values
  - APIFIELD
```
public static final java.lang.String APIFIELD
```
    the ontology api field
    
    See Also:
    
    Constant Field Values
  - DESCRIPTION
```
public static final java.lang.String DESCRIPTION
```
    the ontology description
    
    See Also:
    
    Constant Field Values
  - TYPE
```
public static final java.lang.String TYPE
```
    the ontology type
    
    See Also:
    
    Constant Field Values
  - ORIGIN
```
public static final java.lang.String ORIGIN
```
    the ontology origin
    
    See Also:
    
    Constant Field Values
  - SHORT_NAME
```
public static final java.lang.String SHORT_NAME
```
    ShortName Tag
    
    See Also:
    
    Constant Field Values
  - COLLECTIONS
```
public static final java.lang.String COLLECTIONS
```
    Collections Tag
    
    See Also:
    
    Constant Field Values
  - CREATIONDATE
```
public static final java.lang.String CREATIONDATE
```
    the creation date of the ontology
    
    See Also:
    
    Constant Field Values
  - LAST_UPDATE
```
public static final java.lang.String LAST_UPDATE
```
    the last update of ontology
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Ontology
```
public Ontology()
```
    Empty Constructor
  - Ontology
```
public Ontology(org.bson.Document document)
```
    Constructor
    
    Parameters:
    
    document - data in format Document to create ontology
  - Ontology
```
public Ontology(com.fasterxml.jackson.databind.JsonNode content)
```
    Parameters:
    
    content - in format JsonNode to create ontology
  - Ontology
```
public Ontology(java.lang.String content)
```
    Parameters:
    
    content - in format String to create ontology
  - Ontology
```
public Ontology(java.lang.Integer tenantId)
```
    Parameters:
    
    tenantId - the working tenant
- Method Detail
  - newInstance
```
public VitamDocument<Ontology> 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<Ontology>
    
    Parameters:
    
    content - document structure as json
    
    Returns:
    
    new document with the json as content
  - setId
```
public Ontology setId(java.lang.String id)
```
    Parameters:
    
    id - the id of ontology
    
    Returns:
  - getIdentifier
```
public java.lang.String getIdentifier()
```
    The ontology id
    
    Returns:
    
    the id of the ontology
  - setIdentifier
```
public Ontology setIdentifier(java.lang.String identifier)
```
    Set or change the ontology id, the identifier must be unique by tenant
    
    Parameters:
    
    identifier -
    
    Returns:
    
    this
  - getSedaField
```
public java.lang.String getSedaField()
```
    The ontology seda field
    
    Returns:
    
    the seda field of the ontology
  - setSedaField
```
public Ontology setSedaField(java.lang.String sedaField)
```
    Set or change the ontology seda field
    
    Parameters:
    
    sedaField -
    
    Returns:
    
    this
  - getApiField
```
public java.lang.String getApiField()
```
    The ontology api field
    
    Returns:
    
    the api field of the ontology
  - setApiField
```
public Ontology setApiField(java.lang.String apiField)
```
    Set or change the ontology api field
    
    Parameters:
    
    apiField -
    
    Returns:
    
    this
  - getDescription
```
public java.lang.String getDescription()
```
    Get the ontology description
    
    Returns:
    
    this
  - setDescription
```
public Ontology setDescription(java.lang.String description)
```
    Set or change the profile ontology
    
    Parameters:
    
    description - to set to contact
    
    Returns:
    
    this
  - getType
```
public OntologyType getType()
```
    Get the ontology type
    
    Returns:
    
    status of the ontology
  - setType
```
public Ontology setType(OntologyType type)
```
    Set or change the ontology type
    
    Parameters:
    
    type - to set
    
    Returns:
    
    this
  - getOrigin
```
public OntologyOrigin getOrigin()
```
    Get the ontology origin
    
    Returns:
    
    origin of the ontology
  - setOrigin
```
public Ontology setOrigin(OntologyOrigin origin)
```
    Set or change the ontology origin
    
    Parameters:
    
    origin - to set
    
    Returns:
    
    this
  - getShortName
```
public java.lang.String getShortName()
```
    Get the ontology ShortName
    
    Returns:
    
    shortName of the ontology
  - setShortName
```
public Ontology setShortName(java.lang.String shortName)
```
    Set or change the ontology shortName
    
    Parameters:
    
    shortName - to set
    
    Returns:
    
    this
  - getCollections
```
public java.util.List<java.lang.String> getCollections()
```
  - setCollections
```
public Ontology setCollections(java.util.List<java.lang.String> collections)
```
    Set or change the ontology collections
    
    Parameters:
    
    collections - to set
    
    Returns:
    
    this
  - getCreationdate
```
public java.lang.String getCreationdate()
```
    Returns:
    
    creation date of ontology
  - setCreationdate
```
public Ontology setCreationdate(java.lang.String creationdate)
```
    Parameters:
    
    creationdate - to set
    
    Returns:
    
    this
  - getLastupdate
```
public java.lang.String getLastupdate()
```
    Returns:
    
    last update of profile
  - setLastupdate
```
public Ontology setLastupdate(java.lang.String lastupdate)
```
    Parameters:
    
    lastupdate - to set
    
    Returns:
    
    this

Class Ontology

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

Fields inherited from interface org.bson.conversions.Bson

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 org.bson.conversions.Bson

Methods inherited from interface java.util.Map

Field Detail

IDENTIFIER

SEDAFIELD

APIFIELD

DESCRIPTION

TYPE

ORIGIN

SHORT_NAME

COLLECTIONS

CREATIONDATE

LAST_UPDATE

Constructor Detail

Ontology

Ontology

Ontology

Ontology

Ontology

Method Detail

newInstance

setId

getIdentifier

setIdentifier

getSedaField

setSedaField

getApiField

setApiField

getDescription

setDescription

getType

setType

getOrigin

setOrigin

getShortName

setShortName

getCollections

setCollections

getCreationdate

setCreationdate

getLastupdate

setLastupdate