Class: ClassRule
A rule that applies to instances of a class
URI: linkml:ClassRule
classDiagram
class ClassRule
Extensible <|-- ClassRule
Annotatable <|-- ClassRule
CommonMetadata <|-- ClassRule
ClassLevelRule <|-- ClassRule
ClassRule : aliases
ClassRule : alt_descriptions
ClassRule --> alt_description : alt_descriptions
ClassRule : annotations
ClassRule --> annotation : annotations
ClassRule : bidirectional
ClassRule : broad_mappings
ClassRule : categories
ClassRule : close_mappings
ClassRule : comments
ClassRule : contributors
ClassRule : created_by
ClassRule : created_on
ClassRule : deactivated
ClassRule : deprecated
ClassRule : deprecated_element_has_exact_replacement
ClassRule : deprecated_element_has_possible_replacement
ClassRule : description
ClassRule : elseconditions
ClassRule --> anonymous_class_expression : elseconditions
ClassRule : exact_mappings
ClassRule : examples
ClassRule --> example : examples
ClassRule : extensions
ClassRule --> extension : extensions
ClassRule : from_schema
ClassRule : imported_from
ClassRule : in_language
ClassRule : in_subset
ClassRule --> subset_definition : in_subset
ClassRule : keywords
ClassRule : last_updated_on
ClassRule : mappings
ClassRule : modified_by
ClassRule : narrow_mappings
ClassRule : notes
ClassRule : open_world
ClassRule : postconditions
ClassRule --> anonymous_class_expression : postconditions
ClassRule : preconditions
ClassRule --> anonymous_class_expression : preconditions
ClassRule : rank
ClassRule : related_mappings
ClassRule : see_also
ClassRule : source
ClassRule : status
ClassRule : structured_aliases
ClassRule --> structured_alias : structured_aliases
ClassRule : title
ClassRule : todos
Inheritance
- ClassLevelRule
- ClassRule [ Extensible Annotatable CommonMetadata]
Slots
Name | Cardinality and Range | Description | Inheritance |
---|---|---|---|
preconditions | 0..1 AnonymousClassExpression |
an expression that must hold in order for the rule to be applicable to an ins... | direct |
postconditions | 0..1 AnonymousClassExpression |
an expression that must hold for an instance of the class, if the preconditio... | direct |
elseconditions | 0..1 AnonymousClassExpression |
an expression that must hold for an instance of the class, if the preconditio... | direct |
bidirectional | 0..1 Boolean |
in addition to preconditions entailing postconditions, the postconditions ent... | direct |
open_world | 0..1 Boolean |
if true, the the postconditions may be omitted in instance data, but it is va... | direct |
rank | 0..1 Integer |
the relative order in which the element occurs, lower values are given preced... | direct |
deactivated | 0..1 Boolean |
a deactivated rule is not executed by the rules engine | direct |
extensions | 0..* Extension |
a tag/text tuple attached to an arbitrary element | Extensible |
annotations | 0..* Annotation |
a collection of tag/text tuples with the semantics of OWL Annotation | Annotatable |
description | 0..1 recommended String |
a textual description of the element's purpose and use | CommonMetadata |
alt_descriptions | 0..* AltDescription |
A sourced alternative description for an element | CommonMetadata |
title | 0..1 String |
A concise human-readable display label for the element | CommonMetadata |
deprecated | 0..1 String |
Description of why and when this element will no longer be used | CommonMetadata |
todos | 0..* String |
Outstanding issues that needs resolution | CommonMetadata |
notes | 0..* String |
editorial notes about an element intended primarily for internal consumption | CommonMetadata |
comments | 0..* String |
notes and comments about an element intended primarily for external consumpti... | CommonMetadata |
examples | 0..* Example |
example usages of an element | CommonMetadata |
in_subset | 0..* SubsetDefinition |
used to indicate membership of a term in a defined subset of terms used for a... | CommonMetadata |
from_schema | 0..1 Uri |
id of the schema that defined the element | CommonMetadata |
imported_from | 0..1 String |
the imports entry that this element was derived from | CommonMetadata |
source | 0..1 Uriorcurie |
A related resource from which the element is derived | CommonMetadata |
in_language | 0..1 String |
the primary language used in the sources | CommonMetadata |
see_also | 0..* Uriorcurie |
A list of related entities or URLs that may be of relevance | CommonMetadata |
deprecated_element_has_exact_replacement | 0..1 Uriorcurie |
When an element is deprecated, it can be automatically replaced by this uri o... | CommonMetadata |
deprecated_element_has_possible_replacement | 0..1 Uriorcurie |
When an element is deprecated, it can be potentially replaced by this uri or ... | CommonMetadata |
aliases | 0..* String |
Alternate names/labels for the element | CommonMetadata |
structured_aliases | 0..* StructuredAlias |
A list of structured_alias objects, used to provide aliases in conjunction wi... | CommonMetadata |
mappings | 0..* Uriorcurie |
A list of terms from different schemas or terminology systems that have compa... | CommonMetadata |
exact_mappings | 0..* Uriorcurie |
A list of terms from different schemas or terminology systems that have ident... | CommonMetadata |
close_mappings | 0..* Uriorcurie |
A list of terms from different schemas or terminology systems that have close... | CommonMetadata |
related_mappings | 0..* Uriorcurie |
A list of terms from different schemas or terminology systems that have relat... | CommonMetadata |
narrow_mappings | 0..* Uriorcurie |
A list of terms from different schemas or terminology systems that have narro... | CommonMetadata |
broad_mappings | 0..* Uriorcurie |
A list of terms from different schemas or terminology systems that have broad... | CommonMetadata |
created_by | 0..1 Uriorcurie |
agent that created the element | CommonMetadata |
contributors | 0..* Uriorcurie |
agent that contributed to the element | CommonMetadata |
created_on | 0..1 Datetime |
time at which the element was created | CommonMetadata |
last_updated_on | 0..1 Datetime |
time at which the element was last updated | CommonMetadata |
modified_by | 0..1 Uriorcurie |
agent that modified the element | CommonMetadata |
status | 0..1 Uriorcurie |
status of the element | CommonMetadata |
categories | 0..* Uriorcurie |
Controlled terms used to categorize an element | CommonMetadata |
keywords | 0..* String |
Keywords or tags used to describe the element | CommonMetadata |
Usages
used by | used in | type | used |
---|---|---|---|
ClassDefinition | rules | range | ClassRule |
Aliases
- if rule
Identifier and Mapping Information
Schema Source
- from schema: https://w3id.org/linkml/meta
Mappings
Mapping Type | Mapped Value |
---|---|
self | linkml:ClassRule |
native | linkml:ClassRule |
close | sh:TripleRule, swrl:Imp |
LinkML Source
Direct
name: class_rule
description: A rule that applies to instances of a class
in_subset:
- SpecificationSubset
from_schema: https://w3id.org/linkml/meta
aliases:
- if rule
close_mappings:
- sh:TripleRule
- swrl:Imp
is_a: class_level_rule
mixins:
- extensible
- annotatable
- common_metadata
slots:
- preconditions
- postconditions
- elseconditions
- bidirectional
- open_world
- rank
- deactivated
Induced
name: class_rule
description: A rule that applies to instances of a class
in_subset:
- SpecificationSubset
from_schema: https://w3id.org/linkml/meta
aliases:
- if rule
close_mappings:
- sh:TripleRule
- swrl:Imp
is_a: class_level_rule
mixins:
- extensible
- annotatable
- common_metadata
attributes:
preconditions:
name: preconditions
description: an expression that must hold in order for the rule to be applicable
to an instance
in_subset:
- SpecificationSubset
from_schema: https://w3id.org/linkml/meta
see_also:
- https://w3id.org/linkml/docs/specification/05validation/#rules
aliases:
- if
- body
- antecedents
close_mappings:
- swrl:body
rank: 111
slot_uri: sh:condition
alias: preconditions
owner: class_rule
domain_of:
- class_rule
range: anonymous_class_expression
inlined: true
postconditions:
name: postconditions
description: an expression that must hold for an instance of the class, if the
preconditions hold
in_subset:
- SpecificationSubset
from_schema: https://w3id.org/linkml/meta
see_also:
- https://w3id.org/linkml/docs/specification/05validation/#rules
aliases:
- then
- head
- consequents
close_mappings:
- swrl:body
rank: 113
alias: postconditions
owner: class_rule
domain_of:
- class_rule
range: anonymous_class_expression
inlined: true
elseconditions:
name: elseconditions
description: an expression that must hold for an instance of the class, if the
preconditions no not hold
in_subset:
- SpecificationSubset
from_schema: https://w3id.org/linkml/meta
see_also:
- https://w3id.org/linkml/docs/specification/05validation/#rules
aliases:
- else
rank: 115
alias: elseconditions
owner: class_rule
domain_of:
- class_rule
range: anonymous_class_expression
inlined: true
bidirectional:
name: bidirectional
description: in addition to preconditions entailing postconditions, the postconditions
entail the preconditions
in_subset:
- SpecificationSubset
from_schema: https://w3id.org/linkml/meta
aliases:
- iff
- if and only if
rank: 1000
alias: bidirectional
owner: class_rule
domain_of:
- class_rule
range: boolean
open_world:
name: open_world
description: if true, the the postconditions may be omitted in instance data,
but it is valid for an inference engine to add these
in_subset:
- SpecificationSubset
from_schema: https://w3id.org/linkml/meta
rank: 1000
alias: open_world
owner: class_rule
domain_of:
- class_rule
range: boolean
rank:
name: rank
description: the relative order in which the element occurs, lower values are
given precedence
comments:
- the rank of an element does not affect the semantics
in_subset:
- SpecificationSubset
- BasicSubset
from_schema: https://w3id.org/linkml/meta
aliases:
- order
- precedence
- display order
exact_mappings:
- qudt:order
- qb:order
rank: 51
slot_uri: sh:order
alias: rank
owner: class_rule
domain_of:
- common_metadata
- class_rule
range: integer
deactivated:
name: deactivated
description: a deactivated rule is not executed by the rules engine
from_schema: https://w3id.org/linkml/meta
rank: 1000
slot_uri: sh:deactivated
alias: deactivated
owner: class_rule
domain_of:
- class_rule
range: boolean
extensions:
name: extensions
description: a tag/text tuple attached to an arbitrary element
from_schema: https://w3id.org/linkml/meta
rank: 1000
domain: extensible
multivalued: true
alias: extensions
owner: class_rule
domain_of:
- extension
- extensible
range: extension
inlined: true
annotations:
name: annotations
description: a collection of tag/text tuples with the semantics of OWL Annotation
from_schema: https://w3id.org/linkml/meta
rank: 1000
is_a: extensions
domain: annotatable
multivalued: true
alias: annotations
owner: class_rule
domain_of:
- annotatable
- annotation
range: annotation
inlined: true
description:
name: description
description: a textual description of the element's purpose and use
in_subset:
- BasicSubset
from_schema: https://w3id.org/linkml/meta
aliases:
- definition
exact_mappings:
- dcterms:description
- schema:description
rank: 5
domain: element
slot_uri: skos:definition
alias: description
owner: class_rule
domain_of:
- common_metadata
- permissible_value
range: string
recommended: true
alt_descriptions:
name: alt_descriptions
description: A sourced alternative description for an element
in_subset:
- BasicSubset
from_schema: https://w3id.org/linkml/meta
aliases:
- alternate definitions
rank: 1000
domain: element
multivalued: true
alias: alt_descriptions
owner: class_rule
domain_of:
- common_metadata
range: alt_description
inlined: true
title:
name: title
description: A concise human-readable display label for the element. The title
should mirror the name, and should use ordinary textual punctuation.
in_subset:
- BasicSubset
from_schema: https://w3id.org/linkml/meta
aliases:
- long name
rank: 3
domain: element
slot_uri: dcterms:title
alias: title
owner: class_rule
domain_of:
- common_metadata
range: string
deprecated:
name: deprecated
description: Description of why and when this element will no longer be used
comments:
- note that linkml does not use a boolean to indicate deprecation status - the
presence of a string value in this field is sufficient to indicate deprecation.
in_subset:
- BasicSubset
from_schema: https://w3id.org/linkml/meta
close_mappings:
- owl:deprecated
rank: 1000
domain: element
alias: deprecated
owner: class_rule
domain_of:
- common_metadata
range: string
todos:
name: todos
description: Outstanding issues that needs resolution
in_subset:
- BasicSubset
from_schema: https://w3id.org/linkml/meta
rank: 1000
domain: element
multivalued: true
alias: todos
owner: class_rule
domain_of:
- common_metadata
range: string
notes:
name: notes
description: editorial notes about an element intended primarily for internal
consumption
in_subset:
- BasicSubset
from_schema: https://w3id.org/linkml/meta
rank: 1000
domain: element
slot_uri: skos:editorialNote
multivalued: true
alias: notes
owner: class_rule
domain_of:
- common_metadata
range: string
comments:
name: comments
description: notes and comments about an element intended primarily for external
consumption
in_subset:
- BasicSubset
from_schema: https://w3id.org/linkml/meta
exact_mappings:
- rdfs:comment
rank: 1000
domain: element
slot_uri: skos:note
multivalued: true
alias: comments
owner: class_rule
domain_of:
- common_metadata
range: string
examples:
name: examples
description: example usages of an element
in_subset:
- BasicSubset
from_schema: https://w3id.org/linkml/meta
close_mappings:
- vann:example
rank: 1000
singular_name: example
domain: element
multivalued: true
alias: examples
owner: class_rule
domain_of:
- common_metadata
range: example
inlined: true
in_subset:
name: in_subset
description: used to indicate membership of a term in a defined subset of terms
used for a particular domain or application.
comments:
- an example of use in the translator_minimal subset in the biolink model, holding
the minimal set of predicates used in a translator knowledge graph
in_subset:
- BasicSubset
from_schema: https://w3id.org/linkml/meta
rank: 1000
domain: element
slot_uri: OIO:inSubset
multivalued: true
alias: in_subset
owner: class_rule
domain_of:
- common_metadata
range: subset_definition
from_schema:
name: from_schema
description: id of the schema that defined the element
notes:
- A stronger model would be range schema_definition, but this doesn't address
the import model
in_subset:
- SpecificationSubset
from_schema: https://w3id.org/linkml/meta
rank: 1000
domain: element
slot_uri: skos:inScheme
readonly: supplied by the schema loader or schema view
alias: from_schema
owner: class_rule
domain_of:
- common_metadata
range: uri
imported_from:
name: imported_from
description: the imports entry that this element was derived from. Empty means
primary source
from_schema: https://w3id.org/linkml/meta
rank: 1000
domain: element
readonly: supplied by the schema loader or schema view
alias: imported_from
owner: class_rule
domain_of:
- common_metadata
range: string
source:
name: source
description: A related resource from which the element is derived.
comments:
- The described resource may be derived from the related resource in whole or
in part
in_subset:
- BasicSubset
from_schema: https://w3id.org/linkml/meta
aliases:
- origin
- derived from
close_mappings:
- prov:wasDerivedFrom
- schema:isBasedOn
rank: 1000
domain: element
slot_uri: dcterms:source
alias: source
owner: class_rule
domain_of:
- common_metadata
range: uriorcurie
in_language:
name: in_language
conforms_to: https://www.rfc-editor.org/rfc/bcp/bcp47.txt
description: the primary language used in the sources
comments:
- Recommended to use a string from IETF BCP 47
from_schema: https://w3id.org/linkml/meta
rank: 1000
slot_uri: schema:inLanguage
alias: in_language
owner: class_rule
domain_of:
- common_metadata
range: string
see_also:
name: see_also
description: A list of related entities or URLs that may be of relevance
in_subset:
- BasicSubset
from_schema: https://w3id.org/linkml/meta
rank: 1000
domain: element
slot_uri: rdfs:seeAlso
multivalued: true
alias: see_also
owner: class_rule
domain_of:
- common_metadata
range: uriorcurie
deprecated element has exact replacement:
name: deprecated element has exact replacement
description: When an element is deprecated, it can be automatically replaced by
this uri or curie
from_schema: https://w3id.org/linkml/meta
mappings:
- IAO:0100001
rank: 1000
alias: deprecated_element_has_exact_replacement
owner: class_rule
domain_of:
- common_metadata
range: uriorcurie
deprecated element has possible replacement:
name: deprecated element has possible replacement
description: When an element is deprecated, it can be potentially replaced by
this uri or curie
from_schema: https://w3id.org/linkml/meta
mappings:
- OIO:consider
rank: 1000
alias: deprecated_element_has_possible_replacement
owner: class_rule
domain_of:
- common_metadata
range: uriorcurie
aliases:
name: aliases
description: Alternate names/labels for the element. These do not alter the semantics
of the schema, but may be useful to support search and alignment.
comments:
- not be confused with the metaslot alias.
in_subset:
- BasicSubset
from_schema: https://w3id.org/linkml/meta
aliases:
- synonyms
- alternate names
- alternative labels
- designations
exact_mappings:
- schema:alternateName
rank: 1000
domain: element
slot_uri: skos:altLabel
multivalued: true
alias: aliases
owner: class_rule
domain_of:
- common_metadata
range: string
structured_aliases:
name: structured_aliases
description: A list of structured_alias objects, used to provide aliases in conjunction
with additional metadata.
from_schema: https://w3id.org/linkml/meta
see_also:
- linkml:aliases
rank: 1000
slot_uri: skosxl:altLabel
multivalued: true
alias: structured_aliases
owner: class_rule
domain_of:
- common_metadata
range: structured_alias
inlined: true
mappings:
name: mappings
description: A list of terms from different schemas or terminology systems that
have comparable meaning. These may include terms that are precisely equivalent,
broader or narrower in meaning, or otherwise semantically related but not equivalent
from a strict ontological perspective.
from_schema: https://w3id.org/linkml/meta
aliases:
- xrefs
- identifiers
- alternate identifiers
- alternate ids
rank: 1000
slot_uri: skos:mappingRelation
multivalued: true
alias: mappings
owner: class_rule
domain_of:
- common_metadata
range: uriorcurie
exact mappings:
name: exact mappings
description: A list of terms from different schemas or terminology systems that
have identical meaning.
from_schema: https://w3id.org/linkml/meta
rank: 1000
is_a: mappings
slot_uri: skos:exactMatch
multivalued: true
inherited: false
alias: exact_mappings
owner: class_rule
domain_of:
- common_metadata
- UnitOfMeasure
range: uriorcurie
close mappings:
name: close mappings
description: A list of terms from different schemas or terminology systems that
have close meaning.
from_schema: https://w3id.org/linkml/meta
rank: 1000
is_a: mappings
slot_uri: skos:closeMatch
multivalued: true
inherited: false
alias: close_mappings
owner: class_rule
domain_of:
- common_metadata
range: uriorcurie
related mappings:
name: related mappings
description: A list of terms from different schemas or terminology systems that
have related meaning.
from_schema: https://w3id.org/linkml/meta
rank: 1000
is_a: mappings
slot_uri: skos:relatedMatch
multivalued: true
inherited: false
alias: related_mappings
owner: class_rule
domain_of:
- common_metadata
range: uriorcurie
narrow mappings:
name: narrow mappings
description: A list of terms from different schemas or terminology systems that
have narrower meaning.
from_schema: https://w3id.org/linkml/meta
rank: 1000
is_a: mappings
slot_uri: skos:narrowMatch
multivalued: true
inherited: false
alias: narrow_mappings
owner: class_rule
domain_of:
- common_metadata
range: uriorcurie
broad mappings:
name: broad mappings
description: A list of terms from different schemas or terminology systems that
have broader meaning.
from_schema: https://w3id.org/linkml/meta
rank: 1000
is_a: mappings
slot_uri: skos:broadMatch
multivalued: true
inherited: false
alias: broad_mappings
owner: class_rule
domain_of:
- common_metadata
range: uriorcurie
created_by:
name: created_by
description: agent that created the element
in_subset:
- BasicSubset
from_schema: https://w3id.org/linkml/meta
rank: 1000
domain: element
slot_uri: pav:createdBy
alias: created_by
owner: class_rule
domain_of:
- common_metadata
range: uriorcurie
contributors:
name: contributors
description: agent that contributed to the element
in_subset:
- BasicSubset
from_schema: https://w3id.org/linkml/meta
rank: 1000
domain: element
slot_uri: dcterms:contributor
multivalued: true
alias: contributors
owner: class_rule
domain_of:
- common_metadata
range: uriorcurie
created_on:
name: created_on
description: time at which the element was created
in_subset:
- BasicSubset
from_schema: https://w3id.org/linkml/meta
rank: 1000
domain: element
slot_uri: pav:createdOn
alias: created_on
owner: class_rule
domain_of:
- common_metadata
range: datetime
last_updated_on:
name: last_updated_on
description: time at which the element was last updated
in_subset:
- BasicSubset
from_schema: https://w3id.org/linkml/meta
rank: 1000
domain: element
slot_uri: pav:lastUpdatedOn
alias: last_updated_on
owner: class_rule
domain_of:
- common_metadata
range: datetime
modified_by:
name: modified_by
description: agent that modified the element
in_subset:
- BasicSubset
from_schema: https://w3id.org/linkml/meta
rank: 1000
domain: element
slot_uri: oslc:modifiedBy
alias: modified_by
owner: class_rule
domain_of:
- common_metadata
range: uriorcurie
status:
name: status
description: status of the element
examples:
- value: bibo:draft
in_subset:
- BasicSubset
from_schema: https://w3id.org/linkml/meta
see_also:
- https://www.hl7.org/fhir/valueset-publication-status.html
- https://www.hl7.org/fhir/versions.html#std-process
aliases:
- workflow status
rank: 1000
domain: element
slot_uri: bibo:status
alias: status
owner: class_rule
domain_of:
- common_metadata
range: uriorcurie
categories:
name: categories
description: Controlled terms used to categorize an element.
comments:
- if you wish to use uncontrolled terms or terms that lack identifiers then use
the keywords element
in_subset:
- BasicSubset
from_schema: https://w3id.org/linkml/meta
rank: 1000
singular_name: category
slot_uri: dcterms:subject
multivalued: true
alias: categories
owner: class_rule
domain_of:
- common_metadata
- structured_alias
range: uriorcurie
keywords:
name: keywords
description: Keywords or tags used to describe the element
in_subset:
- BasicSubset
from_schema: https://w3id.org/linkml/meta
rank: 1000
singular_name: keyword
domain: element
slot_uri: schema:keywords
multivalued: true
alias: keywords
owner: class_rule
domain_of:
- common_metadata
range: string