MetaModel

Definitions

See Datamodel docs for full documentation

class linkml_runtime.linkml_model.meta.SchemaDefinition(*args, _if_missing: Callable[[JsonObj, str], Tuple[bool, Any]] = None, **kwargs)[source]

A collection of definitions that make up a schema or a data model.

MissingRequiredField(field_name: str) None

Generic loader error handler

bindings: dict | EnumBinding | list[dict | EnumBinding] | None
class_class_curie: ClassVar[str] = 'linkml:SchemaDefinition'
class_class_uri: ClassVar[URIRef] = rdflib.term.URIRef('https://w3id.org/linkml/SchemaDefinition')
class_model_uri: ClassVar[URIRef] = rdflib.term.URIRef('https://w3id.org/linkml/SchemaDefinition')
class_name: ClassVar[str] = 'schema_definition'
classes: dict[str | ClassDefinitionName, dict | ClassDefinition] | list[dict | ClassDefinition] | None
default_curi_maps: str | list[str] | None
default_prefix: str | None = None
default_range: str | TypeDefinitionName | None = None
emit_prefixes: str | NCName | list[str | NCName] | None
enums: dict[str | EnumDefinitionName, dict | EnumDefinition] | list[dict | EnumDefinition] | None
generation_date: str | XSDDateTime | None = None
id: str | URI = None
imports: str | URIorCURIE | list[str | URIorCURIE] | None
license: str | None = None
metamodel_version: str | None = None
name: str | SchemaDefinitionName = None
prefixes: dict[str | PrefixPrefixPrefix, dict | Prefix] | list[dict | Prefix] | None
settings: dict[str | SettingSettingKey, dict | Setting] | list[dict | Setting] | None
slot_names_unique: bool | Bool | None = None
slots: dict[str | SlotDefinitionName, dict | SlotDefinition] | list[dict | SlotDefinition] | None
source_file: str | None = None
source_file_date: str | XSDDateTime | None = None
source_file_size: int | None = None
subsets: dict[str | SubsetDefinitionName, dict | SubsetDefinition] | list[dict | SubsetDefinition] | None
types: dict[str | TypeDefinitionName, dict | TypeDefinition] | list[dict | TypeDefinition] | None
version: str | None = None
class linkml_runtime.linkml_model.meta.ClassDefinition(*args, _if_missing: Callable[[JsonObj, str], Tuple[bool, Any]] = None, **kwargs)[source]

an element whose instances are complex objects that may have slot-value assignments

all_of: dict | AnonymousClassExpression | list[dict | AnonymousClassExpression] | None
any_of: dict | AnonymousClassExpression | list[dict | AnonymousClassExpression] | None
apply_to: str | ClassDefinitionName | list[str | ClassDefinitionName] | None
attributes: dict[str | SlotDefinitionName, dict | SlotDefinition] | list[dict | SlotDefinition] | None
children_are_mutually_disjoint: bool | Bool | None = None
class_class_curie: ClassVar[str] = 'linkml:ClassDefinition'
class_class_uri: ClassVar[URIRef] = rdflib.term.URIRef('https://w3id.org/linkml/ClassDefinition')
class_model_uri: ClassVar[URIRef] = rdflib.term.URIRef('https://w3id.org/linkml/ClassDefinition')
class_name: ClassVar[str] = 'class_definition'
class_uri: str | URIorCURIE | None = None
classification_rules: dict | AnonymousClassExpression | list[dict | AnonymousClassExpression] | None
defining_slots: str | SlotDefinitionName | list[str | SlotDefinitionName] | None
disjoint_with: str | ClassDefinitionName | list[str | ClassDefinitionName] | None
exactly_one_of: dict | AnonymousClassExpression | list[dict | AnonymousClassExpression] | None
is_a: str | ClassDefinitionName | None = None
mixins: str | ClassDefinitionName | list[str | ClassDefinitionName] | None
name: str | ClassDefinitionName = None
none_of: dict | AnonymousClassExpression | list[dict | AnonymousClassExpression] | None
represents_relationship: bool | Bool | None = None
rules: dict | ClassRule | list[dict | ClassRule] | None
slot_conditions: dict[str | SlotDefinitionName, dict | SlotDefinition] | list[dict | SlotDefinition] | None
slot_names_unique: bool | Bool | None = None
slot_usage: dict[str | SlotDefinitionName, dict | SlotDefinition] | list[dict | SlotDefinition] | None
slots: str | SlotDefinitionName | list[str | SlotDefinitionName] | None
subclass_of: str | URIorCURIE | None = None
tree_root: bool | Bool | None = None
union_of: str | ClassDefinitionName | list[str | ClassDefinitionName] | None
unique_keys: dict[str | UniqueKeyUniqueKeyName, dict | UniqueKey] | list[dict | UniqueKey] | None
class linkml_runtime.linkml_model.meta.SlotDefinition(*args, _if_missing: Callable[[JsonObj, str], Tuple[bool, Any]] = None, **kwargs)[source]

