org.phenopackets.schema.v1.core.ResourceOrBuilder Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of phenopacket-schema Show documentation
A Protobuf schema for capturing clinical phenotypes
There is a newer version: 2.0.2
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: base.proto

package org.phenopackets.schema.v1.core;

public interface ResourceOrBuilder extends
    // @@protoc_insertion_point(interface_extends:org.phenopackets.schema.v1.core.Resource)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * for OBO Ontologies, the value of this string MUST always be the official
   * OBO ID, which is always equivalent to the ID prefix in lower case.
   * Examples: hp, go, mp, mondo
   * Consult http://obofoundry.org for a complete list
   * For other ontologies (e.g. SNOMED), use the prefix in identifiers.org
   * 
   *
   * string id = 1;
   */
  java.lang.String getId();
  /**
   *    * for OBO Ontologies, the value of this string MUST always be the official
   * OBO ID, which is always equivalent to the ID prefix in lower case.
   * Examples: hp, go, mp, mondo
   * Consult http://obofoundry.org for a complete list
   * For other ontologies (e.g. SNOMED), use the prefix in identifiers.org
   * 
   *
   * string id = 1;
   */
  com.google.protobuf.ByteString
      getIdBytes();

  /**
   *    * e.g. The Human Phenotype Ontology
   * for OBO Ontologies, the value of this string SHOULD be the same as the title
   * field on http://obofoundry.org
   * however, this field is purely for information purposes and software
   * should not encode any assumptions
   * 
   *
   * string name = 2;
   */
  java.lang.String getName();
  /**
   *    * e.g. The Human Phenotype Ontology
   * for OBO Ontologies, the value of this string SHOULD be the same as the title
   * field on http://obofoundry.org
   * however, this field is purely for information purposes and software
   * should not encode any assumptions
   * 
   *
   * string name = 2;
   */
  com.google.protobuf.ByteString
      getNameBytes();

  /**
   *    * For OBO ontologies, this should always be the PURL, e.g.
   * http://purl.obolibrary.org/obo/hp.owl, http://purl.obolibrary.org/obo/hp.obo
   * 
   *
   * string url = 3;
   */
  java.lang.String getUrl();
  /**
   *    * For OBO ontologies, this should always be the PURL, e.g.
   * http://purl.obolibrary.org/obo/hp.owl, http://purl.obolibrary.org/obo/hp.obo
   * 
   *
   * string url = 3;
   */
  com.google.protobuf.ByteString
      getUrlBytes();

  /**
   *    * for OBO ontologies, this should be the versionIRI
   * 
   *
   * string version = 4;
   */
  java.lang.String getVersion();
  /**
   *    * for OBO ontologies, this should be the versionIRI
   * 
   *
   * string version = 4;
   */
  com.google.protobuf.ByteString
      getVersionBytes();

  /**
   *    * The prefix used in the CURIE of an OntologyClass e.g. HP, MP, ECO
   * For example an HPO term will have a CURIE like this - HP:0012828 which should be used in combination with
   * the iri_prefix to form a fully-resolvable IRI
   * 
   *
   * string namespace_prefix = 5;
   */
  java.lang.String getNamespacePrefix();
  /**
   *    * The prefix used in the CURIE of an OntologyClass e.g. HP, MP, ECO
   * For example an HPO term will have a CURIE like this - HP:0012828 which should be used in combination with
   * the iri_prefix to form a fully-resolvable IRI
   * 
   *
   * string namespace_prefix = 5;
   */
  com.google.protobuf.ByteString
      getNamespacePrefixBytes();

  /**
   *    * Full IRI prefix which can be used with the namespace_prefix and the OntologyClass::id to resolve to an IRI for a
   * term. Tools such as the curie-util (https://github.com/prefixcommons/curie-util) can utilise this to produce
   * fully-resolvable IRIs for an OntologyClass.
   * e.g. Using the HPO term encoding the concept of 'Severe'
   *    OntologyClass:
   *        id: 'HP:0012828'
   *        label: 'Severe'
   *    Resource:
   *        namespace_prefix: 'HP'
   *        iri_prefix: 'http://purl.obolibrary.org/obo/HP_'
   * the term can be resolved to http://purl.obolibrary.org/obo/HP_0012828
   * 
   *
   * string iri_prefix = 6;
   */
  java.lang.String getIriPrefix();
  /**
   *    * Full IRI prefix which can be used with the namespace_prefix and the OntologyClass::id to resolve to an IRI for a
   * term. Tools such as the curie-util (https://github.com/prefixcommons/curie-util) can utilise this to produce
   * fully-resolvable IRIs for an OntologyClass.
   * e.g. Using the HPO term encoding the concept of 'Severe'
   *    OntologyClass:
   *        id: 'HP:0012828'
   *        label: 'Severe'
   *    Resource:
   *        namespace_prefix: 'HP'
   *        iri_prefix: 'http://purl.obolibrary.org/obo/HP_'
   * the term can be resolved to http://purl.obolibrary.org/obo/HP_0012828
   * 
   *
   * string iri_prefix = 6;
   */
  com.google.protobuf.ByteString
      getIriPrefixBytes();
}