Represents a tagged XML element. Elements are characterized by having children, attributes, and names, and can themselves be children.

タグの付いたXML要素を表現します。Elementsは子や属性、名前を持つこ とによって特徴づけられ、それ自身が子になることができます。

Constructor

• :respect_whitespace the value of this is :all or an array of strings being the names of the elements to respect whitespace for. Defaults to :all.
• :compress_whitespace the value can be :all or an array of strings being the names of the elements to ignore whitespace on. Overrides :respect_whitespace.
• :raw can be :all, or an array of strings being the names of the elements to process in raw mode. In raw mode, special characters in text is not converted to or from entities.

コンストラクタ

• :respect_whitespace この値は、:all あるいは、空白を 考慮した要素の名前の文字列の配列です。デフォルトは:allです。
• :compress_whitespace この値は、:all あるいは、空白を 無視した要素の名前の文字列の配列です。:respect_whitespaceを

 オーバーライドします。

• :raw この値は、:all あるいは、rawモードで処理される ための要素の名前の文字列の配列です。rawモードは、エンティティへ、 またはエンティティから変換されないテキストの中の特別な文字です。

Parses a stream containing a single top-level element and possibly multiple children.

 s = Source.new( "<a>some text</a>" )
 l = Listener.new
 class << l
   def tag_start name, attributes
     p "NEW ELEMENT, NAME OF #{name}"
   end
 end
 Element::parse_stream s, l

一つの最高位の要素と、たぶん複数の子を含むストリームをパースしま す。

ドセットをインプリメントしたもの)に通知されるでしょう。

 s = Source.new( "<a>some text</a>" )
 l = Listener.new
 class << l
   def tag_start name, attributes
     p "NEW ELEMENT, NAME OF #{name}"
   end
 end
 Element::parse_stream s, l

Creates a shallow copy of self.

  d = Document.new "<a><b/><b/><c><d/></c></a>"
  new_a = d.root.clone
  puts new_a  # => "<a/>"

自分自身の浅いコピーを作ります。

  d = Document.new "<a><b/><b/><c><d/></c></a>"
  new_a = d.root.clone
  puts new_a  # => "<a/>"

Evaluates to the root element of the document that this element belongs to. If this element doesn't belong to a document, but does belong to another Element, the parent's root will be returned, until the earliest ancestor is found.

 d = Document.new '<a><b><c/></b></a>'
 a = d[1] ; c = a[1][1]
 d.root        # These all evaluate to the same Element,
 a.root        # namely, <a>
 c.root        #

要素が属するXML文書のルート要素を評価します。もし、要素がXML文書 に属していないが、別のElementに属しているときは、最も古い祖先が 見つかるまで親のルート要素を返すでしょう。 を返すでしょう。

 d = Document.new '<a><b><c/></b></a>'
 a = d[1] ; c = a[1][1]
 d.root        # 同じElementのこれらの全てを評価します。
 a.root        # すなわち、<a>
 c.root        #

Evaluates to true if whitespace is respected for this element. This is the case if:

1. Neither :respect_whitespace nor :compress_whitespace has any value
2. The context has :respect_whitespace set to :all or an array containing the name of this element, and :compress_whitespace isn't set to :all or an array containing the name of this element.

The evaluation is tested against expanded_name, and so is namespace sensitive.

もし、要素が空白を考慮するならtrueと評価します。これは以下のよ うな場合です。:

1. :respect_whitespaceと:compress_whitespaceに値が設定されて いないときです。
2. コンテキストが:allまたは、要素の名前を含んでいる配列に設定 された:respect_whitespaceと、:allまたは、要素の名前を含ん でいる配列に設定されていない:compress_whiteを持つときです。

それゆえ、expanded_nameに対するテストの評価は、ネームスペース に敏感です。

Evaluates to true if raw mode is set for this element. This is the case if the context has :raw set to :all or an array containing the name of this element.

The evaluation is tested against expanded_name, and so is namespace sensitive.

もし、要素にrawモードが設定されていればtrueと評価します。これ はコンテキストが:allまたは、要素の名前を含んでいる配列に:raw が設定されている場合です。

それゆえ、expanded_nameに対するテストの評価は、ネームスペース に敏感です。

Evaluates to an Array containing the prefixes (names) of all defined namespaces at this context node.

 doc = Document.new("<a xmlns:x='1' xmlns:y='2'><b/><c xmlns:z='3'/></a>")
 doc.elements['//b'].prefixes # -> ['x', 'y']

このコンテキストノードに定義された全てのネームスペースの接頭語 (名前)を含んだArrayとして評価します。

 doc = Document.new("<a xmlns:x='1' xmlns:y='2'><b/><c xmlns:z='3'/></a>")
 doc.elements['//b'].prefixes # -> ['x', 'y']