an element that describes how instances are related to other instances

alias: str | None = None
all_members: dict | AnonymousSlotExpression | None = None
all_of: dict | AnonymousSlotExpression | list[dict | AnonymousSlotExpression] | None
any_of: dict | AnonymousSlotExpression | list[dict | AnonymousSlotExpression] | None
apply_to: str | SlotDefinitionName | list[str | SlotDefinitionName] | None
array: dict | ArrayExpression | None = None
asymmetric: bool | Bool | None = None
bindings: dict | EnumBinding | list[dict | EnumBinding] | None
children_are_mutually_disjoint: bool | Bool | None = None
class_class_curie: ClassVar[str] = 'linkml:SlotDefinition'
class_class_uri: ClassVar[URIRef] = rdflib.term.URIRef('https://w3id.org/linkml/SlotDefinition')
class_model_uri: ClassVar[URIRef] = rdflib.term.URIRef('https://w3id.org/linkml/SlotDefinition')
class_name: ClassVar[str] = 'slot_definition'
designates_type: bool | Bool | None = None
disjoint_with: str | SlotDefinitionName | list[str | SlotDefinitionName] | None
domain: str | ClassDefinitionName | None = None
domain_of: str | ClassDefinitionName | list[str | ClassDefinitionName] | None
enum_range: dict | EnumExpression | None = None
equals_expression: str | None = None
equals_number: int | None = None
equals_string: str | None = None
equals_string_in: str | list[str] | None
exact_cardinality: int | None = None
exactly_one_of: dict | AnonymousSlotExpression | list[dict | AnonymousSlotExpression] | None
has_member: dict | AnonymousSlotExpression | None = None
identifier: bool | Bool | None = None
ifabsent: str | None = None
implicit_prefix: str | None = None
inherited: bool | Bool | None = None
inlined: bool | Bool | None = None
inlined_as_list: bool | Bool | None = None
inverse: str | SlotDefinitionName | None = None
irreflexive: bool | Bool | None = None
is_a: str | SlotDefinitionName | None = None
is_class_field: bool | Bool | None = None
is_grouping_slot: bool | Bool | None = None
is_usage_slot: bool | Bool | None = None
key: bool | Bool | None = None
list_elements_ordered: bool | Bool | None = None
list_elements_unique: bool | Bool | None = None
locally_reflexive: bool | Bool | None = None
maximum_cardinality: int | None = None
maximum_value: dict | Any | None = None
minimum_cardinality: int | None = None
minimum_value: dict | Any | None = None
mixins: str | SlotDefinitionName | list[str | SlotDefinitionName] | None
multivalued: bool | Bool | None = None
name: str | SlotDefinitionName = None
none_of: dict | AnonymousSlotExpression | list[dict | AnonymousSlotExpression] | None
owner: str | DefinitionName | None = None
path_rule: dict | PathExpression | None = None
pattern: str | None = None
range: str | ElementName | None = None
range_expression: dict | AnonymousClassExpression | None = None
readonly: str | None = None
recommended: bool | Bool | None = None
reflexive: bool | Bool | None = None
reflexive_transitive_form_of: str | SlotDefinitionName | None = None
relational_role: str | RelationalRoleEnum | None = None
required: bool | Bool | None = None
role: str | None = None
shared: bool | Bool | None = None
singular_name: str | None = None
slot_group: str | SlotDefinitionName | None = None
slot_uri: str | URIorCURIE | None = None
structured_pattern: dict | PatternExpression | None = None
subproperty_of: str | SlotDefinitionName | None = None
symmetric: bool | Bool | None = None
transitive: bool | Bool | None = None
transitive_form_of: str | SlotDefinitionName | None = None
type_mappings: str | TypeMappingFramework | list[str | TypeMappingFramework] | None
union_of: str | SlotDefinitionName | list[str | SlotDefinitionName] | None
unit: dict | UnitOfMeasure | None = None
usage_slot_name: str | None = None
value_presence: str | PresenceEnum | None = None
class linkml_runtime.linkml_model.meta.TypeDefinition(*args, _if_missing: Callable[[JsonObj, str], Tuple[bool, Any]] = None, **kwargs)[source]

