Class: OpenNebula::XMLElement
- Inherits:
-
Object
- Object
- OpenNebula::XMLElement
- Defined in:
- lib/OpenNebula/XMLUtils.rb
Overview
The XMLElement class provides an abstraction of the underlying XML parser engine. It provides XML-related methods for the Pool and PoolElement classes
Direct Known Subclasses
Class Method Summary collapse
-
.build_xml(xml, root_element) ⇒ Object
- Builds a XML document xml
- String the XML document of the object root_element
-
String Base xml element [return] XML object for the underlying XML engine.
Instance Method Summary collapse
-
#[](key) ⇒ Object
Extract an element from the XML description of the PoolElement.
- #add_element(xpath, elems) ⇒ Object
-
#attr(key, name) ⇒ Object
- Gets an attribute from an elemenT key
- String xpath for the element name
-
String name of the attribute.
- #delete_element(xpath) ⇒ Object
-
#each(xpath_str, &block) ⇒ Object
- Iterates over every Element in the XPath and calls the block with a a XMLElement block
-
Block.
- #each_xpath(xpath_str, &block) ⇒ Object
-
#has_elements?(xpath_str) ⇒ Boolean
- Returns wheter there are elements for a given XPath xpath_str
-
String XPath expression to locate the element.
-
#initialize(xml = nil) ⇒ XMLElement
constructor
- xml
-
_opaque xml object_ an xml object as returned by build_xml.
-
#initialize_xml(xml, root_element) ⇒ Object
- Initialize a XML document for the element xml
- String the XML document of the object root_element
-
String Base xml element.
- #name ⇒ Object
-
#retrieve_elements(filter) ⇒ Object
Gets an array of text from elemenets extracted using the XPATH expression passed as filter.
-
#template_like_str(root_element, indent = true, xpath_exp = nil) ⇒ Object
- Returns elements in text form root_element
- String base element indent
- Boolean indents the resulting string, default true xpath_exp
-
String filter elements with a XPath.
-
#template_str(indent = true) ⇒ Object
- Returns the <TEMPLATE> element in text form indent
-
Boolean indents the resulting string, default true.
-
#template_xml ⇒ Object
Returns the <TEMPLATE> element in XML form.
- #text ⇒ Object
- #to_hash(hash = {}, element = nil) ⇒ Object
- #to_xml(pretty = false) ⇒ Object
Constructor Details
#initialize(xml = nil) ⇒ XMLElement
- xml
-
_opaque xml object_ an xml object as returned by build_xml
40 41 42 |
# File 'lib/OpenNebula/XMLUtils.rb', line 40 def initialize(xml=nil) @xml = xml end |
Class Method Details
.build_xml(xml, root_element) ⇒ Object
Builds a XML document
- xml
-
String the XML document of the object
- root_element
-
String Base xml element
- return
-
XML object for the underlying XML engine
69 70 71 72 73 74 75 76 77 78 79 80 81 |
# File 'lib/OpenNebula/XMLUtils.rb', line 69 def self.build_xml(xml, root_element) begin if NOKOGIRI doc = Nokogiri::XML(xml).xpath("/#{root_element}") else doc = REXML::Document.new(xml).root end rescue Exception => e return OpenNebula::Error.new(e.) end return doc end |
Instance Method Details
#[](key) ⇒ Object
Extract an element from the XML description of the PoolElement. key::String The name of the element
- return
-
String the value of the element
Examples:
['VID'] # gets VM id
['HISTORY/HOSTNAME'] # get the hostname from the history
88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 |
# File 'lib/OpenNebula/XMLUtils.rb', line 88 def [](key) if NOKOGIRI element=@xml.xpath(key.to_s) if element.size == 0 return nil end else element=@xml.elements[key.to_s] end if element element.text end end |
#add_element(xpath, elems) ⇒ Object
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 |
# File 'lib/OpenNebula/XMLUtils.rb', line 112 def add_element(xpath, elems) elems.each { |key, value| if value.instance_of?(Hash) if NOKOGIRI elem = Nokogiri::XML::Node.new key, @xml.document value.each { |k2, v2| child = Nokogiri::XML::Node.new k2, elem child.content = v2 elem.add_child(child) } @xml.xpath(xpath.to_s).first.add_child(elem) else elem = REXML::Element.new(key) value.each { |k2, v2| elem.add_element(k2).text = v2 } @xml.elements[xpath].add_element(elem) end else if NOKOGIRI elem = Nokogiri::XML::Node.new key, @xml.document elem.content = value @xml.xpath(xpath.to_s).first.add_child(elem) else @xml.elements[xpath].add_element(key).text = value end end } end |
#attr(key, name) ⇒ Object
Gets an attribute from an elemenT
- key
-
String xpath for the element
- name
-
String name of the attribute
168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 |
# File 'lib/OpenNebula/XMLUtils.rb', line 168 def attr(key,name) value = nil if NOKOGIRI element=@xml.xpath(key.to_s.upcase) if element.size == 0 return nil end attribute = element.attr(name) value = attribute.text if attribute != nil else element=@xml.elements[key.to_s.upcase] value = element.attributes[name] if element != nil end return value end |
#delete_element(xpath) ⇒ Object
104 105 106 107 108 109 110 |
# File 'lib/OpenNebula/XMLUtils.rb', line 104 def delete_element(xpath) if NOKOGIRI @xml.xpath(xpath.to_s).remove else @xml.delete_element(xpath.to_s) end end |
#each(xpath_str, &block) ⇒ Object
Iterates over every Element in the XPath and calls the block with a a XMLElement
- block
-
Block
192 193 194 195 196 197 198 199 200 201 202 |
# File 'lib/OpenNebula/XMLUtils.rb', line 192 def each(xpath_str,&block) if NOKOGIRI @xml.xpath(xpath_str).each { |pelem| block.call XMLElement.new(pelem) } else @xml.elements.each(xpath_str) { |pelem| block.call XMLElement.new(pelem) } end end |
#each_xpath(xpath_str, &block) ⇒ Object
204 205 206 207 208 209 210 211 212 213 214 |
# File 'lib/OpenNebula/XMLUtils.rb', line 204 def each_xpath(xpath_str,&block) if NOKOGIRI @xml.xpath(xpath_str).each { |pelem| block.call pelem.text } else @xml.elements.each(xpath_str) { |pelem| block.call pelem.text } end end |
#has_elements?(xpath_str) ⇒ Boolean
Returns wheter there are elements for a given XPath
- xpath_str
-
String XPath expression to locate the element
230 231 232 233 234 235 236 237 238 |
# File 'lib/OpenNebula/XMLUtils.rb', line 230 def has_elements?(xpath_str) if NOKOGIRI element = @xml.xpath(xpath_str.to_s.upcase) return element != nil && element.children.size > 0 else element = @xml.elements[xpath_str.to_s] return element != nil && element.has_elements? end end |
#initialize_xml(xml, root_element) ⇒ Object
Initialize a XML document for the element
- xml
-
String the XML document of the object
- root_element
-
String Base xml element
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 |
# File 'lib/OpenNebula/XMLUtils.rb', line 47 def initialize_xml(xml, root_element) @xml = XMLElement.build_xml(xml, root_element) if OpenNebula.is_error?(@xml) @xml = nil else if NOKOGIRI if @xml.size == 0 @xml = nil end else if @xml.name != root_element @xml = nil end end end end |
#name ⇒ Object
216 217 218 |
# File 'lib/OpenNebula/XMLUtils.rb', line 216 def name @xml.name end |
#retrieve_elements(filter) ⇒ Object
Gets an array of text from elemenets extracted using the XPATH expression passed as filter
144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 |
# File 'lib/OpenNebula/XMLUtils.rb', line 144 def retrieve_elements(filter) elements_array = Array.new if NOKOGIRI @xml.xpath(filter.to_s).each { |pelem| elements_array << pelem.text if pelem.text } else @xml.elements.each(filter.to_s) { |pelem| elements_array << pelem.text if pelem.text } end if elements_array.size == 0 return nil else return elements_array end end |
#template_like_str(root_element, indent = true, xpath_exp = nil) ⇒ Object
Returns elements in text form
- root_element
-
String base element
- indent
-
Boolean indents the resulting string, default true
- xpath_exp
-
String filter elements with a XPath
259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 |
# File 'lib/OpenNebula/XMLUtils.rb', line 259 def template_like_str(root_element, indent=true, xpath_exp=nil) if NOKOGIRI xml_template = @xml.xpath(root_element).to_s rexml = REXML::Document.new(xml_template).root else rexml = @xml.elements[root_element] end if indent ind_enter = "\n" ind_tab = ' ' else ind_enter = '' ind_tab = ' ' end str = rexml.elements.collect(xpath_exp) {|n| next if n.class != REXML::Element str_line = "" if n.has_elements? str_line << "#{n.name}=[#{ind_enter}" << n.collect { |n2| next if n2.class != REXML::Element or !n2.has_text? str = "#{ind_tab}#{n2.name}=#{attr_to_str(n2.text)}" }.compact.join(",#{ind_enter}") << " ]" else next if !n.has_text? str_line << "#{n.name}=#{attr_to_str(n.text)}" end str_line }.compact.join("\n") return str end |
#template_str(indent = true) ⇒ Object
Returns the <TEMPLATE> element in text form
- indent
-
Boolean indents the resulting string, default true
242 243 244 |
# File 'lib/OpenNebula/XMLUtils.rb', line 242 def template_str(indent=true) template_like_str('TEMPLATE', indent) end |
#template_xml ⇒ Object
Returns the <TEMPLATE> element in XML form
247 248 249 250 251 252 253 |
# File 'lib/OpenNebula/XMLUtils.rb', line 247 def template_xml if NOKOGIRI @xml.xpath('TEMPLATE').to_s else @xml.elements['TEMPLATE'].to_s end end |
#text ⇒ Object
220 221 222 223 224 225 226 |
# File 'lib/OpenNebula/XMLUtils.rb', line 220 def text if NOKOGIRI @xml.content else @xml.text end end |
#to_hash(hash = {}, element = nil) ⇒ Object
323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 |
# File 'lib/OpenNebula/XMLUtils.rb', line 323 def to_hash(hash={}, element=nil) element ||= @xml.document.root if NOKOGIRI array = element.children if array.length==1 and (array.first.text? or array.first.cdata?) r = array.first.text else r = {} array.each { |c| if c.element? to_hash(r, c) end } end else r = {} if element.has_elements? element.each_element { |c| to_hash(r, c) } elsif element.has_text? r = element.text end end key = element.name if hash.has_key?(key) if hash[key].instance_of?(Array) hash[key] << r else hash[key] = [hash[key], r] end else hash[key] = r end hash end |
#to_xml(pretty = false) ⇒ Object
303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 |
# File 'lib/OpenNebula/XMLUtils.rb', line 303 def to_xml(pretty=false) if NOKOGIRI && pretty str = @xml.to_xml elsif REXML_FORMATTERS && pretty str = String.new formatter = REXML::Formatters::Pretty.new formatter.compact = true formatter.write(@xml,str) else str = @xml.to_s end return str end |