Evalutas to the URI for a prefix, or the empty string if no such namespace is declared for this element. Evaluates recursively for ancestors. Returns the default namespace, if there is one.

 doc = Document.new("<a xmlns='1' xmlns:y='2'><b/><c xmlns:z='3'/></a>")
 b = doc.elements['//b']
 b.namespace           # -> '1'
 b.namespace("y")      # -> '2'

接頭語のURIとして評価します。もし、この要素にネームペースが宣言 されていなければ空文字と評価します。祖先を再帰的に評価します。も し、祖先がなければ、デフォルトのネームスペースを返します。

 doc = Document.new("<a xmlns='1' xmlns:y='2'><b/><c xmlns:z='3'/></a>")
 b = doc.elements['//b']
 b.namespace           # -> '1'
 b.namespace("y")      # -> '2'

Adds a namespace to this element.

Evaluates to: this Element

 a = Element.new("a")
 a.add_namespace("foo", "bar")
 a.add_namespace("twiddle")
 puts a   #-> <a xmlns:foo='bar' xmlns='twiddle'/>

要素にネームスペースを加えます。

評価結果: このElementを返します。

 a = Element.new("a")
 a.add_namespace("foo", "bar")
 a.add_namespace("twiddle")
 puts a   #-> <a xmlns:foo='bar' xmlns='twiddle'/>

Removes a namespace from this node. This only works if the namespace is actually declared in this node. If no argument is passed, deletes the default namespace.

Evaluates to: this element

 doc = Document.new "<a xmlns:foo='bar' xmlns='twiddle'/>"
 doc.root.delete_namespace
 puts doc     # -> <a xmlns:foo='bar'/>
 doc.root.delete_namespace 'foo'
 puts doc     # -> <a/>

このノードからネームスペースを取り除きます。これは、このノードで 実際にネームスペースが宣言されているときだけ働きます。もし、引数 が渡されなかったときは、デフォルトのネームスペースを削除します。

評価結果: このElementを返します。

 doc = Document.new "<a xmlns:foo='bar' xmlns='twiddle'/>"
 doc.root.delete_namespace
 puts doc     # -> <a xmlns:foo='bar'/>
 doc.root.delete_namespace 'foo'
 puts doc     # -> <a/>

Adds a child to this element, optionally setting attributes in the element.

 el = doc.add_element 'my-tag'
 el = doc.add_element 'my-tag', {'attr1'=>'val1', 'attr2'=>'val2'}
 el = Element.new 'my-tag'
 doc.add_element el

この要素に子を加えます。要素に属性を設定するのは任意(オプション) です。

 el = doc.add_element 'my-tag'
 el = doc.add_element 'my-tag', {'属性1'=>'値1', '属性2'=>'値2'}
 el = Element.new 'my-tag'
 doc.add_element el

Deletes a child element.

 doc.delete_element "/a/b/c[@id='4']"
 doc.delete_element doc.elements["//k"]
 doc.delete_element 1

子要素を削除します。

 doc.delete_element "/a/b/c[@id='4']"
 doc.delete_element doc.elements["//k"]
 doc.delete_element 1

Evaluates to true if this element has at least one child Element

 doc = Document.new "<a><b/><c>Text</c></a>"
 doc.root.has_elements               # -> true
 doc.elements["/a/b"].has_elements   # -> false
 doc.elements["/a/c"].has_elements   # -> false

もし、この要素が一つでも子のElementを持っていたらtrueと評価し ます。

 doc = Document.new "<a><b/><c>Text</c></a>"
 doc.root.has_elements               # -> true
 doc.elements["/a/b"].has_elements   # -> false
 doc.elements["/a/c"].has_elements   # -> false

Iterates through the child elements, yielding for each Element that has a particular attribute set.

 doc = Document.new "<a><b @id='1'/><c @id='2'/><d @id='1'/><e/></a>"
 # Yields b, c, d
 doc.root.each_element_with_attribute( 'id' ) {|e| p e}
 # Yields b, d
 doc.root.each_element_with_attribute( 'id', '1' ) {|e| p e}
 # Yields b
 doc.root.each_element_with_attribute( 'id', '1', 1 ) {|e| p e}
 # Yields d
 doc.root.each_element_with_attribute( 'id', '1', 0, 'd' ) {|e| p e}

