Class: Lutaml::UmlRepository::Repository

Inherits:
Object
  • Object
show all
Includes:
Deprecated
Defined in:
lib/lutaml/uml_repository/repository.rb,
lib/lutaml/uml_repository/repository/loader.rb,
lib/lutaml/uml_repository/repository/deprecated.rb

Overview

Repository provides a fully indexed, queryable in-memory representation of a UML model.

It wraps the existing [‘Lutaml::Uml::Document`](../../uml/document.rb) model and adds:

  • Package hierarchy with path-based navigation

  • Class index with qualified name lookups

  • Type resolution for attribute data types

  • Association tracking including ownership and navigability

  • Diagram metadata for visualization

  • Search capabilities across all model elements

Repository can be built from XMI files or loaded from pre-serialized LUR (LutaML UML Repository) packages for instant loading.

Examples:

Building from XMI

repo = Lutaml::Xmi::Repository.from_xmi('model.xmi')
klass = repo.find_class("ModelRoot::i-UR::urf::Building")

Navigating package hierarchy

packages = repo.list_packages("ModelRoot::i-UR", recursive: true)
tree = repo.package_tree("ModelRoot", max_depth: 2)

Querying inheritance

parent = repo.supertype_of("ModelRoot::Child")
descendants = repo.descendants_of("ModelRoot::Parent", max_depth: 2)

Direct Known Subclasses

LazyRepository, RepositoryEnhanced

Defined Under Namespace

Modules: Deprecated, Loader

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Deprecated

#export, #find_associations, #find_children, #find_diagrams, #search_classes

Constructor Details

#initialize(document:, indexes: nil, metadata: nil, options: {}) ⇒ Repository

Initialize a new Repository.

This is typically not called directly. Use [‘from_xmi`](#from_xmi) instead.

(if loaded from LUR)

Examples:

indexes = IndexBuilder.build_all(document)
repo = Repository.new(document: document, indexes: indexes)

Parameters:

  • document (Lutaml::Uml::Document) —

    The UML document to wrap

  • indexes (Hash, nil) (defaults to: nil) —

    Pre-built indexes, or nil to build them automatically

  • metadata (PackageMetadata, nil) (defaults to: nil) —

    Package metadata



60
61
62
63
64
65
66
67
 
# File 'lib/lutaml/uml_repository/repository.rb', line 60

def initialize(document:, indexes: nil, metadata: nil, options: {}) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
  @document = document.freeze
  @indexes = indexes || IndexBuilder.build_all(document)
  @metadata = metadata

  init_services(skip_queries: options[:skip_queries])
  freeze
end

Instance Attribute Details

#document ⇒ Lutaml::Uml::Document (readonly)

Returns The underlying UML document.

Returns:



38
39
40
 
# File 'lib/lutaml/uml_repository/repository.rb', line 38

def document
  @document
end

#indexes ⇒ Hash (readonly)

Returns The indexes for fast lookups.

Returns:

  • (Hash) —

    The indexes for fast lookups



41
42
43
 
# File 'lib/lutaml/uml_repository/repository.rb', line 41

def indexes
  @indexes
end

#metadata ⇒ PackageMetadata? (readonly)

Returns The package metadata (if loaded from LUR).

Returns:



44
45
46
 
# File 'lib/lutaml/uml_repository/repository.rb', line 44

def metadata
  @metadata
end

Class Method Details

.from_file(path) ⇒ Repository

Auto-detect file type and load appropriately.

Detects whether the file is an XMI file (.xmi) or a LUR package (.lur) and loads it using the appropriate method.

Examples:

repo = Repository.from_file('model.xmi')
repo = Repository.from_file('model.lur')

Parameters:

  • path (String) —

    Path to the file (.xmi or .lur)

Returns:

  • (Repository) —

    A new or loaded repository instance

Raises:

  • (ArgumentError) —

    If the file type is unknown



122
123
124
125
126
127
128
129
130
 
# File 'lib/lutaml/uml_repository/repository.rb', line 122

def self.from_file(path)
  case File.extname(path).downcase
  when ".xmi" then from_xmi(path)
  when ".lur" then from_package(path)
  else
    raise ArgumentError,
          "Unknown file type: #{path}. Expected .xmi or .lur"
  end
end

.from_file_cached(xmi_path, lur_path: nil) ⇒ Repository

Smart caching - use LUR if newer than XMI, otherwise rebuild.

This method implements intelligent caching by checking if a LUR package exists and is newer than the source XMI file. If so, it loads from the cache. Otherwise, it builds from XMI and creates/updates the cache.

Examples:

Using default cache path

repo = Repository.from_file_cached('model.xmi')
# Creates/uses model.lur

Using custom cache path

repo = Repository.from_file_cached('model.xmi',
                                       lur_path: 'cache/model.lur')

Parameters:

  • xmi_path (String) —

    Path to the XMI file

  • lur_path (String, nil) (defaults to: nil) —

    Path to the LUR package (default: XMI path with .lur extension)

Returns:



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/lutaml/uml_repository/repository.rb', line 149

def self.from_file_cached(xmi_path, lur_path: nil) # rubocop:disable Metrics/CyclomaticComplexity,Metrics/MethodLength,Metrics/PerceivedComplexity
  lur_path ||= xmi_path.sub(/\.xmi$/i, ".lur")

  if File.exist?(lur_path) && File.mtime(lur_path) >= File.mtime(xmi_path)
    puts "Using cached LUR package: #{lur_path}" if $VERBOSE
    from_package(lur_path)
  else
    puts "Building repository from XMI..." if $VERBOSE
    repo = from_xmi(xmi_path)

    puts "Caching as LUR package: #{lur_path}" if $VERBOSE
    repo.export_to_package(lur_path)
    repo
  end
end

.from_file_lazy(path) ⇒ LazyRepository

Auto-detect file type and load with lazy loading.

Detects whether the file is an XMI file (.xmi) or a LUR package (.lur) and loads it using the appropriate lazy loading method.

Examples:

repo = Repository.from_file_lazy('large-model.xmi')
repo = Repository.from_file_lazy('large-model.lur')

Parameters:

  • path (String) —

    Path to the file (.xmi or .lur)

Returns:

Raises:

  • (ArgumentError) —

    If the file type is unknown



199
200
201
202
203
204
205
206
207
 
# File 'lib/lutaml/uml_repository/repository.rb', line 199

def self.from_file_lazy(path)
  case File.extname(path).downcase
  when ".xmi" then from_xmi_lazy(path)
  when ".lur" then from_package_lazy(path)
  else
    raise ArgumentError,
          "Unknown file type: #{path}. Expected .xmi or .lur"
  end
end

.from_package(lur_path) ⇒ Repository

Load a Repository from a LUR package file.

Examples:

repo = Repository.from_package("model.lur")

Parameters:

  • lur_path (String) —

    Path to the .lur package file

Returns:



171
172
173
 
# File 'lib/lutaml/uml_repository/repository.rb', line 171

def self.from_package(lur_path)
  PackageLoader.load(lur_path)
end

.from_package_lazy(lur_path) ⇒ LazyRepository

Load a Repository from a LUR package file with lazy loading.

This method loads the document without building indexes, deferring index creation until first access. Useful for very large models.

Examples:

repo = Repository.from_package_lazy("large-model.lur")

Parameters:

  • lur_path (String) —

    Path to the .lur package file

Returns:



184
185
186
 
# File 'lib/lutaml/uml_repository/repository.rb', line 184

def self.from_package_lazy(lur_path)
  PackageLoader.load_document_only(lur_path)
end

.from_xmi(xmi_path, options = {}) ⇒ Repository

Build a Repository from an XMI file.

Examples:

repo = Repository.from_xmi('model.xmi')
repo = Repository.from_xmi('model.xmi', validate: true)

Parameters:

  • xmi_path (String) —

    Path to the XMI file

  • options (Hash) (defaults to: {}) —

    Options for parsing

Options Hash (options):

  • :validate (Boolean) — default: false —

    Validate model consistency after building indexes

Returns:



79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/lutaml/uml_repository/repository.rb', line 79

def self.from_xmi(xmi_path, options = {})
  document = Lutaml::Xmi::Parsers::Xml.parse(File.new(xmi_path))

  # Build indexes
  indexes = IndexBuilder.build_all(document)

  # Optionally validate (placeholder for future validation logic)
  # if options[:validate]
  #   validate_model(document, indexes)
  # end

  new(document: document, indexes: indexes, options: options)
end

.from_xmi_lazy(xmi_path, _options = {}) ⇒ LazyRepository

Build a Repository from an XMI file with lazy index loading.

This method creates a LazyRepository that builds indexes on-demand rather than upfront. Useful for very large models (1000+ classes) to reduce initial load time and memory usage.

Examples:

repo = Repository.from_xmi_lazy('large-model.xmi')
# Only document loaded, indexes built on first access

Parameters:

  • xmi_path (String) —

    Path to the XMI file

  • options (Hash) —

    Options for parsing

Returns:



105
106
107
108
109
 
# File 'lib/lutaml/uml_repository/repository.rb', line 105

def self.from_xmi_lazy(xmi_path, _options = {})
  document = Lutaml::Xmi::Parsers::Xml.parse(File.new(xmi_path))

  LazyRepository.new(document: document, lazy: true)
end

Instance Method Details

#all_attributes ⇒ Array<Lutaml::Uml::Attribute>

Get all attributes across all classes in the repository.

Returns:

  • (Array<Lutaml::Uml::Attribute>) —

    All attribute objects



337
338
339
340
341
342
343
 
# File 'lib/lutaml/uml_repository/repository.rb', line 337

def all_attributes
  indexes[:qualified_names].flat_map do |_qname, entity|
    next [] unless entity.is_a?(Lutaml::Uml::Classifier) && entity.attributes

    entity.attributes
  end
end

#all_classes ⇒ Array

Get all classes in the repository

Examples:

all = repo.all_classes

Returns:

  • (Array) —

    All class objects (classes, datatypes, enums)



632
633
634
 
# File 'lib/lutaml/uml_repository/repository.rb', line 632

def all_classes
  classes_index
end

#all_diagrams ⇒ Array<Lutaml::Uml::Diagram>

Get all diagrams in the model.

Examples:

all_diagrams = repo.all_diagrams

Returns:



468
469
470
 
# File 'lib/lutaml/uml_repository/repository.rb', line 468

def all_diagrams
  diagram_query.all
end

#ancestors_of(class_or_qname) ⇒ Array

Get all ancestor classes up to the root.

Returns ancestors in order from immediate parent to root.

Examples:

ancestors = repo.ancestors_of("ModelRoot::GrandChild")

Parameters:

  • class_or_qname (Lutaml::Uml::Class, String) —

    The class object or qualified name string

Returns:

  • (Array) —

    Array of ancestor class objects, ordered from nearest to furthest



406
407
408
 
# File 'lib/lutaml/uml_repository/repository.rb', line 406

def ancestors_of(class_or_qname)
  inheritance_query.ancestors(class_or_qname)
end

#associations_index ⇒ Array<Lutaml::Uml::Association>

Get all associations as an array Collects from both document-level (XMI) and class-level (QEA/EA)

Returns:



588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
 
# File 'lib/lutaml/uml_repository/repository.rb', line 588

def associations_index # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/MethodLength,Metrics/PerceivedComplexity
  # Use cached index if available (built by IndexBuilder)
  return @indexes[:associations].values if @indexes[:associations]

  # Fallback for edge cases: collect from document and classes
  seen = Set.new
  associations = []

  (@document.associations || []).each do |assoc|
    if assoc.xmi_id && !seen.include?(assoc.xmi_id)
      seen << assoc.xmi_id
      associations << assoc
    end
  end

  classes_index.each do |klass|
    next unless (klass.is_a?(Lutaml::Uml::Class) || klass.is_a?(Lutaml::Uml::DataType)) && klass.associations

    klass.associations.each do |assoc|
      if assoc.xmi_id && !seen.include?(assoc.xmi_id)
        seen << assoc.xmi_id
        associations << assoc
      end
    end
  end

  associations
end

#associations_of(class_or_qname, options = {}) ⇒ Array<Lutaml::Uml::Association>

Get associations involving a class.

Return only navigable associations

Examples:

all_assocs = repo.associations_of("ModelRoot::Building")
outgoing = repo.associations_of(
"ModelRoot::Building", direction: :source)

Parameters:

  • class_or_qname (Lutaml::Uml::Class, String) —

    The class object or qualified name string

  • options (Hash) (defaults to: {}) —

    Query options

Options Hash (options):

  • :direction (Symbol) — default: :both —

    Filter by direction: :source, :target, or :both

  • :owned_only (Boolean) —

    Return only owned associations

  • :navigable_only (Boolean)

Returns:



438
439
440
 
# File 'lib/lutaml/uml_repository/repository.rb', line 438

def associations_of(class_or_qname, options = {})
  association_query.find_for_class(class_or_qname, options)
end

#classes_in_package(package_path, recursive: false) ⇒ Array

Get classes in a specific package.

Examples:

classes = repo.classes_in_package("ModelRoot::i-UR::urf")
all_classes = repo.classes_in_package(
"ModelRoot::i-UR", recursive: true)

Parameters:

  • package_path (String) —

    The package path

  • recursive (Boolean) (defaults to: false) —

    Whether to include classes from nested packages (default: false)

Returns:

  • (Array) —

    Array of class objects in the package



365
366
367
 
# File 'lib/lutaml/uml_repository/repository.rb', line 365

def classes_in_package(package_path, recursive: false)
  class_query.in_package(package_path, recursive: recursive)
end

#classes_index ⇒ Array

Get all classes (including datatypes and enums) as an array

Returns:

  • (Array) —

    All classifiers



581
582
583
 
# File 'lib/lutaml/uml_repository/repository.rb', line 581

def classes_index
  @indexes[:qualified_names]&.values || []
end

#descendants_of(class_or_qname, max_depth: nil) ⇒ Array

Get all descendant classes.

Examples:

descendants = repo.descendants_of("ModelRoot::Parent", max_depth: 2)

Parameters:

  • class_or_qname (Lutaml::Uml::Class, String) —

    The class object or qualified name string

  • max_depth (Integer, nil) (defaults to: nil) —

    Maximum depth to traverse (nil for unlimited)

Returns:

  • (Array) —

    Array of descendant class objects



419
420
421
 
# File 'lib/lutaml/uml_repository/repository.rb', line 419

def descendants_of(class_or_qname, max_depth: nil)
  inheritance_query.descendants(class_or_qname, max_depth: max_depth)
end

#diagrams_in_package(package_path) ⇒ Array<Lutaml::Uml::Diagram>

Get diagrams in a specific package.

Examples:

diagrams = repo.diagrams_in_package("ModelRoot::i-UR::urf")

Parameters:

  • package_path (String) —

    The package path or package ID

Returns:



448
449
450
 
# File 'lib/lutaml/uml_repository/repository.rb', line 448

def diagrams_in_package(package_path)
  diagram_query.in_package(package_path)
end

#diagrams_index ⇒ Array<Lutaml::Uml::Diagram>

Get all diagrams as an array

Returns:



624
625
626
 
# File 'lib/lutaml/uml_repository/repository.rb', line 624

def diagrams_index
  all_diagrams
end

#export_to_package(output_path, options = {}) ⇒ void

This method returns an undefined value.

Export this repository to a LUR package file.

Examples:

Export with defaults

repo.export_to_package("model.lur")

Export with PackageMetadata

metadata = PackageMetadata.new(
  name: "Urban Model",
  version: "2.0",
  publisher: "City Planning"
)
repo.export_to_package("model.lur", metadata: metadata)

Export with custom options (backward compatible)

repo.export_to_package("model.lur",
  name: "My Model",
  version: "2.0",
  serialization_format: :yaml
)

Parameters:

  • output_path (String) —

    Path for the output .lur file

  • options (Hash) (defaults to: {}) —

    Export options

Options Hash (options):

  • :metadata (PackageMetadata, Hash) —

    Package metadata

  • :name (String) — default: "UML Model" —

    Package name (deprecated, use :metadata)

  • :version (String) — default: "1.0" —

    Package version (deprecated, use :metadata)

  • :include_xmi (Boolean) — default: false —

    Include source XMI

  • :serialization_format (Symbol) — default: :yaml —

    Format to use (:yaml)

  • :compression_level (Integer) — default: 6 —

    ZIP compression level



240
241
242
 
# File 'lib/lutaml/uml_repository/repository.rb', line 240

def export_to_package(output_path, options = {})
  PackageExporter.new(self, options).export(output_path)
end

#find_attribute(qualified_name) ⇒ Lutaml::Uml::Attribute?

Find an attribute by its qualified name.

The qualified name format is “PackagePath::ClassName::attributeName”. Splits off the last segment as the attribute name, finds the containing class, then returns the matching attribute.

Examples:

attr = repo.find_attribute("ModelRoot::Core::Building::name")

Parameters:

  • qualified_name (String) —

    Qualified name of the attribute

Returns:

  • (Lutaml::Uml::Attribute, nil) —

    The attribute or nil



321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/lutaml/uml_repository/repository.rb', line 321

def find_attribute(qualified_name)
  class_qname, _, attr_name = qualified_name.rpartition("::")
  return nil if class_qname.empty?

  klass = class_query.find_by_qname(class_qname)
  return nil unless klass

  attrs = klass.attributes
  return nil unless attrs

  attrs.find { |a| a.name == attr_name }
end

#find_class(qualified_name, raise_on_error: false) ⇒ Lutaml::Uml::Class, ...

Find a class by its qualified name.

Lutaml::Uml::Enum, nil]

