Skip to content

Class: FieldVariable

Abstract root for every variable that can appear in a FieldDataset — measured, calculated or contextual. Exists so FieldDataset.variables can range over exactly these classes: ranging over Variable would also admit ModelOutputVariable, which belongs only to a ModelOutputDataset.

  • NOTE: this is an abstract class and should not be instantiated directly

URI: oae:FieldVariable

 classDiagram
    class FieldVariable
    click FieldVariable href "../FieldVariable"
      Variable <|-- FieldVariable
        click Variable href "../Variable"


      FieldVariable <|-- NonMeasuredVariable
        click NonMeasuredVariable href "../NonMeasuredVariable"
      FieldVariable <|-- InSituVariable
        click InSituVariable href "../InSituVariable"


      FieldVariable : dataset_variable_name

      FieldVariable : long_name

      FieldVariable : schema_class

      FieldVariable : standard_identifier




    FieldVariable --> "0..1" VocabularyItemReference : standard_identifier
    click VocabularyItemReference href "../VocabularyItemReference"


      FieldVariable : units

      FieldVariable : variable_type




    FieldVariable --> "1" VariableType : variable_type
    click VariableType href "../VariableType"

Inheritance

Slots

Name Cardinality and Range Description Inheritance
units 0..1
String		 Unit of measurement for this variable Variable
variable_type 1
VariableType		 High-level classification of the variable Variable
schema_class 1
String		 The schema class name for this variable (e Variable
standard_identifier 0..1
VocabularyItemReference		 Variable
dataset_variable_name 1
String		 The name for the variable as it is identified in the dataset data file Variable
long_name 1
String		 Full descriptive name of the variable Variable

Usages

used by used in type used
FieldDataset variables range FieldVariable

Identifier and Mapping Information

Schema Source

  • from schema: https://schema.oaedata.org/OAEDataSchema

Mappings

Mapping Type Mapped Value
self oae:FieldVariable
native oae:FieldVariable

LinkML Source

Direct

name: FieldVariable
description: 'Abstract root for every variable that can appear in a FieldDataset —
  measured, calculated or contextual. Exists so FieldDataset.variables can range over
  exactly these classes: ranging over Variable would also admit ModelOutputVariable,
  which belongs only to a ModelOutputDataset.'
from_schema: https://schema.oaedata.org/OAEDataSchema
is_a: Variable
abstract: true
slot_usage:
  variable_type:
    name: variable_type
    range: VariableType
    required: true

Induced

name: FieldVariable
description: 'Abstract root for every variable that can appear in a FieldDataset —
  measured, calculated or contextual. Exists so FieldDataset.variables can range over
  exactly these classes: ranging over Variable would also admit ModelOutputVariable,
  which belongs only to a ModelOutputDataset.'
from_schema: https://schema.oaedata.org/OAEDataSchema
is_a: Variable
abstract: true
slot_usage:
  variable_type:
    name: variable_type
    range: VariableType
    required: true
attributes:
  units:
    name: units
    description: Unit of measurement for this variable.
    title: Unit
    from_schema: https://schema.oaedata.org/OAEDataSchema
    rank: 1000
    alias: units
    owner: FieldVariable
    domain_of:
    - Variable
    range: string
  variable_type:
    name: variable_type
    description: High-level classification of the variable. Determines which standard
      identifiers are available and, combined with genesis and sampling, which schema
      class to use.
    title: Variable Type
    from_schema: https://schema.oaedata.org/OAEDataSchema
    rank: 1000
    alias: variable_type
    owner: FieldVariable
    domain_of:
    - Variable
    range: VariableType
    required: true
  schema_class:
    name: schema_class
    description: The schema class name for this variable (e.g., "DiscretePHVariable").
      Auto-populated by the metadata builder.
    from_schema: Variable
    rank: 1000
    designates_type: true
    alias: schema_class
    owner: FieldVariable
    domain_of:
    - Variable
    range: string
    required: true
  standard_identifier:
    name: standard_identifier
    from_schema: Variable
    rank: 1000
    alias: standard_identifier
    owner: FieldVariable
    domain_of:
    - Variable
    range: VocabularyItemReference
  dataset_variable_name:
    name: dataset_variable_name
    description: The name for the variable as it is identified in the dataset data
      file. This could be the column header in a CSV or the variable name in a NetCDF
      file. Standard common recommended column header names can be found in protocol
      documentation [here](https://www.carbontosea.org/oae-data-protocol/1-0-0/#column-header-name).
    title: Dataset variable name
    from_schema: Variable
    rank: 1000
    alias: dataset_variable_name
    owner: FieldVariable
    domain_of:
    - Variable
    range: string
    required: true
  long_name:
    name: long_name
    description: Full descriptive name of the variable.
    title: Variable full name
    from_schema: Variable
    rank: 1000
    alias: long_name
    owner: FieldVariable
    domain_of:
    - Variable
    range: string
    required: true