@hestia-earth/schema/Term.d.ts

Hestia Schema

import { JSON, JSONLD, NodeType, SchemaType } from './types';
import { Property } from './Property';
export declare enum TermTermType {
    animalManagement = "animalManagement",
    animalProduct = "animalProduct",
    antibiotic = "antibiotic",
    aquacultureManagement = "aquacultureManagement",
    building = "building",
    characterisedIndicator = "characterisedIndicator",
    crop = "crop",
    cropEstablishment = "cropEstablishment",
    cropProtection = "cropProtection",
    cropResidue = "cropResidue",
    cropResidueManagement = "cropResidueManagement",
    cropSupport = "cropSupport",
    electricity = "electricity",
    emission = "emission",
    endpointIndicator = "endpointIndicator",
    excreta = "excreta",
    excretaManagement = "excretaManagement",
    fuel = "fuel",
    grass = "grass",
    inorganicFertilizer = "inorganicFertilizer",
    irrigation = "irrigation",
    landUseManagement = "landUseManagement",
    liveAnimal = "liveAnimal",
    liveAquaticSpecies = "liveAquaticSpecies",
    machinery = "machinery",
    material = "material",
    measurement = "measurement",
    methodEmissionResourceUse = "methodEmissionResourceUse",
    methodMeasurement = "methodMeasurement",
    model = "model",
    operation = "operation",
    organicFertilizer = "organicFertilizer",
    other = "other",
    pesticideAI = "pesticideAI",
    pesticideBrandName = "pesticideBrandName",
    processedFood = "processedFood",
    property = "property",
    region = "region",
    resourceUse = "resourceUse",
    soilAmendment = "soilAmendment",
    soilTexture = "soilTexture",
    soilType = "soilType",
    standardsLabels = "standardsLabels",
    system = "system",
    tillage = "tillage",
    transport = "transport",
    usdaSoilType = "usdaSoilType",
    water = "water",
    waterRegime = "waterRegime"
}
/**
 * An item from the [Glossary of Terms](/glossary/) (controlled vocabulary). The Glossary of Terms ensures the most important data fields describing the agri-food system are named consistently. Terms can only be referred to by their [@id](#@id) or their [name](#name). Changes to Terms and their fields can be requested via [GitLab](https://gitlab.com/hestia-earth/hestia-glossary/-/blob/develop/CONTRIBUTING.md).
 */
export declare class Term extends JSON<SchemaType.Term> {
    /**
    * The name of the Term.
    */
    name?: string;
    /**
    * A list of synonyms for the name of the Term.
    */
    synonyms?: string[];
    /**
    * A definition of the Term.
    */
    definition?: string;
    /**
    * A more detailed description of the Term, which can include information about the source of these data.
    */
    description?: string;
    /**
    * The units that the value (quantity) must always be expressed in (e.g. kg).
    */
    units?: string;
    /**
    * A reference to the Term that is one level above in a hierarchy (see the [RDF Vocabulary](https://www.w3.org/TR/owl-ref/#subClassOf-def) for more details).
    */
    subClassOf?: Term[];
    /**
    * A list of default [Properties](./Property) of the Term (e.g. the dry matter of a crop).
    */
    defaultProperties?: Property[];
    /**
    * The unique numerical identifier assigned by the Chemical Abstracts Service (CAS) to every chemical substance described in the open scientific literature.
    */
    casNumber?: string;
    /**
    * The identifier for the activity in the [EcoInvent](https://www.ecoinvent.org/) database.
    */
    ecoinventActivityId?: string;
    /**
    * The name of the species in the FAO [FISHSTAT](http://www.fao.org/fishery/statistics/global-aquaculture-production/en) database.
    */
    fishstatName?: string;
    /**
    * The World Customs Organization [Harmonized System 2017](http://www.wcoomd.org/en/topics/nomenclature/instrument-and-tools/hs-nomenclature-2017-edition/hs-nomenclature-2017-edition.aspx) code.
    */
    hsCode?: string;
    /**
    * The [Indicative Crop Classification](https://unstats.un.org/unsd/classifications/Family/Detail/1002) code.
    */
    iccCode?: number;
    /**
    * The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) code for sub divisions within countries.
    */
    iso31662Code?: string;
    /**
    * The full name of the administrative region including all higher level region names in the [GADM](https://gadm.org/) database.
    */
    gadmFullName?: string;
    /**
    * The unique identifier assigned by [GADM](https://gadm.org/) database.
    */
    gadmId?: string;
    /**
    * The level of the administrative region in the [GADM](https://gadm.org/) database.
    */
    gadmLevel?: number;
    /**
    * The name of the administrative region in the [GADM](https://gadm.org/) database.
    */
    gadmName?: string;
    /**
    * The name of the country in the [GADM](https://gadm.org/) database.
    */
    gadmCountry?: string;
    /**
    * The Global Trade Item Number (GTIN) is an identifier for trade items, developed by GS1.
    */
    gtin?: string;
    /**
    * The latitude (-90 to 90, WGS84 datum). If a polygon, the centroid.
    */
    latitude?: number;
    /**
    * The longitude (-180 to 180, WGS84 datum). If a polygon, the centroid.
    */
    longitude?: number;
    /**
    * The area of the region in km2.
    */
    area?: number;
    /**
    * The identifier for the activity in the [openLCA](https://www.openlca.org/) database.
    */
    openLCAId?: string;
    /**
    * The taxonomic name of an organism that consists of the genus and species.
    */
    scientificName?: string;
    /**
    * A website URL.
    */
    website?: any;
    /**
    * A hyperlink to the [FAO AGROVOC](http://aims.fao.org/standards/agrovoc/functionalities/search) multilingual thesaurus entry.
    */
    agrovoc?: any;
    /**
    * A hyperlink to the [AQUASTAT](http://www.fao.org/fishery/species/search/en) species fact sheet.
    */
    aquastatSpeciesFactSheet?: any;
    /**
    * A hyperlink to the [ChemIDplus](https://chem.nlm.nih.gov/chemidplus/) page.
    */
    chemidplus?: any;
    /**
    * A hyperlink to the [Feedipedia](https://www.feedipedia.org/) page.
    */
    feedipedia?: any;
    /**
    * A hyperlink to the [Fishbase](https://www.fishbase.se) page.
    */
    fishbase?: any;
    /**
    * A hyperlink to the [PubChem](https://pubchem.ncbi.nlm.nih.gov/) page.
    */
    pubchem?: any;
    /**
    * A hyperlink to the [Wikipedia](https://www.wikipedia.org/) page.
    */
    wikipedia?: any;
    /**
    * The type of term.
    */
    termType?: TermTermType;
    /**
    * The version of the schema when these data were created.
    */
    schemaVersion?: string;
}
/**
 * An item from the [Glossary of Terms](/glossary/) (controlled vocabulary). The Glossary of Terms ensures the most important data fields describing the agri-food system are named consistently. Terms can only be referred to by their [@id](#@id) or their [name](#name). Changes to Terms and their fields can be requested via [GitLab](https://gitlab.com/hestia-earth/hestia-glossary/-/blob/develop/CONTRIBUTING.md).
 */