The class object, or nil if not found

Examples:

klass = repo.find_class("ModelRoot::i-UR::urf::Building")
klass = repo.find_class("ModelRoot::Typo", raise_on_error: true)

Parameters:

  • qualified_name (String) —

    The qualified name (e.g., “ModelRoot::i-UR::urf::Building”)

  • raise_on_error (Boolean) (defaults to: false) —

    Whether to raise an error if not found (default: false)

Returns:

Raises:

  • (NameError) —

    If class not found and raise_on_error is true



304
305
306
307
308
309
 
# File 'lib/lutaml/uml_repository/repository.rb', line 304

def find_class(qualified_name, raise_on_error: false)
  result = class_query.find_by_qname(qualified_name)
  return result if result || !raise_on_error

  @error_handler.class_not_found_error(qualified_name)
end

#find_classes_by_stereotype(stereotype) ⇒ Array

Find all classes with a specific stereotype.

Examples:

feature_types = repo.find_classes_by_stereotype("featureType")

Parameters:

  • stereotype (String) —

    The stereotype to search for

Returns:

  • (Array) —

    Array of class objects with the stereotype



351
352
353
 
# File 'lib/lutaml/uml_repository/repository.rb', line 351

def find_classes_by_stereotype(stereotype)
  class_query.find_by_stereotype(stereotype)
