Class: REXML::Elements

A class which provides filtering of children for Elements, and XPath search support. You are expected to only encounter this class as the element.elements object. Therefore, you are not expected to instantiate this yourself.

Elementsへの子のフィルタを提供するクラスで、XPath検索をサポートしています。あなたはelement.elementsオブジェクトのようにこのクラスと遭遇することだけが期待されています。したがって、あなたはこのクラスをあなたがインスタンス化することは期待されて_いません_。

Constructor

parent:

the parent Element

こんすとらくた

parent:

親のElementです。

Fetches a child element. Filters only Element children, regardless of the XPath match.

index:	the search parameter. This is either an Integer, which will be used to find the index'th child Element, or an XPath, which will be used to search for the Element. Because of the nature of XPath searches, any element in the connected XML document can be fetched through any other element. The Integer index is 1-based, not 0-based. This means that the first child element is at index 1, not 0, and the +n+th element is at index `n`, not `n-1`. This is because XPath indexes element children starting from 1, not 0, and the indexes should be the same.
name:	optional, and only used in the first argument is an Integer. In that case, the index'th child Element that has the supplied name will be returned. Note again that the indexes start at 1.
Returns:	the first matching Element, or nil if no child matched

 doc = Document.new '<a><b/><c id="1"/><c id="2"/><d/></a>'
 doc.root.elements[1]       #-> <b/>
 doc.root.elements['c']     #-> <c id="1"/>
 doc.root.elements[2,'c']   #-> <c id="2"/>

子の要素を手に入れます。XPathマッチとは無関係にElementの子だけのフィルタです。

index:	検索するパラメータです。これは、index番目の子Elementを探すために使われるIntegerか、Elementを探すために使われるXPathです。 XPath検索の性質のため、XML文書に接続しているいかなる要素でもいかなる他の要素から手に入れられることができます。 Integerのインデックスは0ベースではなく、1べーすです。これは最初の子の要素のインデックスが0ではなく1から始まることを意味しています。`n`番目の要素のインデックスは`n`で`n-1` ではありません。これは、XPathが要素の子を0からではなく1からインデックスをつけるからで、それと同じくするべきだからです。
name:	任意(オプション)で、最初の引数がIntegerの時に使われます。この場合は、与えられたnameを持つindex番目の子Elementが返されるでしょう。インデックスが1から始まることに注意して下さい。
戻り値:	最初にマッチしたElementです。もし、マッチしなかったら

 doc = Document.new '<a><b/><c id="1"/><c id="2"/><d/></a>'
 doc.root.elements[1]       #-> <b/>
 doc.root.elements['c']     #-> <c id="1"/>
 doc.root.elements[2,'c']   #-> <c id="2"/>

Sets an element, replacing any previous matching element. If no existing element is found ,the element is added.

index:	Used to find a matching element to replace. See []().
element:	The element to replace the existing element with the previous element
Returns:	nil if no previous element was found.

 doc = Document.new '<a/>'
 doc.root.elements[10] = Element.new('b')    #-> <a><b/></a>
 doc.root.elements[1]                        #-> <b/>
 doc.root.elements[1] = Element.new('c')     #-> <a><c/></a>
 doc.root.elements['c'] = Element.new('d')   #-> <a><d/></a>

前にマッチしているいかなる要素を置き換えて設定します。もし、要素が存在しないことがわかったら、要素を追加します。

index:	置換する要素にマッチする要素を探すために使われます。[]() をみて下さい。
element:	前の要素と共に存在する要素を置換する要素です。
戻り値:	もし、前の要素が見つからなかったらnilを返します。

 doc = Document.new '<a/>'
 doc.root.elements[10] = Element.new('b')    #-> <a><b/></a>
 doc.root.elements[1]                        #-> <b/>
 doc.root.elements[1] = Element.new('c')     #-> <a><c/></a>
 doc.root.elements['c'] = Element.new('d')   #-> <a><d/></a>

Returns true if there are no Element children, false otherwise

もしElementが子を持っていなかったらtrue、そうでなければ falseを返します。

Returns the index of the supplied child (starting at 1), or -1 if the element is not a child

element: an Element child

与えられた子のインデックス(1から始まる)を返します。もし、要素が子でないときは-1を返します。

element: 子Elementです。

Deletes a child Element

element:	Either an Element, which is removed directly; an xpath, where the first matching child is removed; or an Integer, where the n'th Element is removed.
Returns:	the removed child

 doc = Document.new '<a><b/><c/><c id="1"/></a>'
 b = doc.root.elements[1]
 doc.root.elements.delete b           #-> <a><c/><c id="1"/></a>
 doc.elements.delete("a/c[@id='1']")  #-> <a><c/></a>
 doc.root.elements.delete 1           #-> <a/>

子Elementを削除します。

