Module: Xyml_element

Included in:
Xyml::Element
Defined in:
lib/ixyml/xyml_element.rb

Overview

Xyml_element module is for handling a XYML tree data loaded from a XYML format file. (See Xyml module for detailed information of XYML.)

Xyml_elementモジュールは、XYML形式のファイルをロードして得たXYMLツリー構造データを 操作するためのモジュールである。XYML形式については、Xymlモジュールのドキュメントを参照してください。

(1) data model

In the APIs provided by this module, only “elements” in XYML tree data are treated as objects. Their attribures, related elements such as child elements and texts can be accessed via APIs of the elements.

(1)データモデル

本モジュールが提供するAPIでは、XYMLツリー構造データのエレメントのみオブジェクトとして扱われる。 その属性や子エレメントなどの関連エレメント、テキストへのアクセス手段が、エレメントのAPIとして提供される。

                        +-- element --------------------+
                        |                               |
access to attributes    |     +-- attributes ----+      |
------------------------+---->|                  |      |
                        |     +------------------+      |
                        |                               |
access to child nodes   |     +-- child nodes ---+      |
------------------------+---->|                  |      |
                        |     +------------------+      |
                        |                               |
access to text          |     +-- text -------------+   |   
------------------------+---->|                     |   |
                        |     +---------------------+   |
                        |                               |
access to parent element|     +-- parent element(*)-+   |
------------------------+---->|                     |   |
                        |     +---------------------+   |
                        +-------------------------------+
(*) data designating the parent element is attached when XYML tree data is constructed(e.g. when file loaded).

(2) Xyml::Element class

In XYML tree data, an element corresponds to a hash which has only one pair of key and value, where the key stands for the element name and the value is an array of attributes, child elements and texts. Note the key must be a symbol.

Xyml::Element class inherits Hash, includes this Xyml_element module, and has an array at the first place in its hash values. All methods except ‘.new’ of Xyml::Element class are in this Xyml_element module.

(2) Xyml::Elementクラス

XYMLツリー構造データでは、エレメントは、キー・バリュー対が一つだけのハッシュに対応する。 そのキーが要素名を表し、そのバリューは属性と子エレメントとテキストが要素である配列となる。

Xyml::Elementクラスは、ハッシュを継承し、このXyml_elementモジュールをインクルードし、ハッシュのバリューの先頭に配列を持つ。 ‘new’以外のXyml::Elementクラスのメソッドは、すべて本Xyml_elementモジュール内にある。

# |  XML            |   XYML         |     Xyml::Element class                        |
# | <a b='CCC'>     |  -a:           |      {a: [{b:'CCC'},{d:[{e:'FFF'},'text']}]}   |
# |   <d e="FFF">   |    -b: CCC     |                     ----------------------     |
# |    text         |    -d:         |                      Xyml::Element class       |
# |   </d>          |      -e: FFF   |      ---------------------------------------   |
# | </a>            |      - text    |                Xyml::Element class             |

(3) loaded XYML data

If you load XYML tree data from a XYML file by using the methods in Xyml module, the extensions to this Xyml_element module have already been done.

(3) ロードされたXYMLデータ

Xymlモジュール内のメソッドを使ってXYMLツリー構造データをファイルからロードした場合には、 このXyml_elemetモジュールへの拡張がすでに行われている。

(4) method names

The name of each method in this module is a seris of three short strings which stand for ‘operation’,‘object’ and ‘condition’ respectively.

(4) メソッド名

本モジュールのメソッド名は、操作(operation)/対象(object)/条件(condition)を表す文字列を 順に並べたものになっている。

.gcfn  -> g(oepration)       cf(object)                   n(condition)

      +-- operation --+  +-- object ---------------+  +-- condition(what designated?) --+
      | g : get       |  | c : children            |  | n : element name                |
      | a : add       |  | cf: first child         |  | a : attribute name and value    |
      | i : insert    |  | sl: self                |  | na: element and attribute       |
      | d : delete    |  | sp: previous sibling    |  +---------------------------------+
      | s : set       |  | ss: immediately         |
      +---------------+  |     succeeding sibling  |
                         | d : descendants         |
                         | df: first descendant    |
                         | p : parent              |
                         | r : root                |
                         | a : attribute           |
                         | t : text                |
                         +-------------------------+

(5) about usage examples

In the usage example for each method, it is assumed that the lines of program code shown below have already done(see Xyml module).

(5) 使用例について