end

#find_diagram(diagram_name) ⇒ Lutaml::Uml::Diagram?

Find a diagram by its name.

or nil if not found

Examples:

diagram = repo.find_diagram("Class Diagram 1")

Parameters:

  • diagram_name (String) —

    The diagram name

Returns:



459
460
461
 
# File 'lib/lutaml/uml_repository/repository.rb', line 459

def find_diagram(diagram_name)
  diagram_query.find_by_name(diagram_name)
end

#find_package(path, raise_on_error: false) ⇒ Lutaml::Uml::Package, ...

Find a package by its path.

Examples:

package = repo.find_package("ModelRoot::i-UR::urf")
package = repo.find_package("ModelRoot::typo", raise_on_error: true)

Parameters:

  • path (String) —

    The package path (e.g., “ModelRoot::i-UR::urf”)

  • raise_on_error (Boolean) (defaults to: false) —

    Whether to raise an error if not found (default: false)

Returns:

Raises:

  • (NameError) —

    If package not found and raise_on_error is true



255
256
257
258
259
260
 
# File 'lib/lutaml/uml_repository/repository.rb', line 255

def find_package(path, raise_on_error: false)
  result = package_query.find_by_path(path)
  return result if result || !raise_on_error

  @error_handler.package_not_found_error(path)