an element that whose instances are atomic scalar values that can be mapped to primitive types

all_of: dict | AnonymousTypeExpression | list[dict | AnonymousTypeExpression] | None
any_of: dict | AnonymousTypeExpression | list[dict | AnonymousTypeExpression] | None
base: str | None = None
class_class_curie: ClassVar[str] = 'linkml:TypeDefinition'
class_class_uri: ClassVar[URIRef] = rdflib.term.URIRef('https://w3id.org/linkml/TypeDefinition')
class_model_uri: ClassVar[URIRef] = rdflib.term.URIRef('https://w3id.org/linkml/TypeDefinition')
class_name: ClassVar[str] = 'type_definition'
equals_number: int | None = None
equals_string: str | None = None
equals_string_in: str | list[str] | None
exactly_one_of: dict | AnonymousTypeExpression | list[dict | AnonymousTypeExpression] | None
implicit_prefix: str | None = None
maximum_value: dict | Any | None = None
minimum_value: dict | Any | None = None
name: str | TypeDefinitionName = None
none_of: dict | AnonymousTypeExpression | list[dict | AnonymousTypeExpression] | None
pattern: str | None = None
repr: str | None = None
structured_pattern: dict | PatternExpression | None = None
typeof: str | TypeDefinitionName | None = None
union_of: str | TypeDefinitionName | list[str | TypeDefinitionName] | None
unit: dict | UnitOfMeasure | None = None
uri: str | URIorCURIE | None = None
class linkml_runtime.linkml_model.meta.EnumDefinition(*args, _if_missing: Callable[[JsonObj, str], Tuple[bool, Any]] = None, **kwargs)[source]

an element whose instances must be drawn from a specified set of permissible values

class_class_curie: ClassVar[str] = 'linkml:EnumDefinition'
class_class_uri: ClassVar[URIRef] = rdflib.term.URIRef('https://w3id.org/linkml/EnumDefinition')
class_model_uri: ClassVar[URIRef] = rdflib.term.URIRef('https://w3id.org/linkml/EnumDefinition')
class_name: ClassVar[str] = 'enum_definition'
code_set: str | URIorCURIE | None = None
code_set_tag: str | None = None
code_set_version: str | None = None
concepts: str | URIorCURIE | list[str | URIorCURIE] | None
enum_uri: str | URIorCURIE | None = None
include: dict | AnonymousEnumExpression | list[dict | AnonymousEnumExpression] | None
inherits: str | EnumDefinitionName | list[str | EnumDefinitionName] | None
matches: dict | MatchQuery | None = None
minus: dict | AnonymousEnumExpression | list[dict | AnonymousEnumExpression] | None
name: str | EnumDefinitionName = None
permissible_values: dict[str | PermissibleValueText, dict | PermissibleValue] | list[dict | PermissibleValue] | None
pv_formula: str | PvFormulaOptions | None = None
reachable_from: dict | ReachabilityQuery | None = None

Arrays

class linkml_runtime.linkml_model.meta.ArrayExpression(*args, _if_missing: Callable[[JsonObj, str], Tuple[bool, Any]] = None, **kwargs)[source]

defines the dimensions of an array