メソッドの使用例については、次のプログラムに続けて行われているものとする(Xymlモジュール参照)。

# aaa.xyml
# - a:
#   - b: ccc
#   - d:
#     - e: fff
#     - h:
#       -e: ggg
#   - d:
#     - e: ggg
#     - text
#   - h:
#     - e: fff
xyml_tree=Xyml::Document.new(File.open("aaa.xyml"))
#-> [{a:[{b:'ccc'},{d:[{e:'fff'},{h:[{e:'ggg'}]}]},{d:[{e:'ggg'},'text']},{h:[{e:'fff'}]}]}]

Instance Method Summary collapse

Instance Method Details

#_dp ⇒ Object

delete the parent element information.

親エレメント情報の削除

Note

this method is for the Xyml and Xyml_element package development use, not for users.

このメソッドは、Xyml、および、Xyml_elementモジュールの開発向けのものであり、ユーザ向けではない。



793
794
795
 
# File 'lib/ixyml/xyml_element.rb', line 793

def _dp
  (self.keys.size-1).times{|i| self.delete(self.keys[i+1])}
end

#_sp(parent) ⇒ Object

set a parent element information.

親エレメント情報の設定

Args.

parent

parent element

parent

親エレメント

Note

This method is for the Xyml and Xyml_element module development use, not for users. Use ‘ac(add child)’ instead.

このメソッドは、Xyml、および、Xyml_elementモジュールの開発向けのものであり、ユーザ向けではない。 ユーザは“ac(add child)”を使用してください。



776
777
778
779
780
781
782
783
784
 
# File 'lib/ixyml/xyml_element.rb', line 776

def _sp parent
  self._dp
  if self.keys[0]==:_parent then
    self[:__parent]=parent
  else
    self[:_parent]=parent
  end
  self
end

#ac(elm) ⇒ Object

add a child element.

子エレメントの追加。

Args

elm

an element to add(or a hash that can extend Xyml_element module).

elm

追加するエレメント(もしくは、Xyml_elementモジュールを拡張しうるハッシュ)

Return

the element added(or nil if Xyml_element module can be extended).

追加されたエレメント(Xyml_elementモジュールを拡張出来ない場合は‘nil’)

Note

This method make the input object extend Xyml_element module.

このメソッドは、入力に対して、Xyml_elemenntモジュールの拡張を実施させる

my_element=xyml_tree.root.gcfna 'd','e','ggg'
#-> {d:[{e:"ggg"},'text']}
my_element.ac {j:[{e:'kkk'}]}
my_element.gcf
#-> {j:[{e:"kkk"}]}
xyml_tree
#-> [{a:[{b:'ccc'},{d:[{e:'fff'},{h:[{e:'ggg'}]}]},{d:[{e:'ggg'},'text',{j:[e:"kkk"]}]},{h:[{e:'fff'}]}]}]  #<- element was added next to text.
my_element.st(my_elment.gt)  #<- text was unset and set again.
xyml_tree
#-> [{a:[{b:'ccc'},{d:[{e:'fff'},{h:[{e:'ggg'}]}]},{d:[{e:'ggg'},{j:[e:"kkk"]},'text']},{h:[{e:'fff'}]}]}]  #<- text next to added element.



484
485
486
487
488
489
490
 
# File 'lib/ixyml/xyml_element.rb', line 484

def ac elm
  return nil unless elm.is_a?(Hash) and elm.values[0].is_a?(Array)
  elm.extend Xyml_element
  self.values[0].push(elm)
  elm._sp(self)
  elm
end

#at(value) ⇒ Object

add text.

テキストの追加

Args

text

text(or object with the method ‘to_s’)

text

テキスト(もしくは、‘to_s’メソッドを持つオブジェクト)

Return

element itself.

エレメント自身。

Note

the added text is stored in the last position on the element’s array. see ‘gt.’

追加されたテキストは、エレメントの配列に末尾に格納される。gtメソッド参照。

my_element=xyml_tree.root.gcfna 'd','e','ggg'
#-> {d:[{e:"ggg"},'text']}
my_element.at 'abc'
my_element.gt
#-> 'textabc'



758
759
760
761
762
 
# File 'lib/ixyml/xyml_element.rb', line 758

def at value
  value=value.to_s
  self.values[0].push value
  self
end

#da(aname) ⇒ Object

delete attribute.

指定された属性名に対する属性の削除

Args

aname

attribute name(string or symbol)