export interface ITermJSONLD extends JSONLD<NodeType.Term> {
    /**
    * A list of synonyms for the name of the Term.
    */
    synonyms?: string[];
    /**
    * A definition of the Term.
    */
    definition?: string;
    /**
    * A more detailed description of the Term, which can include information about the source of these data.
    */
    description?: string;
    /**
    * The units that the value (quantity) must always be expressed in (e.g. kg).
    */
    units?: string;
    /**
    * A reference to the Term that is one level above in a hierarchy (see the [RDF Vocabulary](https://www.w3.org/TR/owl-ref/#subClassOf-def) for more details).
    */
    subClassOf?: Term[];
    /**
    * A list of default [Properties](./Property) of the Term (e.g. the dry matter of a crop).
    */
    defaultProperties?: Property[];
    /**
    * The unique numerical identifier assigned by the Chemical Abstracts Service (CAS) to every chemical substance described in the open scientific literature.
    */
    casNumber?: string;
    /**
    * The identifier for the activity in the [EcoInvent](https://www.ecoinvent.org/) database.
    */
    ecoinventActivityId?: string;
    /**
    * The name of the species in the FAO [FISHSTAT](http://www.fao.org/fishery/statistics/global-aquaculture-production/en) database.
    */
    fishstatName?: string;
    /**
    * The World Customs Organization [Harmonized System 2017](http://www.wcoomd.org/en/topics/nomenclature/instrument-and-tools/hs-nomenclature-2017-edition/hs-nomenclature-2017-edition.aspx) code.
    */
    hsCode?: string;
    /**
    * The [Indicative Crop Classification](https://unstats.un.org/unsd/classifications/Family/Detail/1002) code.
    */
    iccCode?: number;
    /**
    * The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) code for sub divisions within countries.
    */
    iso31662Code?: string;
    /**
    * The full name of the administrative region including all higher level region names in the [GADM](https://gadm.org/) database.
    */
    gadmFullName?: string;
    /**
    * The unique identifier assigned by [GADM](https://gadm.org/) database.
    */
    gadmId?: string;
    /**
    * The level of the administrative region in the [GADM](https://gadm.org/) database.
    */
    gadmLevel?: number;
    /**
    * The name of the administrative region in the [GADM](https://gadm.org/) database.
    */
    gadmName?: string;
    /**
    * The name of the country in the [GADM](https://gadm.org/) database.
    */
    gadmCountry?: string;
    /**
    * The Global Trade Item Number (GTIN) is an identifier for trade items, developed by GS1.
    */
    gtin?: string;
    /**
    * The latitude (-90 to 90, WGS84 datum). If a polygon, the centroid.
    */
    latitude?: number;
    /**
    * The longitude (-180 to 180, WGS84 datum). If a polygon, the centroid.
    */
    longitude?: number;
    /**
    * The area of the region in km2.
    */
    area?: number;
    /**
    * The identifier for the activity in the [openLCA](https://www.openlca.org/) database.
    */
    openLCAId?: string;
    /**
    * The taxonomic name of an organism that consists of the genus and species.
    */
    scientificName?: string;
    /**
    * A website URL.
    */
    website?: any;
    /**
    * A hyperlink to the [FAO AGROVOC](http://aims.fao.org/standards/agrovoc/functionalities/search) multilingual thesaurus entry.
    */
    agrovoc?: any;
    /**
    * A hyperlink to the [AQUASTAT](http://www.fao.org/fishery/species/search/en) species fact sheet.
    */
    aquastatSpeciesFactSheet?: any;
    /**
    * A hyperlink to the [ChemIDplus](https://chem.nlm.nih.gov/chemidplus/) page.
    */
    chemidplus?: any;
    /**
    * A hyperlink to the [Feedipedia](https://www.feedipedia.org/) page.
    */
    feedipedia?: any;
    /**
    * A hyperlink to the [Fishbase](https://www.fishbase.se) page.
    */
    fishbase?: any;
    /**
    * A hyperlink to the [PubChem](https://pubchem.ncbi.nlm.nih.gov/) page.
    */
    pubchem?: any;
    /**
    * A hyperlink to the [Wikipedia](https://www.wikipedia.org/) page.
    */
    wikipedia?: any;
    /**
    * The type of term.
    */
    termType?: TermTermType;
    /**
    * The version of the schema when these data were created.
    */
    schemaVersion?: string;
}