Class Ontology
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:
Serializable,Map<String,,Object> org.bson.conversions.Bson
Defines an ontology collection.
- See Also:
-
Nested Class Summary
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringthe ontology api fieldstatic final StringCollections Tagstatic final Stringthe creation date of the ontologystatic final Stringthe ontology descriptionstatic final Stringthe ontology identifierstatic final Stringthe last update of ontologystatic final Stringthe ontology originstatic final Stringthe ontology seda fieldstatic final StringShortName Tagstatic final StringStringSize Tagstatic final Stringthe ontology typestatic final StringTypeDetail TagFields inherited from class fr.gouv.vitam.common.database.server.mongodb.VitamDocument
ES_FILTER_OUT, ID, IMPLEMENTATIONVERSION, SCORE, SEDAVERSION, TENANT_ID, VERSIONFields inherited from interface org.bson.conversions.Bson
DEFAULT_CODEC_REGISTRY -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionThe ontology api fieldGet the ontology descriptionThe ontology idGet the ontology originThe ontology seda fieldGet the ontology ShortNamegetType()Get the ontology typenewInstance(com.fasterxml.jackson.databind.JsonNode content) Make a new instance of the document with the given jsonsetApiField(String apiField) Set or change the ontology api fieldsetCollections(List<String> collections) Set or change the ontology collectionssetCreationdate(String creationdate) setDescription(String description) Set or change the profile ontologysetIdentifier(String identifier) Set or change the ontology id, the identifier must be unique by tenantsetLastupdate(String lastupdate) setOrigin(OntologyOrigin origin) Set or change the ontology originsetSedaField(String sedaField) Set or change the ontology seda fieldsetShortName(String shortName) Set or change the ontology shortNamesetStringSize(StringSize stringSize) setType(OntologyType type) Set or change the ontology typesetTypeDetail(TypeDetail typeDetail) Methods inherited from class fr.gouv.vitam.common.database.server.mongodb.VitamDocument
checkId, getConcernedDiffLines, getId, getOriginalDiffLines, getTenantId, getUnifiedDiff, getVersion, toString, toStringDirectMethods 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, valuesMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.bson.conversions.Bson
toBsonDocumentMethods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
-
Field Details
-
IDENTIFIER
the ontology identifier- See Also:
-
SEDAFIELD
the ontology seda field- See Also:
-
APIFIELD
the ontology api field- See Also:
-
DESCRIPTION
the ontology description- See Also:
-
TYPE
the ontology type- See Also:
-
ORIGIN
the ontology origin- See Also:
-
SHORT_NAME
ShortName Tag- See Also:
-
COLLECTIONS
Collections Tag- See Also:
-
CREATIONDATE
the creation date of the ontology- See Also:
-
LAST_UPDATE
the last update of ontology- See Also:
-
TYPE_DETAIL
TypeDetail Tag- See Also:
-
STRING_SIZE
StringSize Tag- See Also:
-
-
Constructor Details
-
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
- Parameters:
content- in format String to create ontology
-
Ontology
- Parameters:
tenantId- the working tenant
-
-
Method Details
-
newInstance
Description copied from class:VitamDocumentMake a new instance of the document with the given json- Specified by:
newInstancein classVitamDocument<Ontology>- Parameters:
content- document structure as json- Returns:
- new document with the json as content
-
setId
- Parameters:
id- the id of ontology- Returns:
-
getIdentifier
The ontology id- Returns:
- the id of the ontology
-
setIdentifier
Set or change the ontology id, the identifier must be unique by tenant- Parameters:
identifier-- Returns:
- this
-
getSedaField
The ontology seda field- Returns:
- the seda field of the ontology
-
setSedaField
Set or change the ontology seda field- Parameters:
sedaField-- Returns:
- this
-
getApiField
The ontology api field- Returns:
- the api field of the ontology
-
setApiField
Set or change the ontology api field- Parameters:
apiField-- Returns:
- this
-
getDescription
Get the ontology description- Returns:
- this
-
setDescription
Set or change the profile ontology- Parameters:
description- to set to contact- Returns:
- this
-
getType
Get the ontology type- Returns:
- status of the ontology
-
setType
Set or change the ontology type- Parameters:
type- to set- Returns:
- this
-
getOrigin
Get the ontology origin- Returns:
- origin of the ontology
-
setOrigin
Set or change the ontology origin- Parameters:
origin- to set- Returns:
- this
-
getShortName
Get the ontology ShortName- Returns:
- shortName of the ontology
-
setShortName
Set or change the ontology shortName- Parameters:
shortName- to set- Returns:
- this
-
getCollections
-
setCollections
Set or change the ontology collections- Parameters:
collections- to set- Returns:
- this
-
getCreationdate
- Returns:
- creation date of ontology
-
setCreationdate
- Parameters:
creationdate- to set- Returns:
- this
-
getLastupdate
- Returns:
- last update of profile
-
setLastupdate
- Parameters:
lastupdate- to set- Returns:
- this
-
getTypeDetail
- Returns:
- typeDetail of ontology
-
setTypeDetail
- Parameters:
typeDetail- to set- Returns:
- this
-
getStringSize
- Returns:
- string size of ontology
-
setStringSize
- Parameters:
stringSize- to set- Returns:
- this
-