aname

属性名(文字列もしくはシンボル)

Return

element itself, or nil if no attribute with the designated name.

エレメント自身(指定された属性名の属性が無い場合は、nil)

xyml_tree.root.da(:b)
xyml_tree.root.ga(:b)
#-> nil



647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
 
# File 'lib/ixyml/xyml_element.rb', line 647

def da aname
  aname=aname.intern if aname.is_a?(String)
  self.values[0].each_with_index do |child,index|
    if child.is_a?(Hash)
      #p "#D#syml_element.rb:sa:aname=#{aname},avalue=#{avalue},child=#{child}"
      if child.values[0].is_a?(Array) then
        return nil
      end
      if child.keys[0]==aname && !child.values[0].is_a?(Array) then
        self.values[0].delete_at(index)
        return self
      end
    elsif child.is_a?(String) then
      return nil
    end
  end
  nil
end

#dsl ⇒ Object

delete the self element from the child element array of its parent element.

自身のエレメントを、親エレメントの子エレメント配列から、削除する。

Return

the deleted element, or nil if no parent element.

削除されたエレメント（もしくは、親エレメントが無い場合、“nil”）

xyml_tree.root.gcfna('d','e','ggg').dsl
#-> [{a:[{b:'ccc'},{d:[{e:'fff'}]},{h:[{e:'fff'}]}]}]



861
862
863
864
865
866
867
868
869
870
871
872
873
 
# File 'lib/ixyml/xyml_element.rb', line 861

def dsl
  if parent=self.gp then
    parent.values[0].each_with_index do |child,index|
      if child==self then
        parent.values[0].delete_at(index)
        self._sp(nil)
        return child
      end
    end
    raise "something wrong. parent does not have me as a child."
  end
  nil
end

#ga(aname) ⇒ Object

get value of attribute with the designated attribute name.

指定された属性名に対する属性値の取得

Args

aname

attribute name(string or symbol)

aname

属性名(文字列もしくはシンボル)

xyml_tree.root.ga(:b)
#-> 'ccc'

Return

attribute value, or nil if no attribute with the designated name.

属性値(指定された属性名の属性が無い場合は、nil)



580
581
582
583
584
585
586
 
# File 'lib/ixyml/xyml_element.rb', line 580

def ga aname
  aname=aname.intern if aname.is_a?(String)
  self.values[0].each do |child|
    return child.values[0] if child.is_a?(Hash) && child.keys[0]==aname && (!child.values[0].is_a?(Hash) || !child.values[0].is_a?(Array))
  end
  nil
end

#gc ⇒ Object

get child elements.

子エレメントの取得

Return

an array of elements.

エレメントの配列

xyml_tree.root.gc
#-> [{d:[{e:"fff"},{h:[{e:'ggg'}]}},{d:[{e:"ggg"}]},{h:[{e:'fff'}]}]



145
146
147
148
149
150
151
 
# File 'lib/ixyml/xyml_element.rb', line 145

def gc
  array=Array.new
  self.values[0].each do |child|
    array << child if child.is_a?(Hash) && child.values[0].is_a?(Array)
  end
  array    
end

#gca(aname, avalue) ⇒ Object

get child elements with the designated atrribute.

指定された属性を持つ子エレメントの取得

Args

aname

attribute name(string or symbol)

avalue

attribute value

aname

属性名(文字列もしくはシンボル)

avalue

属性値

Return

an array of elements.

エレメントの配列

xyml_tree.root.gca 'e','fff'
#-> [{d:[{e:"fff"}]},{h:[{e:"fff"}]}]



318
319
320
321
322
323
324
325
 
# File 'lib/ixyml/xyml_element.rb', line 318

def gca aname,avalue
  aname=aname.intern if aname.is_a?(String)
  array=Array.new
  self.values[0].each do |child|
    array << child if child.is_a?(Hash) && child.values[0].is_a?(Array) && child.ga(aname)==avalue
  end
  array
end

#gcf ⇒ Object

get the first child element.

最初の子エレメントの取得

Return

an element, or nil if no children

エレメント（子エレメントが無い場合は‘nil’）

xyml_tree.root.gcf
#-> {d:[{e:'fff'},{h:[{e:'ggg'}]}]}



163
164
165
166
167
168
 
# File 'lib/ixyml/xyml_element.rb', line 163

def gcf
  self.values[0].each do |child|
    return child if child.is_a?(Hash) && child.values[0].is_a?(Array)
  end
  nil