子要素のためのイテレータで、特定の属性が設定されている各Element に対してyieldします。

 doc = Document.new "<a><b @id='1'/><c @id='2'/><d @id='1'/><e/></a>"
 # Yields b, c, d
 doc.root.each_element_with_attribute( 'id' ) {|e| p e}
 # Yields b, d
 doc.root.each_element_with_attribute( 'id', '1' ) {|e| p e}
 # Yields b
 doc.root.each_element_with_attribute( 'id', '1', 1 ) {|e| p e}
 # Yields d
 doc.root.each_element_with_attribute( 'id', '1', 0, 'd' ) {|e| p e}

Iterates through the children, yielding for each Element that has a particular text set.

 doc = Document.new '<a><b>b</b><c>b</c><d>d</d><e/></a>'
 # Yields b, c, d
 doc.each_element_with_text {|e|p e}
 # Yields b, c
 doc.each_element_with_text('b'){|e|p e}
 # Yields b
 doc.each_element_with_text('b', 1){|e|p e}
 # Yields d
 doc.each_element_with_text(nil, 0, 'd'){|e|p e}

子要素のためのイテレータで、特定の属性が設定されている各Element に対してyieldします。

 doc = Document.new '<a><b>b</b><c>b</c><d>d</d><e/></a>'
 # Yields b, c, d
 doc.each_element_with_text {|e|p e}
 # Yields b, c
 doc.each_element_with_text('b'){|e|p e}
 # Yields b
 doc.each_element_with_text('b', 1){|e|p e}
 # Yields d
 doc.each_element_with_text(nil, 0, 'd'){|e|p e}

Synonym for Element.elements.each

Element.elements.eachと同じです。

Synonym for Element.to_a

This is a little slower than calling elements.each directly.

Element.to_aと同じです。

これはelements.eachを直接呼ぶより少し遅いです。

Returns the next sibling that is an element, or nil if there is no Element sibling after this one

 doc = Document.new '<a><b/>text<c/></a>'
 doc.root.elements['b'].next_element          #-> <c/>
 doc.root.elements['c'].next_element          #-> nil

要素の次の兄弟を返します。もし、この要素の次にElemntの兄弟がなけ ればnilを返します。

 doc = Document.new '<a><b/>text<c/></a>'
 doc.root.elements['b'].next_element          #-> <c/>
 doc.root.elements['c'].next_element          #-> nil

Returns the previous sibling that is an element, or nil if there is no Element sibling prior to this one

 doc = Document.new '<a><b/>text<c/></a>'
 doc.root.elements['c'].previous_element          #-> <b/>
 doc.root.elements['b'].previous_element          #-> nil

要素の前の兄弟を返します。もし、この要素の前にElemntの兄弟がなけ ればnilを返します。

 doc = Document.new '<a><b/>text<c/></a>'
 doc.root.elements['c'].previous_element          #-> <b/>
 doc.root.elements['b'].previous_element          #-> nil

Evaluates to true if this element has at least one Text child

もし、要素が少なくとも一つのTextの子を持っていればtrueと評価し ます。

A convenience method which returns the String value of the first child text element, if one exists, and nil otherwise.

Note that an element may have multiple Text elements, perhaps separated by other children. Be aware that this method only returns the first Text node.

 doc = Document.new "<p>some text <b>this is bold!</b> more text</p>"
 # The element 'p' has two text elements, "some text " and " more text".
 doc.root.text              #-> "some text "

もし、存在するなら、_最初の_テキスト要素の子のStringの値を返す便 利なメソッドです。そうでなければnilを返します。

要素は、たぶん、他の子に隔てられて、複数のText要素を持ってい るかも知れないことに注意して下さい。このメソッドは最初の Textノードしか返さないことを意識して下さい。

 doc = Document.new "<p>some text <b>this is bold!</b> more text</p>"
 # The element 'p' has two text elements, "some text " and " more text".
 doc.root.text              #-> "some text "

Returns the first child Text node, if any, or nil otherwise. This method returns the actual Text node, rather than the String content.

 doc = Document.new "<p>some text <b>this is bold!</b> more text</p>"
 # The element 'p' has two text elements, "some text " and " more text".
 doc.root.get_text.value            #-> "some text "

もしあれば、最初の子のTextノードを返します。そうでなければnil を返します。このメソッドは、現在はStringよりむしろTextノードを 返します。

 doc = Document.new "<p>some text <b>this is bold!</b> more text</p>"
 # The element 'p' has two text elements, "some text " and " more text".
 doc.root.get_text.value            #-> "some text "

Sets the first Text child of this object. See text() for a discussion about Text children.