end

#list_packages(path = "ModelRoot", recursive: false) ⇒ Array<Lutaml::Uml::Package>

List packages at a specific path.

Examples:

Non-recursive listing

packages = repo.list_packages("ModelRoot::i-UR", recursive: false)

Recursive listing

packages = repo.list_packages("ModelRoot", recursive: true)

Parameters:

  • path (String) (defaults to: "ModelRoot") —

    The parent package path (default: “ModelRoot”)

  • recursive (Boolean) (defaults to: false) —

    Whether to include nested packages recursively (default: false)

Returns:



273
274
275
 
# File 'lib/lutaml/uml_repository/repository.rb', line 273

def list_packages(path = "ModelRoot", recursive: false)
  package_query.list(path, recursive: recursive)
end

#marshal_dump ⇒ Hash

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Custom marshaling to exclude runtime-only query objects

Only serializes the core data (document, indexes, and metadata), not the derived query service objects. This keeps serialized size minimal.

Returns:

  • (Hash) —

    Serializable state (document, indexes, and metadata)



643
644
645
 
# File 'lib/lutaml/uml_repository/repository.rb', line 643

def marshal_dump
  { document: @document, indexes: @indexes, metadata: @metadata }
end

#marshal_load(data) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Restore from marshaled state

Reconstructs the repository from serialized document, indexes, and metadata, reinitializing all query services.

