Basic Meta-Model (BMM)

Access to service interface to BMM object model.

List of directories where all the schemas loaded here are found.

All schemas found and loaded from schema_directories. Keyed by schema_id, i.e. model_publisher '' schema_name '' model_release, e.g. openehr_rm_1.0.3.

Top-level (root) models in use. Keyed by logical schema_name, i.e. model_publisher '_' model_name, e.g. "openehr_rm".

Initialise with a specific schema load list, usually a sub-set of schemas that will be found in the directories a_schema_dirs.

Initialise with all schemas found in the schema directories.

Reload all schemas.

Descriptor for a BMM schema. Contains a meta-data table of attributes obtained from a mini-ODIN parse of the schema file.

Persistent form of model.

Computable form of model.

Schema id, formed from meta_data model_publisher '' schema_name '' model_release, e.g. openehr_rm_1.0.3.

Table of \{key, value} pairs of schema meta-data (bmm_version, model_publisher, schema_name, model_release, schema_revision, schema_lifecycle_state, schema_description, schema_path).

Schema_ids of schemas included by this schema.

True if this is a top-level schema, i.e. not included by some other schema.

True if the BMM version found in the schema (or assumed, if none) is compatible with that in this software.

Load schema into in-memory form.

Validate entire schema.

Validate includes list for this schema, to see if each mentioned schema exists in read schemas.

Create schema.

Definitions used by all BMM packages.

Current internal version of BMM meta-model, used to determine if a given schema can be processed by a given implementation of the model.

Delimiter used to separate schema id from package path in a fully qualified path.

Delimiter used to separate package names in a package path.

Extension used for BMM files.

Ancestor class of most BMM model elements.

Optional documentation of this element.

Core properties of BMM_SCHEMA.

Publisher of model expressed in the schema. Persisted attribute.

Release of model expressed in the schema as a 3-part numeric, e.g. "3.1.0". Persisted attribute.

Name of model expressed in schema; a 'schema' usually contains all of the packages of one 'model' of a publisher. A publisher with more than one model can have multiple schemas. Persisted attribute.

Revision of schema. Persisted attribute.

Persisted attribute.

Primary author of schema. Persisted attribute.

Description of schema. Persisted attribute.

Contributing authors of schema. Persisted attribute.

Name of a parent class used within the schema to provide archetype capability, enabling filtering of classes in RM visualisation. If empty, 'Any' is assumed. Persisted attribute.

Name of a parent class of logical 'data types' used within the schema to provide archetype capability, enabling filtering of classes in RM visualisation. If empty, 'Any' is assumed. Persisted attribute.

List of top-level package paths that provide the RM 'model' part in archetype identifiers, e.g. the path "org.openehr.ehr" gives "EHR" in "openEHR-EHR". Within this namespace, archetypes can be based on any class reachable from classes defined directly in these packages. Persisted attribute.

If archetype_parent_class is not set, designate a class whose descendants should be made visible in tree and grid renderings of the archetype definition. Persisted attribute.

Derived name of schema, based on model publisher, model name, model release.

Model of a BMM schema (along with what is inherited from BMM_SCHEMA_CORE).

All classes in this schema.

List of keys in `class_definitions' of items marked as primitive types, as defined in input schema.

List of keys in `class_definitions' of items that are enumeration types, as defined in input schema.

Retrieve the class definition corresponding to `a_type_name' (which may contain a generic part).

Retrieve the enumeration definition corresponding to `a_type_name'.

Retrieve the property definition for `a_prop_name' in flattened class corresponding to `a_type_name'.

True if `a_ms_property_type' is a valid 'MS' dynamic type for `a_property' in BMM type `a_bmm_type_name'. 'MS' conformance means 'model-semantic' conformance, which abstracts away container types like List<>, Set<> etc and compares the dynamic type with the relation target type in the UML sense, i.e. regardless of whether there is single or multiple containment.

Retrieve the property definition for `a_property_path' in flattened class corresponding to `a_type_name'.

Return all ancestor types of `a_class_name' up to root class (usually 'ANY', 'Object' or something similar). Does not include current class. Returns empty list if none.

Check conformance of `a_desc_type' to `an_anc_type'; the types may be generic, and may contain open generic parameters like 'T' etc. These are replaced with their appropriate constrainer types, or Any during the conformance testing process.

Abstraction of a BMM model component that contains packages and classes.

Child packages; keys all in upper case for guaranteed matching.

Package at the path `a_path'.

Recursively execute `action', which is a procedure taking a BMM_PACKAGE argument, on all members of packages.