end

#gcfn(ename) ⇒ Object

get the first child element with the designated name.

指定された名前を持つ最初の子エレメントの取得

Return

an element, or nil if no children with the designated name.

エレメント（指定された名前の子エレメントが無い場合は‘nil’）

xyml_tree.root.gcfn 'd'    #  or xyml_tree.root.gcfn :d
#-> {d:[{e:"fff"}]}



225
226
227
228
229
230
231
 
# File 'lib/ixyml/xyml_element.rb', line 225

def gcfn ename
  ename=ename.intern if ename.is_a?(String)
  self.values[0].each do |child|
    return child if child.is_a?(Hash) && child.keys[0]==ename && child.values[0].is_a?(Array)
  end
  nil
end

#gcfna(ename, aname, avalue) ⇒ Object

get the first child elements with the designated element name and atrribute.

指定された名前と属性を持つ最初の子エレメントの取得

Args

ename

element name(string or symbol)

aname

attribute name(string or symbol)

avalue

attribute value

ename

エレメント名(文字列もしくはシンボル)

aname

属性名(文字列もしくはシンボル)

avalue

属性値

Return

an element, or nil if no children with the designated name and attribute.

エレメント（指定された名前と属性の子エレメントが無い場合は‘nil’）

xyml_tree.root.gcfna 'd','e','ggg'
#-> {d:[{e:"ggg"},'text']}



368
369
370
371
372
373
374
375
 
# File 'lib/ixyml/xyml_element.rb', line 368

def gcfna ename,aname,avalue
  ename=ename.intern if ename.is_a?(String)
  aname=aname.intern if aname.is_a?(String)
  self.values[0].each do |child|
    return child if child.is_a?(Hash) && child.keys[0]==ename && child.values[0].is_a?(Array) && child.ga(aname)==avalue
  end
  nil
end

#gcn(ename) ⇒ Object

get child elements with the designated name.

指定された名前を持つ子エレメントの取得

Args

ename

element name(string or symbol).

ename

エレメント名(文字列もしくはシンボル)

Return

an array of elements.

エレメントの配列

xyml_tree.root.gcn 'd'    #  or xyml_tree.root.gcn :d 
#-> [{d:[{e:"fff"},{h:[{e:'ggg'}]}]},{d:[{e:"ggg"},'text']}]



184
185
186
187
188
189
190
191
 
# File 'lib/ixyml/xyml_element.rb', line 184

def gcn ename
  ename=ename.intern if ename.is_a?(String)
  array=Array.new
  self.values[0].each do |child|
    array << child if child.is_a?(Hash) && child.keys[0]==ename && child.values[0].is_a?(Array)
  end
  array
end

#gcna(ename, aname, avalue) ⇒ Object

get child elements with the designated element name and atrribute.

指定された名前と属性を持つ子エレメントの取得

Args

ename

element name(string or symbol)

aname

attribute name(string or symbol)

avalue

attribute value

ename

エレメント名(文字列もしくはシンボル)

aname

属性名(文字列もしくはシンボル)

avalue

属性値

Return

an array of elements.

エレメントの配列

xyml_tree.root.gcna 'd','e','ggg'
#-> [{d:[{e:"ggg"},'text']}]



266
267
268
269
270
271
272
273
274
 
# File 'lib/ixyml/xyml_element.rb', line 266

def gcna ename,aname,avalue
  ename=ename.intern if ename.is_a?(String)
  aname=aname.intern if aname.is_a?(String)
  array=Array.new
  self.values[0].each do |child|
    array << child if child.is_a?(Hash) && child.keys[0]==ename && child.values[0].is_a?(Array) && child.ga(aname)==avalue
  end
  array
end

#gda(aname, avalue) ⇒ Object

get descendant elements with the designated atrribute.

指定された属性を持つ子孫エレメントの取得

Args

aname

attribute name(string or symbol)

avalue

attribute value

aname

属性名(文字列もしくはシンボル)

avalue

属性値

Return

an array of elements.

エレメントの配列

xyml_tree.root.gca 'e','ggg'
#-> [{h:[{e:"ggg"}]},{d:[{e:"ggg"}]}]



343
344
345
346
347
348
 
# File 'lib/ixyml/xyml_element.rb', line 343

def gda aname,avalue
  aname=aname.intern if aname.is_a?(String)
  array=Array.new
  gda_rcsv self,array,aname,avalue
  array
end

