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 = None, **kwargs)

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 = None, **kwargs)

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 = None, **kwargs)

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 = None, **kwargs)

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 = None, **kwargs)

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 = None, **kwargs)

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 = None, **kwargs)

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