Class 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
    • 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
      • 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