#gdfn(ename) ⇒ Object

get the first(depth-first search) descendant element with the designated name.

指定された名前を持つ(深さ優先探索での)最初の子孫エレメントの取得

Return

an element, or nil if no descendant element with the designated name.

エレメント（指定された名前の子孫エレメントが無い場合は‘nil’）

xyml_tree.root.gdfn 'h'    #  or xyml_tree.root.gcfn :h
#-> {h:[{e:"ggg"}]}



243
244
245
246
 
# File 'lib/ixyml/xyml_element.rb', line 243

def gdfn ename
  ename=ename.intern if ename.is_a?(String)
  return gdfn_rcsv self,ename
end

#gdfna(ename, aname, avalue) ⇒ Object

get the first(depth-first search) descendant elements with the designated element name and atrribute.

指定された名前と属性を持つ最初の子孫エレメントの取得

Args

ename

element name(string or symbol)

aname

attribute name(string or symbol)

avalue

attribute value

ename

エレメント名(文字列もしくはシンボル)

aname

属性名(文字列もしくはシンボル)

avalue

属性値

Return

an element, or nil if no descendant with the designated name and attribute.

エレメント（指定された名前と属性の子孫エレメントが無い場合は‘nil’）

xyml_tree.root.gcfna 'h','e','ggg'
#-> {h:[{e:"ggg"}]}



395
396
397
398
399
 
# File 'lib/ixyml/xyml_element.rb', line 395

def gdfna ename,aname,avalue
  ename=ename.intern if ename.is_a?(String)
  aname=aname.intern if aname.is_a?(String)
  return gdfna_rcsv self,ename,aname,avalue
end

#gdn(ename) ⇒ Object

get descendant elements with the designated name.

指定された名前を持つ子孫エレメントの取得

Args

ename

element name(string or symbol).

ename

エレメント名(文字列もしくはシンボル)

Return

an array of elements.

エレメントの配列

xyml_tree.root.gdn 'h'    #  or xyml_tree.root.gdn :h
#-> [{h:[{e:"ggg"}]},{h:[{e:"fff"},'text']}]



207
208
209
210
211
212
 
# File 'lib/ixyml/xyml_element.rb', line 207

def gdn ename
  ename=ename.intern if ename.is_a?(String)
  array=Array.new
  gdn_rcsv self,array,ename
  array
end

#gdna(ename, aname, avalue) ⇒ Object

get descendant elements with the designated element name and atrribute.

指定された名前と属性を持つ子孫エレメントの取得

Args

ename

element name(string or symbol)

aname

attribute name(string or symbol)

avalue

attribute value

ename

エレメント名(文字列もしくはシンボル)

aname

属性名(文字列もしくはシンボル)

avalue

属性値

Return

an array of elements.

エレメントの配列

xyml_tree.root.gcna 'h','e','ggg'
#-> [{h:[{e:"ggg"}]}]



294
295
296
297
298
299
300
 
# File 'lib/ixyml/xyml_element.rb', line 294

def gdna ename,aname,avalue
  ename=ename.intern if ename.is_a?(String)
  aname=aname.intern if aname.is_a?(String)
  array=Array.new
  gdna_rcsv self,array,ename,aname,avalue
  array
end

#gp ⇒ Object

get the parent element.

親エレメントの取得。

Return

the parent element, or nil if no parent element.

エレメント（もしくは、親エレメントが無い場合、“nil”）

my_element=xyml_tree.root.gcfna 'd','e','ggg'
my_element.gp
#-> {a:[...]}



808
809
810
811
812
813
814
815
 
# File 'lib/ixyml/xyml_element.rb', line 808

def gp
  parent=self.values[1]
  if parent==:_iamroot then
    nil
  else
    parent
  end
end

#gr ⇒ Object

get the root element.

ルートエレメントの取得

Return

the root element, or nil if no root element.

ルートエレメント（もしくは、ルートエレメントが無い場合、“nil”）

new_element=Xyml::Element.new(:j)
xyml_tree.root.gcfna('d','e','ggg').ac new_element
new_element.gr
#-> {a:[...]}



828
829
830
831
832
833
834
835
836
837
838
 
# File 'lib/ixyml/xyml_element.rb', line 828

def gr
  elm=self
  while true do
    if elm.values[1]==:_iamroot then
      return elm
    elsif elm.values[1]==nil then
      return nil
    end
    elm=elm.values[1]
  end
end

#gsp ⇒ Object

