Class: Lutaml::Xml::DataModel::XmlElement

Inherits:
Object
  • Object
show all
Defined in:
lib/lutaml/xml/data_model.rb

Overview

Represents an XML element with namespace, attributes, and children.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, namespace_class = nil, explicit_namespace: false) ⇒ XmlElement

Initialize a new XML element

Parameters:

  • name (String) —

    Element local name

  • namespace_class (Class, nil) (defaults to: nil) —

    XmlNamespace class

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

    Whether namespace was explicitly set on this element (true = from rule’s namespace; false = inherited from parent or no namespace)



65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/lutaml/xml/data_model.rb', line 65

def initialize(name, namespace_class = nil, explicit_namespace: false)
  @name = name
  @namespace_class = namespace_class
  @explicit_namespace = explicit_namespace
  @attributes = []
  @children = []
  @text_content = nil
  @cdata = false
  @form = nil
  @processing_instructions = []
end

Instance Attribute Details

#attributes ⇒ Array<XmlAttribute> (readonly)

Returns Element attributes.

Returns:



20
21
22
 
# File 'lib/lutaml/xml/data_model.rb', line 20

def attributes
  @attributes
end

#cdata ⇒ Boolean

Returns Whether text content should be wrapped in CDATA section.

Returns:

  • (Boolean) —

    Whether text content should be wrapped in CDATA section



29
30
31
 
# File 'lib/lutaml/xml/data_model.rb', line 29

def cdata
  @cdata
end

#children ⇒ Array<XmlElement, String> (readonly)

Returns Child elements and text nodes.

Returns:

  • (Array<XmlElement, String>) —

    Child elements and text nodes



23
24
25
 
# File 'lib/lutaml/xml/data_model.rb', line 23

def children
  @children
end

#explicit_namespace ⇒ Boolean (readonly)

Whether this element’s namespace was explicitly declared (from mapping rule) vs inherited from parent or unset.

Returns:

  • (Boolean) 


81
82
83
 
# File 'lib/lutaml/xml/data_model.rb', line 81

def explicit_namespace
  @explicit_namespace
end

#form ⇒ Symbol?

Returns Form option (:qualified, :unqualified, or nil) :qualified forces prefix format, :unqualified forces default format.

Returns:

  • (Symbol, nil) —

    Form option (:qualified, :unqualified, or nil) :qualified forces prefix format, :unqualified forces default format



33
34
35
 
# File 'lib/lutaml/xml/data_model.rb', line 33

def form
  @form
end

#name ⇒ String

Returns Element local name.

Returns:

  • (String) —

    Element local name



14
15
16
 
# File 'lib/lutaml/xml/data_model.rb', line 14

def name
  @name
end

#namespace_class ⇒ Class?

Returns XmlNamespace class (not instance).

Returns:

  • (Class, nil) —

    XmlNamespace class (not instance)



17
18
19
 
# File 'lib/lutaml/xml/data_model.rb', line 17

def namespace_class
  @namespace_class
end

#namespace_scope_config ⇒ Array?

Returns Namespace scope configuration (for hoisting).

Returns:

  • (Array, nil) —

    Namespace scope configuration (for hoisting)



51
52
53
 
# File 'lib/lutaml/xml/data_model.rb', line 51

def namespace_scope_config
  @namespace_scope_config
end

#needs_xmlns_blank ⇒ Boolean

Returns Whether element needs xmlns=“” declaration.

Returns:

  • (Boolean) —

    Whether element needs xmlns=“” declaration



36
37
38
 
# File 'lib/lutaml/xml/data_model.rb', line 36

def needs_xmlns_blank
  @needs_xmlns_blank
end

#original_namespace_uri ⇒ String?

Returns Original namespace URI (for alias support).

Returns:

  • (String, nil) —

    Original namespace URI (for alias support)



48
49
50
 
# File 'lib/lutaml/xml/data_model.rb', line 48

def original_namespace_uri
  @original_namespace_uri
end

#original_xml_element ⇒ Lutaml::Xml::XmlElement?

Returns Original parsed XmlElement (for prefix fallback).

Returns:



54
55
56
 
# File 'lib/lutaml/xml/data_model.rb', line 54

def original_xml_element
  @original_xml_element
end