and :metadata

Parameters:

  • data (Hash) —

    Serialized state with :document, :indexes,



657
658
659
660
661
662
663
664
 
# File 'lib/lutaml/uml_repository/repository.rb', line 657

def marshal_load(data)
  @document = data[:document]
  @indexes = data[:indexes]
  @metadata = data[:metadata]

  init_services
  freeze
end

#package_tree(path = "ModelRoot", max_depth: nil) ⇒ Hash?

Build a hierarchical tree structure of packages.

Examples:

tree = repo.package_tree("ModelRoot::i-UR", max_depth: 2)

Parameters:

  • path (String) (defaults to: "ModelRoot") —

    The root package path to start from (default: “ModelRoot”)

  • max_depth (Integer, nil) (defaults to: nil) —

    Maximum depth to traverse (nil for unlimited)

Returns:

  • (Hash, nil) —

    Tree structure with package information, or nil if root not found



287
288
289
 
# File 'lib/lutaml/uml_repository/repository.rb', line 287

def package_tree(path = "ModelRoot", max_depth: nil)
  package_query.tree(path, max_depth: max_depth)
end

#packages_index ⇒ Array<Lutaml::Uml::Package>

Get all packages as an array (excluding root Document)

Returns:



575
576
577
 
# File 'lib/lutaml/uml_repository/repository.rb', line 575