If a Text child already exists, the child is replaced by this content. This means that Text content can be deleted by calling this method with a nil argument. In this case, the next Text child becomes the first Text child. In no case is the order of any siblings disturbed.

 doc = Document.new '<a><b/></a>'
 doc.root.text = 'Sean'      #-> '<a><b/>Sean</a>'
 doc.root.text = 'Elliott'   #-> '<a><b/>Elliott</a>'
 doc.root.add_element 'c'    #-> '<a><b/>Elliott<c/></a>'
 doc.root.text = 'Russell'   #-> '<a><b/>Russell<c/></a>'
 doc.root.text = nil         #-> '<a><b/><c/></a>'

このオブジェクトの最初のTextの子を設定します。Textの子の議論につ いてはtest()をみて下さい。

もし、Textの子がもう既に存在していたら、子は引数の内容で置き換え られます。これは、Textの内容はこのメソッドに引数としてnilを与え ることにより、削除されるということを意味してます。この場合、次の Textの子は最初のTextの子になります。どんな場合にも兄弟の順番がか き乱されることは決してありません。

 doc = Document.new '<a><b/></a>'
 doc.root.text = 'Sean'      #-> '<a><b/>Sean</a>'
 doc.root.text = 'Elliott'   #-> '<a><b/>Elliott</a>'
 doc.root.add_element 'c'    #-> '<a><b/>Elliott<c/></a>'
 doc.root.text = 'Russell'   #-> '<a><b/>Russell<c/></a>'
 doc.root.text = nil         #-> '<a><b/><c/></a>'

A helper method to add a Text child. Actual Text instances can be added with regular Parent methods, such as add() and <<()

 e = Element.new('a')          #-> <e/>
 e.add_text 'foo'              #-> <e>foo</e>
 e.add_text Text.new(' bar')    #-> <e>foo bar</e>

Note that at the end of this example, the branch has 3 nodes; the 'e' element and 2 Text node children.

Textの子を追加するヘルパーメソッドです。実際はTextインスタンスが add()や<<()のようないつものParentのメソッドで追加されます。

 e = Element.new('a')          #-> <e/>
 e.add_text 'foo'              #-> <e>foo</e>
 e.add_text Text.new(' bar')    #-> <e>foo bar</e>

最後の例では、枝は3ノード持っていることに注意して下さい。

Evaluates to true if this element has any attributes set, false otherwise.

もし、要素がいくつか属性が設定されていればtrueと評価します。そ れ以外はfalseと評価します。

Adds an attribute to this element, overwriting any existing attribute by the same name.

 e = Element.new 'e'
 e.add_attribute( 'a', 'b' )               #-> <e a='b'/>
 e.add_attribute( 'x:a', 'c' )             #-> <e a='b' x:a='c'/>
 e.add_attribute Attribute.new('b', 'd')   #-> <e a='b' x:a='c' b='d'/>

要素に、存在する同じ名前の属性を上書きしながら属性を追加します。

 e = Element.new 'e'
 e.add_attribute( 'a', 'b' )               #-> <e a='b'/>
 e.add_attribute( 'x:a', 'c' )             #-> <e a='b' x:a='c'/>
 e.add_attribute Attribute.new('b', 'd')   #-> <e a='b' x:a='c' b='d'/>

Add multiple attributes to this element.

 el.add_attributes( {"name1"=>"value1", "name2"=>"value2"} )
 el.add_attributes( [ ["name1","value1"], ["name2"=>"value2"] ] )

要素に複数の属性を追加します。

 el.add_attributes( {"name1"=>"value1", "name2"=>"value2"} )
 el.add_attributes( [ ["name1","value1"], ["name2"=>"value2"] ] )

Removes an attribute

 e = Element.new('E')
 e.add_attribute( 'name', 'Sean' )             #-> <E name='Sean'/>
 r = e.add_attribute( 'sur:name', 'Russell' )  #-> <E name='Sean' sur:name='Russell'/>
 e.delete_attribute( 'name' )                  #-> <E sur:name='Russell'/>
 e.delete_attribute( r )                       #-> <E/>

属性を取り除きます。

 e = Element.new('E')
 e.add_attribute( 'name', 'Sean' )             #-> <E name='Sean'/>
 r = e.add_attribute( 'sur:name', 'Russell' )  #-> <E name='Sean' sur:name='Russell'/>
 e.delete_attribute( 'name' )                  #-> <E sur:name='Russell'/>
 e.delete_attribute( r )                       #-> <E/>

Writes out this element, and recursively, all children.

 out = ''
 doc.write( out )     #-> doc is written to the string 'out'
 doc.write( $stdout ) #-> doc written to the console

要素と再帰的に全ての子を書き出します。

 out = ''
 doc.write( out )     #-> doc is written to the string 'out'
 doc.write( $stdout ) #-> doc written to the console