#processing_instructions ⇒ Array<XmlProcessingInstruction> (readonly)

Returns Processing instructions before this element.

Returns:



57
58
59
 
# File 'lib/lutaml/xml/data_model.rb', line 57

def processing_instructions
  @processing_instructions
end

#raw_content ⇒ String?

Returns Raw XML content for map_all custom methods.

Returns:

  • (String, nil) —

    Raw XML content for map_all custom methods



42
43
44
 
# File 'lib/lutaml/xml/data_model.rb', line 42

def raw_content
  @raw_content
end

#text_content ⇒ String?

Returns Direct text content (for simple elements).

Returns:

  • (String, nil) —

    Direct text content (for simple elements)



26
27
28
 
# File 'lib/lutaml/xml/data_model.rb', line 26

def text_content
  @text_content
end

#xml_namespace_prefix ⇒ String?

Returns XML namespace prefix (for doubly-defined namespace support).

Returns:

  • (String, nil) —

    XML namespace prefix (for doubly-defined namespace support)



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

def xml_namespace_prefix
  @xml_namespace_prefix
end

#xsi_nil ⇒ Boolean

Returns Whether element was created from nil value with render_nil.

Returns:

  • (Boolean) —

    Whether element was created from nil value with render_nil



39
40
41
 
# File 'lib/lutaml/xml/data_model.rb', line 39

def xsi_nil
  @xsi_nil
end

Instance Method Details

#add_attribute(attribute) ⇒ self

Add an attribute to this element

Parameters:

Returns:

  • (self) 


104
105
106
107
 
# File 'lib/lutaml/xml/data_model.rb', line 104

def add_attribute(attribute)
  @attributes << attribute
  self
end

#add_child(child) ⇒ self

Add a child element or text node

Parameters:

Returns:

  • (self)

Raises:

  • (TypeError) —

    if child is not a supported type



88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/lutaml/xml/data_model.rb', line 88

def add_child(child)
  unless child.is_a?(XmlElement) || child.is_a?(String) ||
      child.is_a?(XmlComment)
    raise TypeError,
          "XmlElement#add_child expects XmlElement, String, or " \
          "XmlComment, got #{child.class}"
  end

  @children << child
  self
end

#add_processing_instruction(target, content) ⇒ Object 



109
110
111
112
113
 
# File 'lib/lutaml/xml/data_model.rb', line 109

def add_processing_instruction(target, content)
  @processing_instructions << XmlProcessingInstruction.new(target,
                                                           content)
  self
end

#has_attributes? ⇒ Boolean

Check if element has any attributes

Returns:

  • (Boolean) 


125
126
127
 
# File 'lib/lutaml/xml/data_model.rb', line 125

def has_attributes?
  !@attributes.empty?
end

#has_children? ⇒ Boolean

Check if element has any children

Returns:

  • (Boolean) 


118
119
120
 
# File 'lib/lutaml/xml/data_model.rb', line 118

def has_children?
  !@children.empty?
end

#inspect ⇒ String

Detailed inspection for debugging

Returns:

  • (String) 


171
172
173
 
# File 'lib/lutaml/xml/data_model.rb', line 171

def inspect
  "#<#{self.class.name} #{self}>"
end

#qualified_name(prefix = nil) ⇒ String

Get qualified name (prefix:name or name)

Parameters:

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

    Optional prefix override

Returns:

  • (String) 


133
134
135
136
137
138
139
140
141
142
 
# File 'lib/lutaml/xml/data_model.rb', line 133

def qualified_name(prefix = nil)
  if prefix
    "#{prefix}:#{name}"
  elsif namespace_class.respond_to?(:prefix_default)
    ns_prefix = namespace_class.prefix_default
    ns_prefix ? "#{ns_prefix}:#{name}" : name
  else
    name
  end
end

#to_s ⇒ String

String representation for debugging

Returns:

  • (String) 


147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/lutaml/xml/data_model.rb', line 147

def to_s
  parts = ["<#{qualified_name}"]

  if namespace_class
    parts << " (ns: #{namespace_class})"
  end

  if has_attributes?
    parts << " attrs: #{attributes.length}"
  end

  if text_content
    parts << " text: #{text_content.inspect}"
  elsif has_children?
    parts << " children: #{children.length}"
  end

  parts << ">"
  parts.join
end