def packages_index
  (@indexes[:package_paths]&.values || []).grep(Lutaml::Uml::Package)
end

#qualified_name_for(obj) ⇒ Object

Get qualified name(key) by the object from @indexes



618
619
620
 
# File 'lib/lutaml/uml_repository/repository.rb', line 618

def qualified_name_for(obj)
  @indexes[:qualified_names].key(obj)
end

#query {|QueryDSL::QueryBuilder| ... } ⇒ QueryDSL::QueryBuilder

Build a query using the Query DSL

Provides a fluent interface for building complex queries with method chaining, lazy evaluation, and composable filters.

Examples:

Basic query

results = repo.query do |q|
  q.classes.where(stereotype: 'featureType')
end.all

Complex query

results = repo.query do |q|
  q.classes
    .in_package('ModelRoot::i-UR', recursive: true)
    .where { |c| c.attributes&.size.to_i > 10 }
    .order_by(:name, direction: :desc)
    .limit(5)
end.execute

Yields:

Returns:



551
552
553
554
555
 
# File 'lib/lutaml/uml_repository/repository.rb', line 551

def query(&block)
  builder = QueryDSL::QueryBuilder.new(self)
  block&.call(builder)
  builder
end

#query! {|QueryDSL::QueryBuilder| ... } ⇒ Array