aliases: str | list[str] | None
alt_descriptions: dict[str | AltDescriptionSource, dict | AltDescription] | list[dict | AltDescription] | None
annotations: dict[str | AnnotationTag, dict | Annotation] | list[dict | Annotation] | None
broad_mappings: str | URIorCURIE | list[str | URIorCURIE] | None
categories: str | URIorCURIE | list[str | URIorCURIE] | None
class_class_curie: ClassVar[str] = 'linkml:ArrayExpression'
class_class_uri: ClassVar[URIRef] = rdflib.term.URIRef('https://w3id.org/linkml/ArrayExpression')
class_model_uri: ClassVar[URIRef] = rdflib.term.URIRef('https://w3id.org/linkml/ArrayExpression')
class_name: ClassVar[str] = 'array_expression'
close_mappings: str | URIorCURIE | list[str | URIorCURIE] | None
comments: str | list[str] | None
contributors: str | URIorCURIE | list[str | URIorCURIE] | None
created_by: str | URIorCURIE | None = None
created_on: str | XSDDateTime | None = None
deprecated: str | None = None
deprecated_element_has_exact_replacement: str | URIorCURIE | None = None
deprecated_element_has_possible_replacement: str | URIorCURIE | None = None
description: str | None = None
dimensions: dict | DimensionExpression | list[dict | DimensionExpression] | None
exact_mappings: str | URIorCURIE | list[str | URIorCURIE] | None
exact_number_dimensions: int | None = None
examples: dict | Example | list[dict | Example] | None
extensions: dict[str | ExtensionTag, dict | Extension] | list[dict | Extension] | None
from_schema: str | URI | None = None
imported_from: str | None = None
in_language: str | None = None
in_subset: str | SubsetDefinitionName | list[str | SubsetDefinitionName] | None
keywords: str | list[str] | None
last_updated_on: str | XSDDateTime | None = None
mappings: str | URIorCURIE | list[str | URIorCURIE] | None
maximum_number_dimensions: dict | Any | None = None
minimum_number_dimensions: int | None = None
modified_by: str | URIorCURIE | None = None
narrow_mappings: str | URIorCURIE | list[str | URIorCURIE] | None
notes: str | list[str] | None
rank: int | None = None
related_mappings: str | URIorCURIE | list[str | URIorCURIE] | None
see_also: str | URIorCURIE | list[str | URIorCURIE] | None
source: str | URIorCURIE | None = None
status: str | URIorCURIE | None = None
structured_aliases: dict | StructuredAlias | list[dict | StructuredAlias] | None
title: str | None = None
todos: str | list[str] | None
class linkml_runtime.linkml_model.meta.DimensionExpression(*args, _if_missing: Callable[[JsonObj, str], Tuple[bool, Any]] = None, **kwargs)[source]

defines one of the dimensions of an array

alias: str | None = None
aliases: str | list[str] | None
alt_descriptions: dict[str | AltDescriptionSource, dict | AltDescription] | list[dict | AltDescription] | None
annotations: dict[str | AnnotationTag, dict | Annotation] | list[dict | Annotation] | None
broad_mappings: str | URIorCURIE | list[str | URIorCURIE] | None
categories: str | URIorCURIE | list[str | URIorCURIE] | None
class_class_curie: ClassVar[str] = 'linkml:DimensionExpression'
class_class_uri: ClassVar[URIRef] = rdflib.term.URIRef('https://w3id.org/linkml/DimensionExpression')
class_model_uri: ClassVar[URIRef] = rdflib.term.URIRef('https://w3id.org/linkml/DimensionExpression')
class_name: ClassVar[str] = 'dimension_expression'
close_mappings: str | URIorCURIE | list[str | URIorCURIE] | None
comments: str | list[str] | None
contributors: str | URIorCURIE | list[str | URIorCURIE] | None
created_by: str | URIorCURIE | None = None
created_on: str | XSDDateTime | None = None
deprecated: str | None = None
deprecated_element_has_exact_replacement: str | URIorCURIE | None = None
deprecated_element_has_possible_replacement: str | URIorCURIE | None = None
description: str | None = None
exact_cardinality: int | None = None
exact_mappings: str | URIorCURIE | list[str | URIorCURIE] | None
examples: dict | Example | list[dict | Example] | None
extensions: dict[str | ExtensionTag, dict | Extension] | list[dict | Extension] | None
from_schema: str | URI | None = None
imported_from: str | None = None
in_language: str | None = None
in_subset: str | SubsetDefinitionName | list[str | SubsetDefinitionName] | None
keywords: str | list[str] | None
last_updated_on: str | XSDDateTime | None = None
mappings: str | URIorCURIE | list[str | URIorCURIE] | None
maximum_cardinality: int | None = None
minimum_cardinality: int | None = None
modified_by: str | URIorCURIE | None = None
narrow_mappings: str | URIorCURIE | list[str | URIorCURIE] | None
notes: str | list[str] | None
rank: int | None = None
related_mappings: str | URIorCURIE | list[str | URIorCURIE] | None
see_also: str | URIorCURIE | list[str | URIorCURIE] | None
source: str | URIorCURIE | None = None
status: str | URIorCURIE | None = None
structured_aliases: dict | StructuredAlias | list[dict | StructuredAlias] | None
title: str | None = None
todos: str | list[str] | None