Package fr.gouv.vitam.functional.administration.common.schema

Class Schema

java.lang.Object

org.bson.Document

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

fr.gouv.vitam.functional.administration.common.schema.Schema

All Implemented Interfaces:

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

public class Schema
extends VitamDocument<Schema>

Defines a schema collection.

See Also:

• Serialized Form

Nested Class Summary

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

Map.Entry<K extends Object,V extends Object>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CREATIONDATE	the creation date of the schema
static final String	LAST_UPDATE	the last update of schema
static final String	TAG_COLLECTION	Collections Tag
static final String	TAG_DESCRIPTION	Description Tag
static final String	TAG_IS_OBJECT_NAME	isObject Tag
static final String	TAG_ORIGIN	Origin Tag
static final String	TAG_PATH	The path tag
static final String	TAG_PATH_CARDINALITY	pathCardinality tag
static final String	TAG_SHORT_NAME	ShortName Tag

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
Schema()	Empty Constructor
Schema(com.fasterxml.jackson.databind.JsonNode content)
Schema(Integer tenantId)
Schema(String content)
Schema(org.bson.Document document)	Constructor

Method Summary

Modifier and Type	Method	Description
String	getCardinality()	The schema cardinality
String	getCollection()	The schema collection of the element
String	getCreationdate()
String	getDescription()	The schema description
boolean	getIsObject()	The schema IsObject
String	getLastupdate()
String	getOrigin()	The schema origin
String	getPath()	The schema path
String	getShortName()	The schema shortName
VitamDocument<Schema>	newInstance(com.fasterxml.jackson.databind.JsonNode content)	Make a new instance of the document with the given json
Schema	setCardinality(String cardinality)	Set or change the schema cardinality
Schema	setCollection(String collection)	Set or change the schema collection
Schema	setCreationdate(String creationdate)
Schema	setDescription(String description)	Set or change the schema description
Schema	setId(String id)
Schema	setIsObject(boolean isObject)	Set or change the schema IsObject
Schema	setLastupdate(String lastupdate)
Schema	setOrigin(String origin)	Set or change the schema origin
Schema	setPath(String path)	Set or change the schema path
Schema	setShortName(String shortName)	Set or change the schema shortName

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 Details

TAG_COLLECTION

public static final String TAG_COLLECTION

Collections Tag

See Also:

• Constant Field Values

TAG_DESCRIPTION

public static final String TAG_DESCRIPTION

Description Tag

See Also:

• Constant Field Values

TAG_ORIGIN

public static final String TAG_ORIGIN

Origin Tag

See Also:

• Constant Field Values

TAG_SHORT_NAME

public static final String TAG_SHORT_NAME

ShortName Tag

See Also:

• Constant Field Values

TAG_IS_OBJECT_NAME

public static final String TAG_IS_OBJECT_NAME

isObject Tag

See Also:

• Constant Field Values

TAG_PATH

public static final String TAG_PATH

The path tag

See Also:

• Constant Field Values

TAG_PATH_CARDINALITY

public static final String TAG_PATH_CARDINALITY

pathCardinality tag

See Also:

• Constant Field Values

CREATIONDATE

public static final String CREATIONDATE

the creation date of the schema

See Also:

• Constant Field Values

LAST_UPDATE

public static final String LAST_UPDATE

the last update of schema

See Also:

• Constant Field Values

Constructor Details

Schema

public Schema()

Empty Constructor

Schema

public Schema(org.bson.Document document)

Constructor

Parameters:

document - data in format Document to create Schema

Schema

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

Parameters:

content - in format JsonNode to create Schema

Schema

public Schema(String content)

Parameters:

content - in format String to create Schema

Schema

public Schema(Integer tenantId)

Parameters:

tenantId - the working tenant

Method Details

newInstance

public VitamDocument<Schema> 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<Schema>

Parameters:

content - document structure as json

Returns:

new document with the json as content

setId

public Schema setId(String id)

Parameters:

id - the id of schema

Returns:

getDescription

public String getDescription()

The schema description

Returns:

the description of the schema

setDescription

public Schema setDescription(String description)

Set or change the schema description

Parameters:

description -

Returns:

this

getCollection

public String getCollection()

The schema collection of the element

Returns:

the collection of the schema element

setCollection

public Schema setCollection(String collection)

Set or change the schema collection

Parameters:

collection -

Returns:

this

getOrigin

public String getOrigin()

The schema origin

Returns:

the origin of the schema

setOrigin

public Schema setOrigin(String origin)

Set or change the schema origin

Parameters:

origin -

Returns:

this

getShortName

public String getShortName()

The schema shortName

Returns:

the shortName of the schema

setShortName

public Schema setShortName(String shortName)

Set or change the schema shortName

Parameters:

shortName -

Returns:

this

getIsObject

public boolean getIsObject()

The schema IsObject

Returns:

the IsObject of the schema

setIsObject

public Schema setIsObject(boolean isObject)

Set or change the schema IsObject

Parameters:

isObject -

Returns:

this

getPath

public String getPath()

The schema path

Returns:

the path of the schema

setPath

public Schema setPath(String path)

Set or change the schema path

Parameters:

path -

Returns:

this

getCardinality

public String getCardinality()

The schema cardinality

Returns:

the cardinality of the schema

setCardinality

public Schema setCardinality(String cardinality)

Set or change the schema cardinality

Parameters:

cardinality -

Returns:

this

getCreationdate

public String getCreationdate()

Returns:

creation date of schema elt

setCreationdate

public Schema setCreationdate(String creationdate)

Parameters:

creationdate - to set

Returns:

this

getLastupdate

public String getLastupdate()

Returns:

last update of profile

setLastupdate

public Schema setLastupdate(String lastupdate)

Parameters:

lastupdate - to set

Returns:

this