Module: Lutaml::Xml

Defined in:: lib/lutaml/xml.rb,
lib/lutaml/xml/ox.rb,
lib/lutaml/xml/oga.rb,
lib/lutaml/xml/w3c.rb,
lib/lutaml/xml/rexml.rb,
lib/lutaml/xml/schema.rb,
lib/lutaml/xml/adapter.rb,
lib/lutaml/xml/builder.rb,
lib/lutaml/xml/element.rb,
lib/lutaml/xml/mapping.rb,
lib/lutaml/xml/document.rb,
lib/lutaml/xml/listener.rb,
lib/lutaml/xml/nokogiri.rb,
lib/lutaml/xml/decisions.rb,
lib/lutaml/xml/namespace.rb,
lib/lutaml/xml/transform.rb,
lib/lutaml/xml/builder/ox.rb,
lib/lutaml/xml/data_model.rb,
lib/lutaml/xml/ox/element.rb,
lib/lutaml/xml/schema/xsd.rb,
lib/lutaml/xml/schema/xsd.rb,
lib/lutaml/xml/shared_dsl.rb,
lib/lutaml/xml/builder/oga.rb,
lib/lutaml/xml/oga/element.rb,
lib/lutaml/xml/xml_element.rb,
lib/lutaml/xml/builder/base.rb,
lib/lutaml/xml/configurable.rb,
lib/lutaml/xml/mapping_rule.rb,
lib/lutaml/xml/builder/rexml.rb,
lib/lutaml/xml/rexml/element.rb,
lib/lutaml/xml/serialization.rb,
lib/lutaml/xml/xml_attribute.rb,
lib/lutaml/xml/xml_namespace.rb,
lib/lutaml/xml/adapter_loader.rb,
lib/lutaml/xml/format_chooser.rb,
lib/lutaml/xml/schema/builder.rb,
lib/lutaml/xml/schema/xsd/all.rb,
lib/lutaml/xml/schema/xsd/any.rb,
lib/lutaml/xml/schema/xsd/key.rb,
lib/lutaml/xml/transformation.rb,
lib/lutaml/xml/type_namespace.rb,
lib/lutaml/xml/adapter_element.rb,
lib/lutaml/xml/blank_namespace.rb,
lib/lutaml/xml/decisions/rules.rb,
lib/lutaml/xml/decisions/rules.rb,
lib/lutaml/xml/error/xml_error.rb,
lib/lutaml/xml/model_transform.rb,
lib/lutaml/xml/namespace_needs.rb,
lib/lutaml/xml/namespace_usage.rb,
lib/lutaml/xml/schema/xsd/base.rb,
lib/lutaml/xml/schema/xsd/glob.rb,
lib/lutaml/xml/schema/xsd/list.rb,
lib/lutaml/xml/schema_location.rb,
lib/lutaml/xml/builder/nokogiri.rb,
lib/lutaml/xml/declaration_plan.rb,
lib/lutaml/xml/nokogiri/element.rb,
lib/lutaml/xml/schema/xsd/field.rb,
lib/lutaml/xml/schema/xsd/group.rb,
lib/lutaml/xml/schema/xsd/union.rb,
lib/lutaml/xml/type/serializers.rb,
lib/lutaml/xml/w3c/registration.rb,
lib/lutaml/xml/doctype_extractor.rb,
lib/lutaml/xml/schema/xsd/choice.rb,
lib/lutaml/xml/schema/xsd/errors.rb,
lib/lutaml/xml/schema/xsd/import.rb,
lib/lutaml/xml/schema/xsd/keyref.rb,
lib/lutaml/xml/schema/xsd/length.rb,
lib/lutaml/xml/schema/xsd/schema.rb,
lib/lutaml/xml/schema/xsd/unique.rb,
lib/lutaml/xml/schema/xsd_schema.rb,
lib/lutaml/xml/type/configurable.rb,
lib/lutaml/xml/adapter/ox_adapter.rb,
lib/lutaml/xml/decisions/decision.rb,
lib/lutaml/xml/hoisting_algorithm.rb,
lib/lutaml/xml/namespace_resolver.rb,
lib/lutaml/xml/schema/builder/oga.rb,
lib/lutaml/xml/schema/xsd/appinfo.rb,
lib/lutaml/xml/schema/xsd/element.rb,
lib/lutaml/xml/schema/xsd/include.rb,
lib/lutaml/xml/schema/xsd/pattern.rb,
lib/lutaml/xml/schema/xsd/version.rb,
lib/lutaml/xml/adapter/oga_adapter.rb,
lib/lutaml/xml/declaration_handler.rb,
lib/lutaml/xml/declaration_planner.rb,
lib/lutaml/xml/encoding_normalizer.rb,
lib/lutaml/xml/namespace_collector.rb,
lib/lutaml/xml/schema/xsd/notation.rb,
lib/lutaml/xml/schema/xsd/redefine.rb,
lib/lutaml/xml/schema/xsd/selector.rb,
lib/lutaml/xml/schema/xsd/sequence.rb,
lib/lutaml/xml/adapter/base_adapter.rb,
lib/lutaml/xml/parsed_namespace_set.rb,
lib/lutaml/xml/schema/builtin_types.rb,
lib/lutaml/xml/schema/xsd/attribute.rb,
lib/lutaml/xml/schema/xsd_namespace.rb,
lib/lutaml/xml/adapter/rexml_adapter.rb,
lib/lutaml/xml/namespace_declaration.rb,
lib/lutaml/xml/schema/relaxng_schema.rb,
lib/lutaml/xml/schema/xsd/annotation.rb,
lib/lutaml/xml/schema/xsd/max_length.rb,
lib/lutaml/xml/schema/xsd/min_length.rb,
lib/lutaml/xml/adapter/namespace_data.rb,
lib/lutaml/xml/declaration_plan_query.rb,
lib/lutaml/xml/namespace_scope_config.rb,
lib/lutaml/xml/schema/xsd/enumeration.rb,
lib/lutaml/xml/schema/xsd/schema_path.rb,
lib/lutaml/xml/schema/xsd/simple_type.rb,
lib/lutaml/xml/schema/xsd/white_space.rb,
lib/lutaml/xml/transformation_builder.rb,
lib/lutaml/xml/transformation_support.rb,
lib/lutaml/xml/type/value_xml_mapping.rb,
lib/lutaml/xml/type_namespace/planner.rb,
lib/lutaml/xml/adapter/adapter_helpers.rb,
lib/lutaml/xml/blank_namespace_handler.rb,
lib/lutaml/xml/decisions/decision_rule.rb,
lib/lutaml/xml/element_prefix_resolver.rb,
lib/lutaml/xml/namespace_type_resolver.rb,
lib/lutaml/xml/schema/builder/nokogiri.rb,
lib/lutaml/xml/schema/xsd/complex_type.rb,
lib/lutaml/xml/schema/xsd/total_digits.rb,
lib/lutaml/xml/type_namespace/resolver.rb,
lib/lutaml/xml/type_namespace_resolver.rb,
lib/lutaml/xml/adapter/nokogiri_adapter.rb,
lib/lutaml/xml/namespace_class_registry.rb,
lib/lutaml/xml/schema/xsd/any_attribute.rb,
lib/lutaml/xml/schema/xsd/documentation.rb,
lib/lutaml/xml/schema/xsd/max_exclusive.rb,
lib/lutaml/xml/schema/xsd/max_inclusive.rb,
lib/lutaml/xml/schema/xsd/min_exclusive.rb,
lib/lutaml/xml/schema/xsd/min_inclusive.rb,
lib/lutaml/xml/type_namespace/collector.rb,
lib/lutaml/xml/type_namespace/reference.rb,
lib/lutaml/xml/adapter/xml_serialization.rb,
lib/lutaml/xml/decisions/decision_engine.rb,
lib/lutaml/xml/polymorphic_value_handler.rb,
lib/lutaml/xml/schema/xsd/simple_content.rb,
lib/lutaml/xml/transformation/skip_logic.rb,
lib/lutaml/xml/decisions/decision_context.rb,
lib/lutaml/xml/namespace_declaration_data.rb,
lib/lutaml/xml/schema/xsd/attribute_group.rb,
lib/lutaml/xml/schema/xsd/complex_content.rb,
lib/lutaml/xml/schema/xsd/fraction_digits.rb,
lib/lutaml/xml/type_namespace/declaration.rb,
lib/lutaml/xml/schema/xsd/schema_validator.rb,
lib/lutaml/xml/schema/xsd/type_index_entry.rb,
lib/lutaml/xml/schema/xsd/validation_error.rb,
lib/lutaml/xml/transformation/rule_applier.rb,
lib/lutaml/xml/attribute_namespace_resolver.rb,
lib/lutaml/xml/error/invalid_xsd_type_error.rb,
lib/lutaml/xml/parsed_namespace_declaration.rb,
lib/lutaml/xml/schema/xsd/errors/suggestion.rb,
lib/lutaml/xml/schema/xsd/namespace_mapping.rb,
lib/lutaml/xml/schema/xsd/serialized_schema.rb,
lib/lutaml/xml/schema/xsd/validation_result.rb,
lib/lutaml/xml/serialization/collection_ext.rb,
lib/lutaml/xml/transformation/rule_compiler.rb,
lib/lutaml/xml/declaration_plan/element_node.rb,
lib/lutaml/xml/error/invalid_namespace_error.rb,
lib/lutaml/xml/error/xml_configuration_error.rb,
lib/lutaml/xml/namespace_declaration_builder.rb,
lib/lutaml/xml/namespace_resolution_strategy.rb,
lib/lutaml/xml/error/namespace_mismatch_error.rb,
lib/lutaml/xml/namespace_inheritance_resolver.rb,
lib/lutaml/xml/namespace_inheritance_strategy.rb,
lib/lutaml/xml/qualified_inheritance_strategy.rb,
lib/lutaml/xml/serialization/instance_methods.rb,
lib/lutaml/xml/serialization/model_import_ext.rb,
lib/lutaml/xml/transformation/element_builder.rb,
lib/lutaml/xml/transformation/ordered_applier.rb,
lib/lutaml/xml/declaration_plan/attribute_node.rb,
lib/lutaml/xml/schema/xsd/errors/error_context.rb,
lib/lutaml/xml/schema/xsd/schema_name_resolver.rb,
lib/lutaml/xml/serialization/format_conversion.rb,
lib/lutaml/xml/transformation/value_serializer.rb,
lib/lutaml/xml/decisions/rules/used_prefix_rule.rb,
lib/lutaml/xml/schema/xsd/errors/enhanced_error.rb,
lib/lutaml/xml/unqualified_inheritance_strategy.rb,
lib/lutaml/xml/decisions/element_prefix_resolver.rb,
lib/lutaml/xml/schema/xsd/errors/message_builder.rb,
lib/lutaml/xml/schema/xsd/file_validation_result.rb,
lib/lutaml/xml/schema/xsd/type_resolution_result.rb,
lib/lutaml/xml/schema/xsd/namespace_uri_remapping.rb,
lib/lutaml/xml/schema/xsd/restriction_simple_type.rb,
lib/lutaml/xml/schema/xsd/schema_location_mapping.rb,
lib/lutaml/xml/schema/xsd/extension_simple_content.rb,
lib/lutaml/xml/decisions/rules/attribute_usage_rule.rb,
lib/lutaml/xml/decisions/rules/explicit_option_rule.rb,
lib/lutaml/xml/decisions/rules/namespace_scope_rule.rb,
lib/lutaml/xml/schema/xsd/extension_complex_content.rb,
lib/lutaml/xml/transformation/custom_method_wrapper.rb,
lib/lutaml/xml/schema/xsd/restriction_simple_content.rb,
lib/lutaml/xml/decisions/rules/hoisted_on_parent_rule.rb,
lib/lutaml/xml/schema/xsd/restriction_complex_content.rb,
lib/lutaml/xml/decisions/rules/default_preference_rule.rb,
lib/lutaml/xml/decisions/rules/element_form_option_rule.rb,
lib/lutaml/xml/decisions/rules/format_preservation_rule.rb,
lib/lutaml/xml/decisions/rules/inherit_from_parent_rule.rb,
lib/lutaml/xml/decisions/rules/reuse_parent_prefix_rule.rb,
lib/lutaml/xml/decisions/rules/element_form_default_rule.rb,
lib/lutaml/xml/schema/xsd/schema_file_validation_results.rb,
lib/lutaml/xml/decisions/rules/inherit_parent_prefix_rule.rb,
lib/lutaml/xml/decisions/rules/element_form_default_unqualified_rule.rb,
lib/lutaml/xml/schema/xsd/errors/troubleshooters/troubleshooting_handler.rb,
lib/lutaml/xml/schema/xsd/errors/troubleshooters/namespace_troubleshooter.rb

