Skip to content

Commit 3fb67c7

Browse files
authored
Merge pull request #137 from linkml/ifabsent_documentation
Update ifabsent documentation.
2 parents b16a1cd + 67cd2e9 commit 3fb67c7

File tree

2 files changed

+150
-43
lines changed

2 files changed

+150
-43
lines changed

linkml_model/model/schema/meta.yaml

Lines changed: 45 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ description: |-
2828
For canonical reference documentation on any metamodel construct,
2929
refer to the official URI for each construct, e.g.
3030
[https://w3id.org/linkml/is_a](https://w3id.org/linkml/is_a)
31-
31+
3232
license: https://creativecommons.org/publicdomain/zero/1.0/
3333
version: 2.0.0
3434

@@ -74,7 +74,7 @@ imports:
7474
- linkml:annotations
7575
# - linkml:validation
7676
- linkml:units
77-
77+
7878
subsets:
7979
MinimalSubset:
8080
rank: 0
@@ -412,7 +412,7 @@ slots:
412412
range: string
413413
notes:
414414
- Use a string from IETF BCP 47
415-
415+
416416
source:
417417
aliases:
418418
- origin
@@ -590,7 +590,7 @@ slots:
590590
in_subset:
591591
- SpecificationSubset
592592
- BasicSubset
593-
593+
594594
include:
595595
description: An enum expression that yields a list of permissible values that are to be included, after subtracting the minus set
596596
domain: enum_expression
@@ -630,15 +630,15 @@ slots:
630630
range: string
631631
in_subset:
632632
- SpecificationSubset
633-
633+
634634
concepts:
635635
description: A list of identifiers that are used to construct a set of permissible values
636636
domain: enum_expression
637637
range: uriorcurie
638638
multivalued: true
639639
in_subset:
640640
- SpecificationSubset
641-
641+
642642
reachable_from:
643643
description: Specifies a query for obtaining a list of permissible values based on graph reachability
644644
domain: enum_expression
@@ -654,7 +654,7 @@ slots:
654654
range: uriorcurie
655655
in_subset:
656656
- SpecificationSubset
657-
657+
658658
is_direct:
659659
aliases:
660660
- non-transitive
@@ -975,7 +975,7 @@ slots:
975975
- one use for this is being able to describe a range using any_of expressions, for example to combine two enums
976976
in_subset:
977977
- SpecificationSubset
978-
978+
979979
boolean_slot:
980980
abstract: true
981981
multivalued: true
@@ -991,7 +991,7 @@ slots:
991991
- sh:or
992992
in_subset:
993993
- SpecificationSubset
994-
994+
995995
exactly_one_of:
996996
rank: 103
997997
description: holds if only one of the expressions hold
@@ -1001,7 +1001,7 @@ slots:
10011001
- sh:xone
10021002
in_subset:
10031003
- SpecificationSubset
1004-
1004+
10051005
none_of:
10061006
rank: 105
10071007
description: holds if none of the expressions hold
@@ -1011,7 +1011,7 @@ slots:
10111011
- sh:not
10121012
in_subset:
10131013
- SpecificationSubset
1014-
1014+
10151015
all_of:
10161016
rank: 107
10171017
description: holds if all of the expressions hold
@@ -1098,7 +1098,7 @@ slots:
10981098
description: a deactivated rule is not executed by the rules engine
10991099
slot_uri: sh:deactivated
11001100
range: boolean
1101-
1101+
11021102
rules:
11031103
slot_uri: sh:rule
11041104
domain: class_definition
@@ -1126,7 +1126,7 @@ slots:
11261126
description: expresses constraints on a group of slots for a class expression
11271127
in_subset:
11281128
- SpecificationSubset
1129-
1129+
11301130
attributes:
11311131
rank: 29
11321132
domain: class_definition
@@ -1218,7 +1218,7 @@ slots:
12181218
- SpecificationSubset
12191219
- BasicSubset
12201220
- RelationalModelProfile
1221-
1221+
12221222
unique_key_slots:
12231223
domain: unique_key
12241224
multivalued: true
@@ -1229,12 +1229,12 @@ slots:
12291229
- SpecificationSubset
12301230
- BasicSubset
12311231
- RelationalModelProfile
1232-
1232+
12331233
slot_names_unique:
12341234
domain: definition
12351235
range: boolean
12361236
description: if true then induced/mangled slot names are not created for class_usage and attributes
1237-
1237+
12381238

12391239
# -----------------------------------
12401240
# Slot definition slots
@@ -1329,16 +1329,18 @@ slots:
13291329
inherited: true
13301330
description: |-
13311331
function that provides a default value for the slot. Possible values for this slot are defined in
1332-
linkml_runtime.utils.ifabsent_functions.default_library:
1332+
linkml.utils.ifabsent_functions.default_library:
13331333
* [Tt]rue -- boolean True
13341334
* [Ff]alse -- boolean False
1335-
* int(value) -- integer value
1336-
* str(value) -- string value
1337-
* default_range -- schema default range
13381335
* bnode -- blank node identifier
1339-
* slot_uri -- URI for the slot
13401336
* class_curie -- CURIE for the containing class
13411337
* class_uri -- URI for the containing class
1338+
* default_ns -- schema default namespace
1339+
* default_range -- schema default range
1340+
* int(value) -- integer value
1341+
* slot_uri -- URI for the slot
1342+
* slot_curie -- CURIE for the slot
1343+
* string(value) -- string value
13421344
close_mappings:
13431345
- sh:defaultValue
13441346
in_subset:
@@ -1356,12 +1358,12 @@ slots:
13561358
abstract: true
13571359
description: Grouping for metamodel slots that constrain the a slot value to equal a specified constant
13581360
status: testing
1359-
1361+
13601362
list_value_specification_constant:
13611363
abstract: true
13621364
description: Grouping for metamodel slots that constrain members of a multivalued slot value to equal a specified constant
13631365
status: testing
1364-
1366+
13651367
value_presence:
13661368
is_a: list_value_specification_constant
13671369
domain: slot_definition
@@ -1379,7 +1381,7 @@ slots:
13791381
description: the slot must have range string and the value of the slot must equal the specified value
13801382
in_subset:
13811383
- SpecificationSubset
1382-
1384+
13831385
equals_number:
13841386
is_a: list_value_specification_constant
13851387
range: integer ## todo, make the range a union
@@ -1438,7 +1440,7 @@ slots:
14381440
status: testing
14391441
in_subset:
14401442
- SpecificationSubset
1441-
1443+
14421444
has_member:
14431445
is_a: list_value_specification_constant
14441446
range: anonymous_slot_expression
@@ -1545,7 +1547,7 @@ slots:
15451547
- should only be used with multivalued slots
15461548
in_subset:
15471549
- SpecificationSubset
1548-
1550+
15491551
list_elements_unique:
15501552
domain: slot_definition
15511553
range: boolean
@@ -1568,7 +1570,7 @@ slots:
15681570
If True, then the relationship between the slot domain and range is many to one or many to many
15691571
in_subset:
15701572
- SpecificationSubset
1571-
1573+
15721574
key:
15731575
domain: slot_definition
15741576
range: boolean
@@ -1705,7 +1707,7 @@ slots:
17051707
- owl:SymmetricProperty
17061708
in_subset:
17071709
- SpecificationSubset
1708-
1710+
17091711
asymmetric:
17101712
is_a: relational_logical_characteristic
17111713
description: If s is antisymmetric, and i.s=v where i is different from v, v.s cannot have value i
@@ -1761,7 +1763,7 @@ slots:
17611763
description: transitive_form_of including the reflexive case
17621764
in_subset:
17631765
- SpecificationSubset
1764-
1766+
17651767
inverse:
17661768
domain: slot_definition
17671769
range: slot_definition
@@ -2055,7 +2057,7 @@ slots:
20552057
# -----------------------------------
20562058
# Slots for import expressions
20572059
# -----------------------------------
2058-
2060+
20592061
import_from:
20602062
domain: import_expression
20612063
required: true
@@ -2129,7 +2131,7 @@ slots:
21292131
description: a rule for inferring a slot assignment based on evaluating a path through a sequence of slot assignemnts
21302132
domain: slot_definition
21312133
range: path_expression
2132-
2134+
21332135
# -----------------------------------
21342136
# Relational Roles
21352137
# -----------------------------------
@@ -2148,7 +2150,7 @@ slots:
21482150
- in the context of Entity-Relationship (ER) modeling, this is used to state that a class models a relationship between entities, and should be drawn with a diamond
21492151
- in the context of RDF, this should be used when instances of the class are `rdf:Statement`s
21502152
- in the context of property graphs, this should be used when a class is used to represent an edge that connects nodes
2151-
2153+
21522154
relational_role:
21532155
aliases:
21542156
- reification_role
@@ -2162,7 +2164,7 @@ slots:
21622164
- in the context of RDF, this should be used for slots that can be modeled using the RDF reification vocabulary
21632165
- in the context of property graphs, this should be used on edge classes to indicate which slots represent the input and output nodes
21642166

2165-
2167+
21662168
#==================================
21672169
# Classes #
21682170
#==================================
@@ -2270,7 +2272,7 @@ classes:
22702272
- RelationalModelProfile
22712273
- ObjectOrientedProfile
22722274
- OwlProfile
2273-
2275+
22742276
type_expression:
22752277
is_a: expression
22762278
mixin: true
@@ -2301,7 +2303,7 @@ classes:
23012303
anonymous_type_expression:
23022304
mixins:
23032305
- type_expression
2304-
2306+
23052307
type_definition:
23062308
rank: 4
23072309
mixins:
@@ -2372,7 +2374,7 @@ classes:
23722374
description: An enum_expression that is not named
23732375
mixins:
23742376
- enum_expression
2375-
2377+
23762378
enum_definition:
23772379
rank: 5
23782380
aliases:
@@ -2405,7 +2407,7 @@ classes:
24052407
- source_ontology
24062408
in_subset:
24072409
- SpecificationSubset
2408-
2410+
24092411
reachability_query:
24102412
description: A query that is used on an enum expression to dynamically obtain a set of permissible values via walking from a set of source nodes to a set of descendants or ancestors over a set of relationship types
24112413
slots:
@@ -2417,7 +2419,7 @@ classes:
24172419
- traverse_up
24182420
in_subset:
24192421
- SpecificationSubset
2420-
2422+
24212423
structured_alias:
24222424
description: >-
24232425
object that contains meta data about a synonym or alias including where it came from (source)
@@ -2483,7 +2485,7 @@ classes:
24832485
range: path_expression
24842486
all_of:
24852487
range: path_expression
2486-
2488+
24872489
slot_expression:
24882490
description: an expression that constrains the range of values a slot can take
24892491
mixin: true
@@ -2531,7 +2533,7 @@ classes:
25312533
mixins:
25322534
- slot_expression
25332535
status: testing
2534-
2536+
25352537
slot_definition:
25362538
rank: 3
25372539
description: an element that describes how instances are related to other instances
@@ -2690,7 +2692,7 @@ classes:
26902692
abstract: true
26912693
description: A rule that is applied to classes
26922694
status: testing
2693-
2695+
26942696
class_rule:
26952697
is_a: class_level_rule
26962698
aliases:
@@ -2725,7 +2727,7 @@ classes:
27252727
- syntax
27262728
- interpolated
27272729
- partial_match
2728-
2730+
27292731
import_expression:
27302732
description: an expression describing an import
27312733
status: testing
@@ -2737,7 +2739,7 @@ classes:
27372739
- import_from
27382740
- import_as
27392741
- import_map
2740-
2742+
27412743
setting:
27422744
description: assignment of a key to a value
27432745
slots:

0 commit comments

Comments
 (0)