get the previous sibling element.

直前のシブリング(兄弟姉妹)エレメントの取得。

Return

an element, or nil if no previous sibling element.

エレメント（自身が最初の子エレメントの場合は‘nil’）

my_element=xyml_tree.root.gcfna 'd','e','ggg'
#-> {d:[{e:"ggg"},'text']}
my_element.gsp
#-> {d:[{e:"fff"},{h:[{e:'ggg'}]}]}



413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
 
# File 'lib/ixyml/xyml_element.rb', line 413

def gsp
  if parent=self.gp then
    siblings=parent.gc
    #print "#D#xyml_element.rb:gsp:sliblings=";pp siblings
    siblings.each_with_index do |sibling,index|
      if sibling==self then
        if index==0 then
          return nil
        else
          return siblings[index-1]
        end
      end
    end
  end
end

#gss ⇒ Object

get the immediately succeeding sibling element.

直後のシブリング(兄弟姉妹)エレメントの取得。

Return

an element, or nil if no next sibling element.

エレメント（自身が最後の子エレメントの場合は‘nil’）

my_element=xyml_tree.root.gcfna 'd','e','ggg'
#-> {d:[{e:"ggg"},'text']}
my_element.gss
#-> {h:[{e:"fff"}]}



441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
 
# File 'lib/ixyml/xyml_element.rb', line 441

def gss
  if parent=self.gp then
    siblings=parent.gc
    #print "#D#xyml_element.rb:gsp:sliblings=";pp siblings
    siblings.each_with_index do |sibling,index|
      if sibling==self then
        if index==siblings.length-1 then
          return nil
        else
          return siblings[index+1]
        end
      end
    end
  end
end

#gt(param = false) ⇒ Object

get text.

テキストの取得

Args

param

return joined text if omitted. Return the array of parted text if “:raw” is designated.

param

省略時は、結合されたテキストを返す。“:raw”が指定された場合は、分かち書きされたテキストの配列を返す。

Return

String (or Array of Strings if :raw is designated as param)

文字列 (もしくは、：rawが指定された場合は、文字列の配列)

my_element=xyml_tree.root.gcfna 'd','e','ggg'
#-> {d:[{e:"ggg"},'text']}
my_element.gt
#-> 'text'
my_element.at 'abc'
my_element.gt
#-> 'textabc'
my_element.gt :raw
#-> ['text','abc']



688
689
690
691
692
693
694
695
696
697
698
699
700
701
 
# File 'lib/ixyml/xyml_element.rb', line 688

def gt(param=false)
  array=Array.new
  self.values[0].each do |child|
    unless child.is_a?(Hash) || child.is_a?(Array)
      array.push child
    end
  end
  if param then
    if param==:raw then
      return array
    end
  end
  array.join
end

#is_root? ⇒ Boolean

if root, return true

ルートの場合、trueを返す。

xyml_tree.root.is_root?
#-> true
xyml_tree.root.gcfna('d','e','ggg').is_root?
#-> false

Returns:

  • (Boolean) 


847
848
849
 
# File 'lib/ixyml/xyml_element.rb', line 847

def is_root?
  self.values[1]==:_iamroot
end

#isp(elm) ⇒ Object

insert an element as a previous sibling element.

直前のシブリング(兄弟姉妹)エレメントとして、エレメントを挿入

Args

elm

an element to insert(or a hash that can extend Xyml_element module).

elm

挿入するエレメント(もしくは、Xyml_elementモジュールを拡張しうるハッシュ)

Return

the inserted element.

挿入されたエレメント

Note

This method make the input extend Xyml_element module.

このメソッドは、入力に対して、Xyml_elemenntモジュールの拡張を実施させる

my_element=xyml_tree.root.gcfna 'd','e','ggg'
#-> {d:[{e:"ggg"},'text']}
my_element.isp {j:[{e:'kkk'}]}
my_element.gsp
#-> {j:[{e:"kkk"}]}
xyml_tree
#-> [{a:[{b:'ccc'},{d:[{e:'fff'},{h:[{e:'ggg'}]}]},{j:[{e:"kkk"}]},{d:[{e:'ggg'},'text']},{h:[{e:'fff'}]}]}]



515
516
517
518
519
520
521
522
523
524
525
526
527
 
# File 'lib/ixyml/xyml_element.rb', line 515