Defined Under Namespace

Modules: Adapter, AdapterLoader, AttributeNamespaceResolver, BlankNamespaceHandler, Builder, Configurable, DataModel, Decisions, DeclarationHandler, DeclarationPlanQuery, DocTypeExtractor, ElementPrefixResolver, Error, HoistingAlgorithm, NamespaceDeclarationBuilder, Nokogiri, Oga, Ox, PolymorphicValueHandler, Rexml, Schema, Serialization, SharedDsl, TransformationSupport, Type, TypeNamespace, W3c Classes: AdapterElement, BlankNamespace, BlankNamespaceStrategy, CustomMethodWrapper, DeclarationPlan, DeclarationPlanner, Document, Element, EncodingNormalizer, ExplicitNamespaceStrategy, FormatChooser, InheritedNamespaceStrategy, Listener, Location, Mapping, MappingRule, ModelTransform, Namespace, NamespaceClassRegistry, NamespaceCollector, NamespaceDeclaration, NamespaceDeclarationData, NamespaceInheritanceResolver, NamespaceInheritanceStrategy, NamespaceNeeds, NamespaceResolutionStrategy, NamespaceResolver, NamespaceScopeConfig, NamespaceTypeResolver, NamespaceUsage, NokogiriElement, ParsedNamespaceDeclaration, ParsedNamespaceSet, ProcessingInstructionMapping, QualifiedInheritanceStrategy, SchemaLocation, SchemaQualifiedStrategy, Transform, Transformation, TransformationBuilder, TypeNamespaceResolver, TypeNamespaceStrategy, UnqualifiedInheritanceStrategy, XmlAttribute, XmlElement, XmlNamespace

