© Ribose Inc. 2025
All rights reserved. Unless otherwise specified, no part of this publication may be reproduced or utilized otherwise in any form or by any means, electronic or mechanical, including photocopying, or posting on the internet or an intranet, without prior written permission. Permission can be requested from the address below.
Ribose Inc.
167-169 Great Portland Street
5th Floor
London
W1W 5PF
United Kingdom
www.ribose.com
This document specifies the model register capabilities in LutaML Model, which enable:
Dynamic model attribute modification
Model hierarchy manipulation
Cross-model attribute type substitution
For the purposes of this document, the following terms and definitions apply.
registry that maintains and manages dynamic model configurations
path expression that identifies a specific model or attribute within a model hierarchy
tree structure that represents the relationships between different models and their attributes
process of replacing one attribute type with another within a model
collection of interconnected models that form a hierarchical structure
A LutaML model register provides a way to dynamically modify and reconfigure model hierarchies without changing the original model definitions.
Common use cases include:
Replacing attribute types in models
Swapping model subtrees with alternative implementations
Adding or removing attributes from models
Converting between different model namespaces
A model register acts as a dynamic configuration layer that sits above the static model definitions:
A model register is created and populated with model definitions:
Model paths identify specific locations within a model hierarchy using the LutaML Path syntax.
Common path patterns:
Single model: ModelName
Nested model: ParentModel > ChildModel
Model attribute: Model.attribute
Nested attribute: ParentModel > ChildModel.attribute
Given this model hierarchy:
Valid model paths include:
Publication — References the Publication model
Publication > Book — References Book as a child of Publication
Publication.metadata — References the metadata attribute
Publication > Book.chapters — References the chapters collection
Models must be registered before they can be dynamically modified.
Registers a single model class.
Syntax:
Registers a model and all its dependent models.
Syntax:
Replace an attribute’s type with another model type.
Replaces a specific attribute instance’s type.
Syntax:
Replaces all instances of a type throughout the model hierarchy.
Syntax:
Replaces an entire subtree in the model hierarchy.
Syntax:
Add or remove attributes from a model.
Syntax:
After configuration, models are retrieved from the register using the resolve method.
Retrieves a configured model class by name.
Syntax:
Retrieves a model class using a model path.
Syntax:
This example demonstrates converting models between different namespaces.
This example shows extending models with new attributes.
This tutorial demonstrates using model registers to create an adaptive document model system that can be customized for different use cases.
Create initial model hierarchy
Register models
Understand basic model relationships
Extend models with new attributes
Replace attribute types
Use path-based modifications
Replace model subtrees
Add nested attributes
Handle collections
Apply global type substitutions
Manage cross-cutting concerns
Handle model relationships
This tutorial demonstrated:
Basic model registration and configuration
Dynamic attribute type substitution
Model subtree replacement
Global type modifications
Cross-cutting attribute addition
The progression shows how model registers enable flexible and maintainable model configurations that can adapt to different requirements while maintaining model consistency.
There are no normative references in this document.