Build and execute a query using the Query DSL

Same as [‘query`](#query) but executes immediately and returns results.

Examples:

results = repo.query! do |q|
  q.classes.where(stereotype: 'featureType')
end

Yields:

Returns:

  • (Array) —

    The query results



567
568
569
 
# File 'lib/lutaml/uml_repository/repository.rb', line 567

def query!(&)
  query(&).execute
end

#search(query, types: %i[class attribute association],, fields: [:name]) ⇒ Hash

Search for model elements by query string.

(:name, :documentation)

(default: [:name])

Examples:

results = repo.search("Building")
results = repo.search("address", types: [:attribute])
results = repo.search("urban", fields: [:name, :documentation])

Parameters:

  • query (String) —

    The search query

  • types (Array<Symbol>) (defaults to: %i[class attribute association],) —

    Types to search (:class, :attribute, :association) (default: [:class, :attribute, :association])

  • fields (Array<Symbol>) (defaults to: [:name]) —

    Fields to search in

Returns:

  • (Hash) —

    Search results grouped by type



485
486
487
488
489
 
# File 'lib/lutaml/uml_repository/repository.rb', line 485

def search(
  query, types: %i[class attribute association], fields: [:name]
)
  search_query.search(query, types: types, fields: fields)
end

#statistics ⇒ Hash

Get comprehensive statistics about the repository.

Returns detailed metrics including package depths, class complexity, attribute distributions, and model quality metrics. Statistics are calculated once during initialization and cached.

Examples:

stats = repo.statistics
puts "Total packages: #{stats[:total_packages]}"
puts "Max package depth: #{stats[:max_package_depth]}"
puts "Most complex class:
  #{stats[:most_complex_classes].first[:name]}"

Returns:

  • (Hash) —

    Comprehensive statistics hash



504
505
506
 
# File 'lib/lutaml/uml_repository/repository.rb', line 504

def statistics
  @statistics
end

#subtypes_of(class_or_qname, recursive: false) ⇒ Array

Get direct child classes (subtypes).

Examples:

children = repo.subtypes_of("ModelRoot::Parent")
all_descendants = repo.subtypes_of(
"ModelRoot::Parent", recursive: true)

Parameters:

  • class_or_qname (Lutaml::Uml::Class, String) —

    The class object or qualified name string

  • recursive (Boolean) (defaults to: false) —

    Whether to include all descendants (default: false)

Returns:

  • (Array) —

    Array of child class objects



392
393
394
 
# File 'lib/lutaml/uml_repository/repository.rb', line 392

def subtypes_of(class_or_qname, recursive: false)
  inheritance_query.subtypes(class_or_qname, recursive: recursive)
end

#supertype_of(class_or_qname) ⇒ Lutaml::Uml::Class?

Get the direct parent class (supertype).

Examples:

parent = repo.supertype_of("ModelRoot::Child")
parent = repo.supertype_of(child_class)

Parameters:

  • class_or_qname (Lutaml::Uml::Class, String) —

    The class object or qualified name string

Returns:



377
378
379
 
# File 'lib/lutaml/uml_repository/repository.rb', line 377

def supertype_of(class_or_qname)
  inheritance_query.supertype(class_or_qname)
end

#validate(verbose: false) ⇒ Validators::ValidationResult

Validate the repository for consistency and integrity.

Performs comprehensive validation including:

  • Type reference validation

  • Generalization reference validation

  • Circular inheritance detection

  • Association reference validation

  • Multiplicity validation

Examples:

result = repo.validate
if result.valid?
  puts "Repository is valid"
else
  result.errors.each { |error| puts "ERROR: #{error}" }
end

Parameters:

  • verbose (Boolean) (defaults to: false) —

    Collect detailed validation information

Returns:



526
527
528
529
 
# File 'lib/lutaml/uml_repository/repository.rb', line 526

def validate(verbose: false)
  Validators::RepositoryValidator.new(@document,
                                      @indexes).validate(verbose: verbose)
end