True if there is a package at the path `a_path'; paths are delimited with Package_name_delimiter.

Abstraction of a package as a tree structure whose nodes can contain other packages and classes.

Name of this package. This name may be qualified if it is a top-level package.

Classes listed as being in this package.

Obtain the set of top-level classes in this package, either from this package itself or by recursing into the structure until classes are obtained from child packages. Recurse into each child only far enough to find the first level of classes.

Full path of this package back to root package.

Abstract idea of specifying a type either by definition or by reference.

Formal string form of the type as per UML.

Generate a type category of main target type from Type_category_xx values.

Signature form of the type, which for generics includes generic parameter constrainer types e.g. Interval<T:Ordered>.

Main design class for this type, from which properties etc can be extracted.

Completely flattened list of type names, flattening out all generic parameters.

Abstract idea of specifying a type in some context. This is not the same as 'defining' a class. A type specification is essentially a reference of some kind, that defines the type of an attribute, or function result or argument. It may include generic parameters that might or might not be bound. See subtypes.

Determine if there are any type substitutions.

List of type substitutions if any available for this type within the current BMM model.

Definition of a class in an object model. A class is type that may be open or closed in terms of other types mentioned within.

Name of this class. Note that unlike UML, names of classes are just the root name, even if the class is generic.

List of immediate inheritance parents.

Package this class belongs to.

List of attributes defined in this class.

Reference to original source schema defining this class. Useful for UI tools to determine which original schema file to open for a given class for manual editing.

List of immediate inheritance descendants.

True if this class is abstract in its model.

True if this class is designated a primitive type within the overall type system of the schema.

True if this definition overrides a class of the same name in an included schema.

List of all inheritance parent class names, recursively.

Compute all descendants by following immediate_descendants.

List of names of immediate supplier classes, including concrete generic parameters, concrete descendants of abstract statically defined types, and inherited suppliers. This list includes primitive types.

Same as `suppliers' minus primitive types, as defined in input schema.

List of names of all classes in full supplier closure, including concrete generic parameters. This list includes primitive types.

Main design class for this type, from which properties etc can be extracted.

Fully qualified package name, of form: 'package.package'.

Fully qualified class name, of form: 'package.package.CLASS' with package path in lower-case and class in original case.

List of all properties due to current and ancestor classes, keyed by property name.

Formal string form of the type as per UML.

Model of a property definition within a class definition of an object model. Generic parameter takes care of variants.

Name of this property in the model.

True if this property is mandatory in its class.

True if this property is computed rather than stored in objects of this class.

Formal type of this property.

True if this property is marked with info model im_runtime property.

True if this property was marked with info model im_infrastructure flag.

Interval form of 0..1, 1..1 etc, generated from is_mandatory.

Name of this attribute to display in UI.

Subtype of BMM_PROPERTY that represents a container type based on one of the inbuilt types List <>, Set <>, Array <>.

Cardinality of this container.

Redefined to BMM_CONTAINER_TYPE.

Name of this attribute to display in UI.

Type reference to a single type i.e. not generic or container type.

The target type; this converts to the first parameter in generic_parameters in BMM_GENERIC_TYPE.

Return base_class.type_name.

Open type reference to a single type parameter, i.e. typically 'T', 'V', 'K' etc. The parameter must be in the type declaration of the owning BMM_CLASS.

The generic constraint, which will be 'Any' if nothing set in original model.

Return generic_constraint.conformance_type_name.

Type reference that specifies containers with one generic parameter.

The type of the container. This converts to the root_type in BMM_GENERIC_TYPE.

The target type; this converts to the first parameter in generic_parameters in BMM_GENERIC_TYPE.

Return full type name, e.g. 'List<ELEMENT>'.

Type reference that specifies an indexed container such as Hash<K,V>, i.e. a container whose members are accessed via a key (index) type.

The key (index) type of the container, e.g. String in Hash<String,EVENT_ACTION>.

Type reference based on a generic class, e.g. 'HashTable <List <Packet>, String>'.

Generic parameters of the root_type in this type specifier. The order must match the order of the owning class’s formal generic parameter declarations.

The base class of this type.

Return the full name of the type including generic parameters, e.g. 'DV_INTERVAL<T>', 'TABLE<List<THING>,String>'.

Definition of a generic parameter in a class definition of a generic type.

Name of the parameter, e.g. 'T' etc. The name is limited to 1 character and upper-case.

Optional conformance constraint that must be another valid class name.

If set, is the corresponding generic parameter definition in an ancestor class.

Get any ultimate type conformance constraint on this generic parameter due to inheritance.

Generate ultimate conformance type, which is either from `conforms_to_type' or if not set, 'Any'.

Signature form of the open type, including constrainer type if there is one, e.g. 'T:Ordered'.

Inv_generic_name: name.count = 1 and name.is_upper

Definition of a generic class in an object model.

List of generic parameter definitions, keyed by name of generic parameter; these are defined either directly on this class or by the addition of an ancestor class which is generic.

Add suppliers from generic parameters.

Signature form of the type, which for generics includes generic parameter constrainer types e.g. Interval<T:Ordered>.

Formal string form of the type as per UML.

Definition of an enumeration type. In the BMM system, an 'enumeration' type is understood as an underlying basic type and a set of named constants of that type. It is designed so that the default type is Integer, and the default constants are numbered 0, 1, …​ Optional model elements can be specified to override the values and / or the type.

The list of names of the enumeration. If no values are supplied, the integer values 0, 1, 2, …​ are assumed.

Optional list of specific values. Must be 1:1 with `item_names' list.

Name of type any concrete BMM_ENUMERATION_* sub-type is based on, i.e. the name of type bound to 'T' in a declared use of this type.

String-based enumeration type.

Name of type any concrete BMM_ENUMERATION_* sub-type is based on. Redefined to "STRING".

Integer-based enumeration type.

Name of type any concrete BMM_ENUMERATION_* sub-type is based on. Redefined to "INTEGER".