Class Method Summary collapse

.adapter ⇒ Object

Get the current XML adapter.
.adapter_type ⇒ Symbol

Get the current XML adapter type.
.detect_xml_adapter ⇒ Symbol^?

Detect available XML adapter.

Class Method Details

.adapter ⇒ `Object`

Get the current XML adapter

Provides unified access to the configured XML adapter. This is a convenience method for consistent adapter access across Model and Type classes.

Examples:

Using the adapter

adapter = Lutaml::Xml.adapter
doc = adapter.parse(xml_string)

Returns:

(Object) —

the configured XML adapter instance



69
70
71

# File 'lib/lutaml/xml.rb', line 69

def self.adapter
  Lutaml::Model::Config.adapter_for(:xml)
end

.adapter_type ⇒ `Symbol`

Get the current XML adapter type

Returns:

(Symbol) —

the configured XML adapter type (:nokogiri, :ox, etc.)



76
77
78

# File 'lib/lutaml/xml.rb', line 76

def self.adapter_type
  Lutaml::Model::Config.xml_adapter_type
end

.detect_xml_adapter ⇒ `Symbol`^?

Detect available XML adapter

Returns:

(Symbol, nil) —

:nokogiri, :ox, :oga, :rexml, or nil

# File 'lib/lutaml/xml.rb', line 47

def self.detect_xml_adapter
  return :oga if Lutaml::Model::RuntimeCompatibility.opal?
  return :nokogiri if Lutaml::Model::Utils.safe_load("nokogiri", :Nokogiri)
  return :ox if Lutaml::Model::Utils.safe_load("ox", :Ox)
  return :oga if Lutaml::Model::Utils.safe_load("oga", :Oga)
  return :rexml if Lutaml::Model::Utils.safe_load("rexml", :REXML)

  nil
end

Module: Lutaml::Xml

Defined Under Namespace

Class Method Summary collapse

Class Method Details

.adapter ⇒ Object

Examples:

Using the adapter

.adapter_type ⇒ Symbol

.detect_xml_adapter ⇒ Symbol?

.adapter ⇒ `Object`

.adapter_type ⇒ `Symbol`

.detect_xml_adapter ⇒ `Symbol`^?