element:	直接、取り除かれるElement、最初にマッチした子を取り除くxpath、あるいは、n番目の要素を取り除くIntegerを指定します。
戻り値:	取り除かれた子です。

 doc = Document.new '<a><b/><c/><c id="1"/></a>'
 b = doc.root.elements[1]
 doc.root.elements.delete b           #-> <a><c/><c id="1"/></a>
 doc.elements.delete("a/c[@id='1']")  #-> <a><c/></a>
 doc.root.elements.delete 1           #-> <a/>

Removes multiple elements. Filters for Element children, regardless of XPath matching.

xpath:	all elements matching this String path are removed.
Returns:	an Array of Elements that have been removed

 doc = Document.new '<a><c/><c/><c/><c/></a>'
 deleted = doc.elements.delete_all 'a/c' #-> [<c/>, <c/>, <c/>, <c/>]

複数の要素を取り除きます。XPathのマッチとは無関係にElementの子にフィルタをかけます。

xpath:	全てのStringのパスにマッチした要素が取り除かれます。
戻り値:	取り除かれた要素の配列です。

 doc = Document.new '<a><c/><c/><c/><c/></a>'
 deleted = doc.elements.delete_all 'a/c' #-> [<c/>, <c/>, <c/>, <c/>]

Adds an element

element:	if supplied, is either an Element, String, or Source (see Element.initialize). If not supplied or nil, a new, default Element will be constructed
Returns:	the added Element

 a = Element.new 'a'
 a.elements.add Element.new 'b'  #-> <a><b/></a>
 a.elements.add 'c'              #-> <a><b/><c/></a>

要素を追加します。

element:	もし与えられるなら、Element、String、または String(Element.initializeを見て下さい。)です。もし、与えられないか、nilなら新しくデフォルトのElementが構築されます。
戻り値:	加えられたElementです。

 a = Element.new 'a'
 a.elements.add Element.new 'b'  #-> <a><b/></a>
 a.elements.add 'c'              #-> <a><b/><c/></a>

Iterates through all of the child Elements, optionally filtering them by a given XPath

xpath:

optional. If supplied, this is a String XPath, and is used to filter the children, so that only matching children are yielded. Note that XPaths are automatically filtered for Elements, so that non-Element children will not be yielded

 doc = Document.new '<a><b/><c/><d/>sean<b/><c/><d/></a>'
 doc.root.each {|e|p e}       #-> Yields b, c, d, b, c, d elements
 doc.root.each('b') {|e|p e}  #-> Yields b, b elements
 doc.root.each('child::node()')  {|e|p e}
 #-> Yields <b/>, <c/>, <d/>, <b/>, <c/>, <d/>
 XPath.each(doc.root, 'child::node()', &block)
 #-> Yields <b/>, <c/>, <d/>, sean, <b/>, <c/>, <d/>

全ての子Elementsを繰り返します。任意(オプション)で与えられた XPathでフィルタをかけます。

xpath:

任意(オプション)。もし、与えられれば、String XPathで子のフィルタとして使われ、マッチした子だけ繰り返されます。XPathは自動的にElementsにフィルタをかけるので、Elementではない子に対しては繰り返されないことに注意して下さい。

 doc = Document.new '<a><b/><c/><d/>sean<b/><c/><d/></a>'
 doc.root.each {|e|p e}       #-> Yields b, c, d, b, c, d elements
 doc.root.each('b') {|e|p e}  #-> Yields b, b elements
 doc.root.each('child::node()')  {|e|p e}
 #-> Yields <b/>, <c/>, <d/>, <b/>, <c/>, <d/>
 XPath.each(doc.root, 'child::node()', &block)
 #-> Yields <b/>, <c/>, <d/>, sean, <b/>, <c/>, <d/>

Returns the number of Element children of the parent object.

 doc = Document.new '<a>sean<b/>elliott<b/>russell<b/></a>'
 doc.root.size            #-> 6, 3 element and 3 text nodes
 doc.root.elements.size   #-> 3

親オブジェクトの子Elementの数を返します。

 doc = Document.new '<a>sean<b/>elliott<b/>russell<b/></a>'
 doc.root.size            #-> 6, 3 element and 3 text nodes
 doc.root.elements.size   #-> 3

Returns an Array of Element children. An XPath may be supplied to filter the children. Only Element children are returned, even if the supplied XPath matches non-Element children.

 doc = Document.new '<a>sean<b/>elliott<c/></a>'
 doc.root.elements.to_a                  #-> [ <b/>, <c/> ]
 doc.root.elements.to_a("child::node()") #-> [ <b/>, <c/> ]
 XPath.match(doc.root, "child::node()")  #-> [ sean, <b/>, elliott, <c/> ]

子ElementのArrayを返します。XPathは子へのフィルタとして与えられるかも知れません。たとえXPathにマッチしたElementではない子が与えられたとしても子Elementだけが返されます。

 doc = Document.new '<a>sean<b/>elliott<c/></a>'
 doc.root.elements.to_a                  #-> [ <b/>, <c/> ]
 doc.root.elements.to_a("child::node()") #-> [ <b/>, <c/> ]
 XPath.match(doc.root, "child::node()")  #-> [ sean, <b/>, elliott, <c/> ]