New documentation generated.

Author: pedropaulofb

.gitignore

@@ -168,4 +168,4 @@ bak/secure_token.txt
 /bak
 /queries
 results/
-tester.py
+tester.py

docs/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 4ab3bf126d242c5a4b19ae9be6501bfc
+config: 36a50eec767510d4c12e6cdbe91ae47a
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/_sources/autoapi/ontouml_models_lib/catalog/index.rst.txt

@@ -27,8 +27,8 @@ ontouml_models_lib.catalog
    --------
    Example 1: Loading a Catalog and Executing a Single Query on All Models
 
-       >>> from catalog import Catalog
-       >>> from query import Query
+       >>> from ontouml_models_lib import Catalog
+       >>> from ontouml_models_lib import Query
 
        >>> # Initialize the catalog with the path to the directory
        >>> catalog = Catalog('/path/to/catalog')
@@ -41,8 +41,8 @@ ontouml_models_lib.catalog
 
    Example 2: Filtering Models by Attributes and Executing Multiple Queries
 
-       >>> from catalog import Catalog
-       >>> from query import Query
+       >>> from ontouml_models_lib import Catalog
+       >>> from ontouml_models_lib import Query
 
        >>> # Initialize the catalog
        >>> catalog = Catalog('/path/to/catalog')
@@ -58,8 +58,8 @@ ontouml_models_lib.catalog
 
    Example 3: Executing Multiple Queries on a Specific Model
 
-       >>> from catalog import Catalog
-       >>> from query import Query
+       >>> from ontouml_models_lib import Catalog
+       >>> from ontouml_models_lib import Query
 
        >>> # Initialize the catalog
        >>> catalog = Catalog('/path/to/catalog')
@@ -121,8 +121,8 @@ Module Contents
    --------
    Basic usage example of the `Catalog` class:
 
-       >>> from catalog import Catalog
-       >>> from query import Query
+       >>> from ontouml_models_lib import Catalog
+       >>> from ontouml_models_lib import Query
 
        >>> # Initialize the catalog with the path to the directory
        >>> catalog = Catalog('/path/to/catalog')
@@ -183,8 +183,8 @@ Module Contents
 
       Example usage:
 
-      >>> from catalog import Catalog
-      >>> from query import Query
+      >>> from ontouml_models_lib import Catalog
+      >>> from ontouml_models_lib import Query
       >>> catalog = Catalog('/path/to/catalog')
       >>> query = Query('./queries/query.sparql')  # Load a SPARQL query from a file
       >>> model = catalog.get_model('some_model_id')  # Retrieve a model by its ID
@@ -210,8 +210,8 @@ Module Contents
 
       Example usage:
 
-      >>> from catalog import Catalog
-      >>> from query import Query
+      >>> from ontouml_models_lib import Catalog
+      >>> from ontouml_models_lib import Query
       >>> catalog = Catalog('/path/to/catalog')
       >>> query = Query('./queries/query.sparql')  # Load a SPARQL query from a file
       >>> catalog.execute_query_on_all_models(query)  # Execute the query on all models
@@ -238,8 +238,8 @@ Module Contents
 
       Example usage:
 
-      >>> from catalog import Catalog
-      >>> from query import Query
+      >>> from ontouml_models_lib import Catalog
+      >>> from ontouml_models_lib import Query
       >>> catalog = Catalog('/path/to/catalog')
       >>> model = catalog.get_model('some_model_id')  # Retrieve a model by its ID
       >>> queries = Query.load_queries('./queries')  # Load multiple SPARQL queries from a directory
@@ -268,8 +268,8 @@ Module Contents
 
       Example usage:
 
-      >>> from catalog import Catalog
-      >>> from query import Query
+      >>> from ontouml_models_lib import Catalog
+      >>> from ontouml_models_lib import Query
       >>> catalog = Catalog('/path/to/catalog')
       >>> models = catalog.get_models(language="en")  # Filter models by language
       >>> queries = Query.load_queries('./queries')  # Load multiple SPARQL queries from a directory
@@ -296,8 +296,8 @@ Module Contents
 
       Example usage:
 
-      >>> from catalog import Catalog
-      >>> from query import Query
+      >>> from ontouml_models_lib import Catalog
+      >>> from ontouml_models_lib import Query
       >>> catalog = Catalog('/path/to/catalog')
       >>> queries = Query.load_queries('./queries')  # Load multiple SPARQL queries from a directory
       >>> catalog.execute_queries_on_all_models(queries)  # Execute the queries on all models
@@ -319,7 +319,7 @@ Module Contents
 
       Example usage:
 
-      >>> from catalog import Catalog
+      >>> from ontouml_models_lib import Catalog
       >>> catalog = Catalog('/path/to/catalog')
       >>> model = catalog.get_model('some_model_id')  # Retrieve a model by its unique ID
 
@@ -343,7 +343,7 @@ Module Contents
 
       Example usage:
 
