Skip to content

Slot: string_serialization

Used on a slot that stores the string serialization of the containing object. The syntax follows python formatted strings, with slot names enclosed in {}s. These are expanded using the values of those slots. We call the slot with the serialization the s-slot, the slots used in the {}s are v-slots. If both s-slots and v-slots are populated on an object then the value of the s-slot should correspond to the expansion. Implementations of frameworks may choose to use this property to either (a) PARSE: implement automated normalizations by parsing denormalized strings into complex objects (b) GENERARE: implement automated to_string labeling of complex objects For example, a Measurement class may have 3 fields: unit, value, and string_value. The string_value slot may have a string_serialization of {value}{unit} such that if unit=cm and value=2, the value of string_value shouldd be 2cm

URI: linkml:string_serialization

Applicable Classes

Name Description
Definition abstract base class for core metaclasses
EnumDefinition an element whose instances must be drawn from a specified set of permissible ...
SlotDefinition an element that describes how instances are related to other instances
ClassDefinition an element whose instances are complex objects that may have slot-value assig...

Properties

See Also

Identifier and Mapping Information

Schema Source

  • from schema: https://w3id.org/linkml/meta

LinkML Source

name: string_serialization
description: 'Used on a slot that stores the string serialization of the containing
  object. The syntax follows python formatted strings, with slot names enclosed in
  {}s. These are expanded using the values of those slots.

  We call the slot with the serialization the s-slot, the slots used in the {}s are
  v-slots. If both s-slots and v-slots are populated on an object then the value of
  the s-slot should correspond to the expansion.

  Implementations of frameworks may choose to use this property to either (a) PARSE:
  implement automated normalizations by parsing denormalized strings into complex
  objects (b) GENERARE: implement automated to_string labeling of complex objects

  For example, a Measurement class may have 3 fields: unit, value, and string_value.
  The string_value slot may have a string_serialization of {value}{unit} such that
  if unit=cm and value=2, the value of string_value shouldd be 2cm'
in_subset:
- SpecificationSubset
from_schema: https://w3id.org/linkml/meta
see_also:
- https://github.com/linkml/issues/128
rank: 1000
domain: definition
inherited: false
alias: string_serialization
domain_of:
- definition
range: string