def isp elm
  return nil if self.gp==:_iamroot
  elm.extend Xyml_element
  parent=self.gp
  parent.values[0].each_with_index do |sibling,index|
    if sibling==self then
      parent.values[0].insert(index,elm)
      elm._sp(parent)
      break
    end
  end
  elm
end

#iss(elm) ⇒ Object

insert an element as an immediately succeeding sibling element.

直後のシブリング(兄弟姉妹)エレメントとして、エレメントを挿入

Args

elm

an element to insert(or a hash that can extend Xyml_element module).

elm

挿入するエレメント(もしくは、Xyml_elementモジュールを拡張しうるハッシュ)

Return

the inserted element.

挿入されたエレメント

Note

This method make the input extend Xyml_element module.

このメソッドは、入力に対して、Xyml_elemenntモジュールの拡張を実施させる

my_element=xyml_tree.root.gcfna 'd','e','ggg'
#-> {d:[{e:"ggg"},'text']}
my_element.iss {j:[{e:'kkk'}]}
my_element.gss
#-> {j:[{e:"kkk"}]}
xyml_tree
#-> [{a:[{b:'ccc'},{d:[{e:'fff'},{h:[{e:'ggg'}]}]},{d:[{e:'ggg'},'text']},{j:[{e:"kkk"}]},{h:[{e:'fff'}]}]}]



552
553
554
555
556
557
558
559
560
561
562
563
564
 
# File 'lib/ixyml/xyml_element.rb', line 552

def iss elm
  return nil if self.gp==:_iamroot
  elm.extend Xyml_element
  parent=self.gp
  parent.values[0].each_with_index do |sibling,index|
    if sibling==self then
      parent.values[0].insert(index+1,elm)
      elm._sp(parent)
      break
    end
  end
  elm
end

#name ⇒ Object

return element’s name

エレメントの名前を返す。



130
131
132
 
# File 'lib/ixyml/xyml_element.rb', line 130

def name
  self.keys[0]
end

#sa(aname, avalue) ⇒ Object

set value to the attribute with the designated attribute name.

指定された属性名に対する属性値の設定

Args

aname

attribute name(string or symbol)

avalue

attribute value

aname

属性名(文字列もしくはシンボル)

avalue

属性値

Return

element itself.

エレメント自身

xyml_tree.root.sa(:b,'lll')
xyml_tree.root.ga(:b)
#-> 'lll'
my_element=xyml_tree.root.gcfna 'd','e','ggg'
#-> {d:[{e:"ggg"},'text']}
my_element.sa(:e,'lll').sa(:m,'nnn')
#-> {d:[{e:"lll"},{m:"nnn"},'text']}



609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
 
# File 'lib/ixyml/xyml_element.rb', line 609

def sa aname,avalue
  aname=aname.intern if aname.is_a?(String)
  return nil if avalue.is_a?(Array) || avalue.is_a?(Hash)
  self.values[0].each_with_index do |child,index|
    if child.is_a?(Hash)
      #p "#D#syml_element.rb:sa:aname=#{aname},avalue=#{avalue},child=#{child}"
      if child.values[0].is_a?(Array) then
        self.values[0].insert(index,Hash[aname,avalue])
        return self
      end
      if child.keys[0]==aname && !child.values[0].is_a?(Array) then
        child[aname]=avalue
        return self
      end
    elsif child.is_a?(String) then
      self.values[0].insert(index,Hash[aname,avalue])
      return self
    end
  end
  values[0].push Hash[aname,avalue]
  self
end

#st(value) ⇒ Object

set text.

テキストの設定

Args

text

text(or object with the method ‘to_s’), or nil if deleting text.

text

テキスト(もしくは、‘to_s’メソッドを持つオブジェクト)、もしくはnil(テキストを消したい場合)

Return

element itself.

エレメント自身。

my_element=xyml_tree.root.gcfna 'd','e','ggg'
#-> {d:[{e:"ggg"},'text']}
my_element.st 'abc'
my_element.gt
#-> 'abc'
my_elemet.st nil
my_element.gt
#-> ''



723
724
725
726
727
728
729
730
731
732
733
734
735
 
# File 'lib/ixyml/xyml_element.rb', line 723

def st value
  #p "#D#xyml_element.rb:st:(1)caller=#{caller[0]}"
  value=value.to_s
  tempArray=Array.new
  self.values[0].each do |child|
    unless child.is_a?(String)
      tempArray.push child
    end
  end
  self[keys[0]]=tempArray
  self.values[0].push value if value
  self
end