Class: Tilia::Xml::Element::KeyValue

Inherits:
Object
  • Object
show all
Includes:
Tilia::Xml::Element
Defined in:
lib/tilia/xml/element/key_value.rb

Overview

‘KeyValue’ parses out all child elements from a single node, and outputs a key=>value struct.

Attributes will be removed, and duplicate child elements are discarded. Complex values within the elements will be parsed by the ‘standard’ parser.

For example, KeyValue will parse:

<?xml version=“1.0”?> <s:root xmlns:s=“sabredav.org/ns”>

<s:elem1>value1</s:elem1>
<s:elem2>value2</s:elem2>
<s:elem3 />

</s:root>

Into:

[

"{http://sabredav.org/ns}elem1" => "value1",
"{http://sabredav.org/ns}elem2" => "value2",
"{http://sabredav.org/ns}elem3" => null,

];

Class Method Summary collapse

Instance Method Summary collapse

Methods included from XmlDeserializable

#xml_deserialize

Constructor Details

#initialize(value = []) ⇒ KeyValue

Constructor

Parameters:

  • value (Array) (defaults to: []) 


32
33
34
 
# File 'lib/tilia/xml/element/key_value.rb', line 32

def initialize(value = [])
  @value = value
end

Class Method Details

.xml_deserialize(reader) ⇒ Object

The deserialize method is called during xml parsing.

This method is called statictlly, this is because in theory this method may be used as a type of constructor, or factory method.

Often you want to return an instance of the current class, but you are free to return other data as well.

You are responsible for advancing the reader to the next element. Not doing anything will result in a never-ending loop.

If you just want to skip parsing for this element altogether, you can just call $reader->next();

$reader->parseInnerTree() will parse the entire sub-tree, and advance to the next element.

Parameters:

Returns:

  • (Object) 


42
43
44
 
# File 'lib/tilia/xml/element/key_value.rb', line 42

def self.xml_deserialize(reader)
  Deserializer.key_value(reader)
end

Instance Method Details

#xml_serialize(writer) ⇒ void

This method returns an undefined value.

The xmlSerialize method is called during xml writing.

Use the $writer argument to write its own xml serialization.

An important note: do not create a parent element. Any element implementing XmlSerializble should only ever write what’s considered its ‘inner xml’.

The parent of the current element is responsible for writing a containing element.

This allows serializers to be re-used for different element names.

If you are opening new elements, you must also close them again.

Parameters:



37
38
39
 
# File 'lib/tilia/xml/element/key_value.rb', line 37

def xml_serialize(writer)
  writer.write(@value)
end