-      >>> from catalog import Catalog
+      >>> from ontouml_models_lib import Catalog
       >>> catalog = Catalog('/path/to/catalog')
       >>> # Filter models by a single attribute (language)
       >>> filtered_models = catalog.get_models(language="en")
@@ -367,68 +367,100 @@ Module Contents
 
       Example usage:
 
-      >>> from catalog import Catalog
+      >>> from ontouml_models_lib import Catalog
       >>> catalog = Catalog('/path/to/catalog')
       >>> catalog.remove_model_by_id('some_model_id')  # Remove a model by its unique ID
 
 
 
    .. py:method:: _load_models()
 
-      Load all ontology models from the specified directory.
+      Load all ontology models from the catalog directory.
 
-      This method is called internally by the initializer to scan the catalog directory for subfolders, each
-      representing an ontology model. It loads the models from these subfolders and initializes them as instances of
-      the `Model` class. The loaded models are stored in the `models` attribute.
+      This method scans the catalog directory for subfolders, each representing an ontology model. It loads the models
+      from these subfolders and initializes them as instances of the `Model` class. The loaded models are stored in
+      the `models` attribute of the `Catalog` instance.
 
-      :raises FileNotFoundError: If the catalog path does not contain any model subfolders.
+      :raises FileNotFoundError: If the catalog directory does not contain any model subfolders.
 
 
 
    .. py:method:: _get_subfolders()
 
-      Get the names of all subfolders in the catalog catalog_path.
+      Retrieve the names of all subfolders in the catalog directory.
+
+      This method identifies all subfolders within the catalog's `path_models` directory, which represent individual
+      ontology models. The subfolders are expected to have the necessary ontology and metadata files for each model.
+
+      :return: A list of subfolder names within the catalog directory.
+      :rtype: list
 
 
 
    .. py:method:: _create_catalog_graph()
 
-      Create a single RDFLib model_graph by merging all graphs from the models.
+      Create a merged RDFLib graph from all loaded models in the catalog.
+
+      This method combines the RDF graphs of all loaded models into a single RDFLib `Graph` object. The merged graph
+      allows for executing SPARQL queries across the entire catalog, enabling comprehensive queries that span multiple
+      models.
+
+      :return: A merged RDFLib graph containing all triples from the models in the catalog.
+      :rtype: Graph
 
 
 
    .. py:method:: _generate_compiled_results(results, compiled_file_path)
 
-      Generate a compiled CSV file from results of all models.
+      Generate a compiled CSV file from the results of all models.
+
+      This method compiles the results of SPARQL queries executed across multiple models into a single CSV file.
+      The compiled file is saved at the specified `compiled_file_path`. The method ensures that the results are
+      formatted as a tabular dataset, with the `model_id` column appearing first.
+
+      :param results: A list of dictionaries containing the results from multiple models.
+      :type results: list[dict]
+      :param compiled_file_path: The path where the compiled CSV file will be saved.
+      :type compiled_file_path: Path
 
 
 
    .. py:method:: _match_model(model, filters, operand)
 
-      Check if a model matches the given attribute restrictions.
+      Check if a model matches the specified attribute filters.
+
+      This method evaluates whether a model meets the attribute restrictions defined in the `filters` dictionary.
+      It supports combining multiple filters using logical operations ("and" or "or"), and returns a boolean
+      indicating whether the model satisfies the filter conditions.
 
-      :param model: The model to check.
+      :param model: The model to be checked against the filters.
       :type model: Model
-      :param filters: Attribute restrictions to filter models.
-      :type filters: dict
-      :param operand: Logical operand for combining filters ("and" or "or").
+      :param filters: A dictionary of attribute restrictions used to filter models. Attribute names and values are
+                      passed as keyword arguments.
+      :type filters: dict[str, Any]
+      :param operand: Logical operand for combining filters ("and" or "or"). Defaults to "and".
       :type operand: str
-      :return: True if the model matches the restrictions, False otherwise.
+      :return: True if the model matches the filter conditions; False otherwise.
       :rtype: bool
+      :raises ValueError: If an invalid operand is provided (not "and" or "or").
 
 
 
    .. py:method:: _match_single_filter(model, attr, value)
 
-      Check if a model matches a single attribute restriction.
+      Check if a model matches a single attribute filter.
+
+      This method evaluates whether a model meets a single attribute restriction. It compares the model's attribute
+      value to the provided filter value and returns a boolean indicating whether there is a match. It handles both
+      single-value and list-value comparisons.
 
-      :param model: The model to check.
+      :param model: The model to be checked against the filter.
       :type model: Model
-      :param attr: The attribute name to filter by.
+      :param attr: The name of the attribute to filter by.
       :type attr: str
-      :param value: The attribute value or list of values to filter by.
+      :param value: The expected value or list of values to filter by.
       :type value: Any
-      :return: True if the model matches the restriction, False otherwise.
+      :return: True if the model's attribute matches the filter; False otherwise.
       :rtype: bool