検索結果

rexml/document (132019.0)

• 2.1.0

• ライブラリ

DOM スタイルの XML パーサ。

DOM スタイルの XML パーサ。

REXML::Document.new で XML 文書から DOM ツリーを
構築し、ツリーのノードの各メソッドで文書の内容にアクセスします。

以下のプログラムではブックマークの XML からデータを取り出します。

//emlist[][ruby]{
require 'rexml/document'
require 'pp'

Bookmark = Struct.new(:href, :title, :desc)

doc = REXML::Document.new(<<XML)
<?xml version="1.0" encoding="UTF-...

• REXML::AttlistDecl
• REXML::Attribute
• REXML::Attributes
• REXML::CData
• REXML::Child
• REXML::Comment
• REXML::Declaration
• REXML::DocType
• REXML::Document
• REXML::Element
• REXML::ElementDecl
• REXML::Elements
• REXML::Encoding
• REXML::Entity
• REXML::EntityConst
• REXML::ExternalEntity
• REXML::Formatters::Default
• REXML::Formatters::Pretty
• REXML::Formatters::Transitive
• REXML::Functions
• ...

REXML::Element#delete_element(element) -> REXML::Element (52219.0)

• 2.1.0

• インスタンスメソッド

子要素を削除します。

子要素を削除します。

element で削除する要素を指定できます。整数、文字列、REXML::Element
オブジェクトのいずれかが指定できます。

REXML::Element を指定すると、その要素が削除されます。
整数を指定すると、element 番目の要素を削除します(1-originで指定します)。
文字列を指定すると、XPath としてマッチする要素を削除します。
複数の要素がマッチする場合はそのうち1つが削除されます。

@param element 削除する要素
@see REXML::Elements#delete

//emlist[][ruby]{
require...

• REXML::Element

REXML::XMLDecl::DEFAULT_VERSION -> String (51301.0)

• 2.1.0

• 定数

REXML::XMLDecl.new や REXML::XMLDecl.default で の使われるデフォルトのXMLバージョン。

REXML::XMLDecl.new や REXML::XMLDecl.default で
の使われるデフォルトのXMLバージョン。

• REXML::XMLDecl

REXML::Element#add_element(element, attrs = nil) -> Element (42919.0)

• 2.1.0

• インスタンスメソッド

子要素を追加します。

子要素を追加します。

element として追加する要素を指定します。
REXML::Element オブジェクトもしくは文字列を指定します。

element として REXML::Element オブジェクトを指定した場合、それが追加されます。
文字列を指定した場合は、それを要素名とする要素を追加します。

attrs に { String => String } という Hash を渡すと、
追加する要素の属性を指定できます。

子要素の最後に追加されます。

返り値は追加された要素です。

@param element 追加する要素
@param attrs 追加する要素に設定する...

• REXML::Element

REXML::Elements#delete(element) -> Element (42919.0)

• 2.1.0

• インスタンスメソッド

element で指定した子要素を取り除きます。

element で指定した子要素を取り除きます。

element には、REXML::Element、整数、文字列が指定できます。
Element オブジェクトを指定した場合は、その子要素を取り除きます。
整数を指定した場合には element 番目の子要素を削除します(1-originです)。
文字列を指定した場合は、削除する要素を XPath で指定します。
XPathが複数の要素を指している場合は、そのうち一つを削除します。

取り除かれた要素を返します。

XPath で指定した場合、子要素ではない要素も取り除けることに注意してください。

@param element 削除する要素...

• REXML::Element
• REXML::Elements

絞り込み条件を変える

REXML::Parent#replace_child(to_replace, replacement) -> () (42901.0)

• 2.1.0

• インスタンスメソッド

子ノード列上の to_replace を replacement に置き換えます。

子ノード列上の to_replace を replacement に置き換えます。

to_replace の parent は nil に、
replacement の parent は selfに変更されます。

@param to_replace 置き換え元のノード
@param replacement 置き換え先のノード

• REXML::Parent

REXML::Attributes#delete(attribute) -> REXML::Element (42619.0)

• 2.1.0

• インスタンスメソッド

指定した属性を取り除きます。

指定した属性を取り除きます。

attribute で取り除く属性を指定します。
文字列もしくは REXML::Attribute オブジェクトを指定します

self が属する要素(REXML::Element)を返します。

@param attribute 取り除く属性(文字列もしくは REXML::Attribute オブジェクト)

//emlist[][ruby]{
require 'rexml/document'

doc = REXML::Document.new(<<-EOS)
<root xmlns:foo="http://example.org/foo"
x...

• REXML::Attribute
• REXML::Attributes
• REXML::Element

REXML::Element#each_element_with_attribute(key, value = nil, max = 0, name = nil) {|element| ... } -> () (42619.0)

• 2.1.0

• インスタンスメソッド

特定の属性を持つすべての子要素を引数としてブロックを呼び出します。

特定の属性を持つすべての子要素を引数としてブロックを呼び出します。

key で指定した属性名の属性を持つ要素のみを対象とします。
value を指定すると、keyで指定した属性名を持つ属性の値がvalueである
もののみを対象とします。
maxを指定すると、対象となる子要素の先頭 max 個のみが対象となります。
name を指定すると、それは xpath 文字列と見なされ、
それにマッチするもののみが対象となります。

max に 0 を指定すると、max の指定は無視されます(0個ではありません)。

@param key 属性名(文字列)
@param value 属性値(文字列)
...

• REXML::Element

REXML::Element#each_element_with_text(text = nil, max = 0, name = nil) {|element| ... } -> () (42619.0)

• 2.1.0

• インスタンスメソッド

テキストを子ノードとして 持つすべての子要素を引数としてブロックを呼び出します。

テキストを子ノードとして
持つすべての子要素を引数としてブロックを呼び出します。

text を指定すると、テキストの内容が text であるもののみを対象とします。
maxを指定すると、対象となる子要素の先頭 max 個のみが対象となります。
name を指定すると、それは xpath 文字列と見なされ、
それにマッチするもののみが対象となります。

max に 0 を指定すると、max の指定は無視されます(0個ではありません)。

@param text テキストの中身(文字列)
@param max ブロック呼出の対象とする子要素の最大個数
@param name xpath文字列

...

• REXML::Element

REXML::Element#next_element -> Element | nil (42619.0)

• 2.1.0

• インスタンスメソッド

次の兄弟要素を返します。

次の兄弟要素を返します。

次の要素が存在しない場合は nil を返します。

//emlist[][ruby]{
require 'rexml/document'
doc = REXML::Document.new '<a><b/>text<c/></a>'
doc.root.elements['b'].next_element # => <c/>
doc.root.elements['c'].next_element # => nil
//}

• REXML::Element

絞り込み条件を変える

REXML::Elements#delete_all(xpath) -> [REXML::Element] (42619.0)

• 2.1.0

• インスタンスメソッド

xpath で指定した XPath 文字列にマッチする要素をすべて取り除きます。

xpath で指定した XPath 文字列にマッチする要素をすべて取り除きます。

@param xpath 取り除く要素を指し示す XPath 文字列

//emlist[][ruby]{
require 'rexml/document'
doc = REXML::Document.new('<a><c/><c/><c/><c/></a>')
doc.elements.delete_all("a/c") # => [<c/>, <c/>, <c/>, <c/>]
doc.to_s # => "<a/>"
//}

• REXML::Elements

REXML::Attribute#element -> REXML::Element (42601.0)

• 2.1.0

• インスタンスメソッド

その属性が属する要素を返します。

その属性が属する要素を返します。

• REXML::Attribute

REXML::Attribute#element=(element) (42601.0)

• 2.1.0

• インスタンスメソッド

self が属する要素を変更します。

self が属する要素を変更します。

@param element 変更先の要素(REXML::Element)

• REXML::Attribute
• REXML::Element

REXML::Element#each_element(xpath = nil) {|element| ... } -> () (42601.0)

• 2.1.0

• インスタンスメソッド

各子要素を引数としてブロックを呼び出します。

各子要素を引数としてブロックを呼び出します。

xpath に文字列を指定するとそれにマッチする子要素のみを対象とします。

@param xpath XPath 文字列

• REXML::Element

REXML::Element#elements -> REXML::Elements (42601.0)

• 2.1.0

• インスタンスメソッド

要素が保持している子要素の集合を返します。

要素が保持している子要素の集合を返します。

• REXML::Element

絞り込み条件を変える

REXML::Element#get_elements(xpath) -> [REXML::Element] (42601.0)

• 2.1.0

• インスタンスメソッド

xpath にマッチする要素を配列で返します。

xpath にマッチする要素を配列で返します。

xpath には XPath 文字列を指定します。

@param xpath XPath 文字列
@see REXML::Elements#to_a

• REXML::Element

REXML::Element#previous_element -> Element | nil (42601.0)

• 2.1.0

• インスタンスメソッド

前の兄弟要素を返します。

前の兄弟要素を返します。

前の要素が存在しない場合は nil を返します。

• REXML::Element

REXML::Entity#external -> String | nil (42601.0)

• 2.1.0

• インスタンスメソッド

実体が外部実体(external entity)宣言である場合は "SYSTEM" もしくは "PUBLIC" という文字列を返します。

実体が外部実体(external entity)宣言である場合は
"SYSTEM" もしくは "PUBLIC" という文字列を返します。

内部実体(internal entity)宣言である場合には nil を返します。

• REXML::Entity

REXML::Parent#children -> [REXML::Child] (42601.0)

• 2.1.0

• インスタンスメソッド

子ノード列の配列を返します。

子ノード列の配列を返します。

• REXML::Parent

REXML::Attributes#delete_all(name) -> [REXML::Attribute] (42319.0)

• 2.1.0

• インスタンスメソッド

name という名前を持つ属性をすべて削除します。

name という名前を持つ属性をすべて削除します。

削除された属性を配列で返します。

@param name 削除する属性の名前

//emlist[][ruby]{
require 'rexml/document'

doc = REXML::Document.new(<<-EOS)
<root xmlns:foo="http://example.org/foo"
xmlns:bar="http://example.org/bar">
<a foo:att='1' bar:att='2' att='&lt;'/>
</root>
EOS
a = doc.get_elem...

• REXML::Attributes

絞り込み条件を変える

REXML::Attributes#length -> Integer (42319.0)

• 2.1.0

• インスタンスメソッド

属性の個数を返します。

属性の個数を返します。


//emlist[][ruby]{
require 'rexml/document'

doc = REXML::Document.new(<<EOS)
<root xmlns:foo="http://example.org/foo"
xmlns:bar="http://example.org/bar">
<a foo:att='1' bar:att='2' att='&lt;'/>
</root>
EOS
a = doc.get_elements("/root/a").first

p a.attributes.length # => 3
//}
...

• REXML::Attributes

REXML::CData#value -> String (42319.0)

• 2.1.0

• インスタンスメソッド

テキスト文字列を返します。

テキスト文字列を返します。

@see REXML::Text#value, REXML::Text#to_s

//emlist[][ruby]{
require 'rexml/document'
doc = REXML::Document.new(<<EOS)
<root><![CDATA[foobar baz]]></root>
EOS
doc.root[0].class # => REXML::CData
doc.root[0].value # => "foobar baz"
//}

• REXML::CData

REXML::Child#next_sibling=(other) (42319.0)

• 2.1.0

• インスタンスメソッド

other を self の次の隣接ノードとします。

other を self の次の隣接ノードとします。

つまり、親ノードが持つ子ノード列の self の後ろに
other を挿入します。

@param other 挿入するノード

//emlist[][ruby]{
require 'rexml/document'

a = REXML::Element.new("a")
b = a.add_element("b")
c = REXML::Element.new("c")
b.next_sibling = c
d = REXML::Element.new("d")
b.previous_sibling = d

p a.to_s # =>...

• REXML::Child

REXML::Child#previous_sibling=(other) (42319.0)

• 2.1.0

• インスタンスメソッド

other を self の前の隣接ノードとします。

other を self の前の隣接ノードとします。

つまり、親ノードが持つ子ノード列の self の前に
other を挿入します。

@param other 挿入するノード

//emlist[][ruby]{
require 'rexml/document'

a = REXML::Element.new("a")
b = a.add_element("b")
c = REXML::Element.new("c")
b.next_sibling = c
d = REXML::Element.new("d")
b.previous_sibling = d

p a.to_s # =>...

• REXML::Child

REXML::DocType#external_id -> String | nil (42319.0)

• 2.1.0

• インスタンスメソッド

DTD が外部サブセットを用いている場合は "SYSTEM", "PUBLIC" の いずれかの文字列を返します。

DTD が外部サブセットを用いている場合は "SYSTEM", "PUBLIC" の
いずれかの文字列を返します。

それ以外の場合は nil を返します。

//emlist[][ruby]{
require 'rexml/document'
doctype = REXML::Document.new(<<EOS).doctype
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
EOS
doctype....

• REXML::DocType

絞り込み条件を変える

REXML::DocType#public -> String | nil (42319.0)

• 2.1.0

• インスタンスメソッド

DTD の公開識別子を返します。

DTD の公開識別子を返します。

DTD が公開識別子による外部サブセットを含んでいない場合は nil を返します。

//emlist[][ruby]{
require 'rexml/document'
doctype = REXML::Document.new(<<EOS).doctype
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
EOS
doctype.system # => "http:/...

• REXML::DocType

REXML::Document#stand_alone? -> String (42319.0)

• 2.1.0

• インスタンスメソッド

XML 宣言の standalone の値を文字列で返します。

XML 宣言の standalone の値を文字列で返します。

//emlist[][ruby]{
require 'rexml/document'
doc = REXML::Document.new(<<EOS)
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<e />
EOS
doc.stand_alone? # => "yes"
//}

• REXML::Document

REXML::Element#delete_attribute(key) -> REXML::Attribute | nil (42319.0)

• 2.1.0

• インスタンスメソッド

要素から key という属性名の属性を削除します。

要素から key という属性名の属性を削除します。

削除された属性を返します。

key という属性名の属性が存在しない場合は削除されずに、nil を返します。

@param key 削除する要素(文字列(属性名) or REXML::Attributeオブジェクト)

//emlist[][ruby]{
require 'rexml/document'
e = REXML::Element.new("E")
e.add_attribute("x", "foo"); e # => <E x='foo'/>
e.add_attribute("y:x", "bar"); e # => <E x...

• REXML::Attribute
• REXML::Element

REXML::Element#delete_namespace(namespace = "xmlns") -> self (42319.0)

• 2.1.0

• インスタンスメソッド

名前空間を要素から削除します。

名前空間を要素から削除します。

削除可能な名前空間はそのノードで宣言されているもののみです。
上位の要素で宣言されているものは削除できません。

引数を省略した場合はデフォルトの名前空間を削除します。

@param namespace 削除する名前空間の prefix

//emlist[][ruby]{
require 'rexml/document'
doc = REXML::Document.new "<a xmlns:foo='bar' xmlns='twiddle'/>"
doc.root.delete_namespace
doc.to_s # => "<a xmlns:foo=...

• REXML::Element

REXML::Element#has_elements? -> bool (42319.0)

• 2.1.0

• インスタンスメソッド

self が一つでも子要素を持つならば true を返します。

self が一つでも子要素を持つならば true を返します。

//emlist[][ruby]{
require 'rexml/document'
doc = REXML::Document.new("<a><b/><c>Text</c></a>")
doc.root.has_elements? # => true
doc.elements["/a/b"].has_elements? # => false
# /a/c はテキストノードしか持たないので false である
doc.elements["/a/c"].has_elements? # => f...

• REXML::Element

絞り込み条件を変える

REXML::Text#value -> String (42319.0)

• 2.1.0

• インスタンスメソッド

テキストの内容を非正規化(すべての実体をアンエスケープ)された状態で返します。

テキストの内容を非正規化(すべての実体をアンエスケープ)された状態で返します。

このメソッドの返り値では raw モードや entity_filter は無視されます。

@see REXML::Text#raw, REXML::Text#to_s

//emlist[][ruby]{
require 'rexml/document'
t = REXML::Text.new("< & foobar", false, nil, false)
t.to_s # => "&lt; &amp; foobar"
t.value # => "< & foobar"
//}

• REXML::Text

REXML::Text#value=(val) (42319.0)

• 2.1.0

• インスタンスメソッド

テキストの内容を val に変更します。

テキストの内容を val に変更します。

val には非正規化された(エスケープされていない)文字列を渡さなければ
なりません。

//emlist[][ruby]{
require 'rexml/document'
e = REXML::Element.new("a")
e.add_text("foo")
e[0].value = "bar"
e.to_s # => "<a>bar</a>"
e[0].value = "<a>"
e.to_s # => "<a>&lt;a&gt;</a>"
//}

• REXML::Text

REXML::AttlistDecl#element_name -> String (42301.0)

• 2.1.0

• インスタンスメソッド

属性を定義しているエレメントの名前を返します。

属性を定義しているエレメントの名前を返します。

• REXML::AttlistDecl

REXML::AttlistDecl#include?(key) -> bool (42301.0)

• 2.1.0

• インスタンスメソッド

key が属性名であるならば真を返します。

key が属性名であるならば真を返します。

@param key 属性名であるかどうか判定する文字列

• REXML::AttlistDecl

REXML::Attribute#clone -> REXML::Element (42301.0)

• 2.1.0

• インスタンスメソッド

self を複製し返します。

self を複製し返します。

• REXML::Attribute

絞り込み条件を変える

REXML::Attribute#normalized=(value) (42301.0)

• 2.1.0

• インスタンスメソッド

正規化された属性値を設定します。

正規化された属性値を設定します。

通常はライブラリが自動的にこの値を設定するので
ユーザはこれを使う必要はないでしょう。

@param value 正規化された属性値

• REXML::Attribute

REXML::Attribute#value -> String (42301.0)

• 2.1.0

• インスタンスメソッド

正規化されていない属性値を返します。

正規化されていない属性値を返します。

属性値の正規化については XML の仕様を参考にしてください。

• REXML::Attribute

REXML::CData#clone -> REXML::CData (42301.0)

• 2.1.0

• インスタンスメソッド

self を複製して返します。

self を複製して返します。

親ノードの情報は複製されません。

• REXML::CData

REXML::Child#next_sibling -> REXML::Node (42301.0)

• 2.1.0

• インスタンスメソッド

次の隣接ノードを返します。

次の隣接ノードを返します。

REXML::Node#next_sibling_node の別名です。

@see REXML::Child#next_sibling=

• REXML::Child

REXML::Child#previous_sibling -> REXML::Node (42301.0)

• 2.1.0

• インスタンスメソッド

前の隣接ノードを返します。

前の隣接ノードを返します。

REXML::Node#previous_sibling_node の別名です。

@see REXML::Child#previous_sibling=

• REXML::Child

絞り込み条件を変える

REXML::Child#replace_with(child) -> self (42301.0)

• 2.1.0

• インスタンスメソッド

親ノードの子ノード列上において、 self を child に置き換えます。

親ノードの子ノード列上において、 self を child に置き換えます。

@param child 置き換え後のノード
@see REXML::Parent#replace_child

• REXML::Child

REXML::Comment#clone -> REXML::Comment (42301.0)

• 2.1.0

• インスタンスメソッド

内容が複製された Comment オブジェクトを返します。 (親ノードの情報は複製されません)。

内容が複製された Comment オブジェクトを返します。
(親ノードの情報は複製されません)。

• REXML::Comment

REXML::DocType#clone -> REXML::DocType (42301.0)

• 2.1.0

• インスタンスメソッド

self の複製を返します。

self の複製を返します。

external_id (REXML::DocType#external_id) と
名前(REXML::DocType#name) のみ複製されるため、
結果として得られるオブジェクトはあまり有用ではないでしょう。

• REXML::DocType

REXML::DocType::DEFAULT_ENTITIES -> { String => REXML::Entity } (42301.0)

• 2.1.0

• 定数

XML の仕様上デフォルトで定義されている実体の Hash table。

XML の仕様上デフォルトで定義されている実体の Hash table。

"amp" => REXML::EntityConst::AMP は含まれません。

• REXML::DocType

REXML::Document#clone -> REXML::Document (42301.0)

• 2.1.0

• インスタンスメソッド

self を複製します。

self を複製します。

REXML::Document.new(self) と同じです。

• REXML::Document

絞り込み条件を変える

REXML::Document#xml_decl -> REXML::XMLDecl | nil (42301.0)

• 2.1.0

• インスタンスメソッド

文書の XML 宣言を返します。

文書の XML 宣言を返します。

文書が XML 宣言を持たない場合は nil を返します。

• REXML::Document

REXML::Document.entity_expansion_limit -> Integer (42301.0)

• 2.1.0

• 特異メソッド

実体参照の展開回数の上限を返します。

実体参照の展開回数の上限を返します。

XML 文書(REXML::Document)ごとの展開回数がこの値を越えると
例外を発生させ、処理を中断します。

実体参照の展開処理を使った DoS 攻撃に対抗するための
仕組みです。

デフォルトは 10000 です。

このメソッドは Ruby 2.1 から deprecated になりました。
REXML::Security.entity_expansion_limit を使ってください。

@see REXML::Document.entity_expansion_limit=

• REXML::Document

REXML::Document.entity_expansion_limit=(val) (42301.0)

• 2.1.0

• 特異メソッド

実体参照の展開回数の上限を指定します。

実体参照の展開回数の上限を指定します。

XML 文書(REXML::Document)ごとの展開回数がこの値を越えると
例外を発生させ、処理を中断します。

デフォルトは 10000 です。

このメソッドは Ruby 2.1 から deprecated になりました。
REXML::Security.entity_expansion_limit= を使ってください。

@param val 設定する上限値(整数)
@see REXML::Document.entity_expansion_limit

• REXML::Document

REXML::Document.entity_expansion_text_limit -> Integer (42301.0)

• 2.1.0

• 特異メソッド

実体参照の展開による文字列の増分(テキストのバイト数)の 最大値を指定します。

実体参照の展開による文字列の増分(テキストのバイト数)の
最大値を指定します。

展開によって増分値がこの値を越えると
例外を発生させ、処理を中断します。

実体参照の展開処理を使った DoS 攻撃に対抗するための
仕組みです。

デフォルトは 10240 (byte) です。

このメソッドは Ruby 2.1 から deprecated になりました。
REXML::Security.entity_expansion_text_limit を使ってください。

@see REXML::Document.entity_expansion_text_limit=,
http://ww...

• REXML::Document

REXML::Document.entity_expansion_text_limit=(val) (42301.0)

• 2.1.0

• 特異メソッド

実体参照の展開による文字列の増分(テキストのバイト数)の 最大値を指定します。

実体参照の展開による文字列の増分(テキストのバイト数)の
最大値を指定します。

展開によって増分値がこの値を越えると
例外を発生させ、処理を中断します。

実体参照の展開処理を使った DoS 攻撃に対抗するための
仕組みです。

デフォルトは 10240 (byte) です。

このメソッドは Ruby 2.1 から deprecated になりました。
REXML::Security.entity_expansion_text_limit= を使ってください。

@see REXML::Document.entity_expansion_text_limit
http://www...

• REXML::Document

絞り込み条件を変える

REXML::Document::DECLARATION -> REXML::XMLDecl (42301.0)

• 2.1.0

• 定数

この定数は deprecated です。REXML::XMLDecl.default を 代わりに使ってください。

この定数は deprecated です。REXML::XMLDecl.default を
代わりに使ってください。

デフォルトとして使えるXML宣言オブジェクト。

• REXML::Document

REXML::Element#clone -> REXML::Element (42301.0)

• 2.1.0

• インスタンスメソッド

self を複製して返します。

self を複製して返します。

複製されるのは名前、属性、名前空間のみです。
子ノードは複製されません。

• REXML::Element

REXML::Elements#collect(xpath = nil) {|element| .. } -> [object] (42301.0)

• 2.1.0

• インスタンスメソッド

Enumerable#collect と同様、 各子要素に対しブロックを呼び出し、その返り値の配列を返します。

Enumerable#collect と同様、
各子要素に対しブロックを呼び出し、その返り値の配列を返します。

xpath を指定した場合は、その XPath 文字列に
マッチする要素に対し同様の操作をします。

@param xpath XPath文字列
@see REXML::Elements#each

• REXML::Elements

REXML::Entity#normalized -> String | nil (42301.0)

• 2.1.0

• インスタンスメソッド

正規化された(normalized)実体の値を返します。

正規化された(normalized)実体の値を返します。

すなわち、一切の実体参照を展開していない値を返します。

外部実体(external entity)宣言の場合は nil を返します。

@see REXML::Entity#value, REXML::Entity#unnormalized

• REXML::Entity

REXML::Entity#unnormalized -> String | nil (42301.0)

• 2.1.0

• インスタンスメソッド

非正規化された(unnormalized)実体の値を返します。

非正規化された(unnormalized)実体の値を返します。

すなわち、self が属する DTD によってすべての実体参照(&ent; と %ent; の両方)
を展開した文字列を返します。

外部実体(external entity)宣言の場合は nil を返します。

@see REXML::Entity#value, REXML::Entity#normalized

• REXML::Entity

絞り込み条件を変える

REXML::Entity#value -> String | nil (42301.0)

• 2.1.0

• インスタンスメソッド

実体の値を返します。

実体の値を返します。

パラメータ実体参照(parameter entity)のみが展開され、
そうでない実体参照(general entity)は展開されて
いないような値が返されます。

外部実体(external entity)宣言の場合は nil を返します。

@see REXML::Entity#unnormalized, REXML::Entity#normalized

• REXML::Entity

REXML::EntityConst::LT -> REXML::Entity (42301.0)

• 2.1.0

• 定数

「&lt;」「<」というエンティティを表わすオブジェクト。

「&lt;」「<」というエンティティを表わすオブジェクト。

• REXML::EntityConst

REXML::Instruction#clone -> REXML::Instruction (42301.0)

• 2.1.0

• インスタンスメソッド

self を複製します。

self を複製します。

• REXML::Instruction

REXML::Namespace#fully_expanded_name -> String (42301.0)

• 2.1.0

• インスタンスメソッド

完全修飾名を返します。

完全修飾名を返します。

• REXML::Namespace

REXML::Namespace#local_name -> String (42301.0)

• 2.1.0

• インスタンスメソッド

prefix を含まない「ローカルな」名前を返します。

prefix を含まない「ローカルな」名前を返します。

• REXML::Namespace

絞り込み条件を変える

REXML::Node#next_sibling_node -> REXML::Node | nil (42301.0)

• 2.1.0

• インスタンスメソッド

次の兄弟ノードを返します。

次の兄弟ノードを返します。

次の兄弟ノードが存在しない場合(ノードがルートである場合や、
最後のノードである場合)は nil を返します。

• REXML::Node

REXML::Node#previous_sibling_node -> REXML::Node | nil (42301.0)

• 2.1.0

• インスタンスメソッド

前の兄弟ノードを返します。

前の兄弟ノードを返します。

前の兄弟ノードが存在しない場合(ノードがルートである場合や、
最初のノードである場合)は nil を返します。

• REXML::Node

REXML::NotationDecl#public -> String | nil (42301.0)

• 2.1.0

• インスタンスメソッド

公開識別子を返します。

公開識別子を返します。

宣言が公開識別子を含まない場合は nil を返します。

• REXML::NotationDecl

REXML::NotationDecl#public=(value) (42301.0)

• 2.1.0

• インスタンスメソッド

公開識別子を value に変更します。

公開識別子を value に変更します。

@param value 設定する公開識別子(文字列)

• REXML::NotationDecl

REXML::Parent#deep_clone -> REXML::Parent (42301.0)

• 2.1.0

• インスタンスメソッド

ノードを複製し、複製されたノードを返します。

ノードを複製し、複製されたノードを返します。

子ノードも複製されます。

• REXML::Parent

絞り込み条件を変える

REXML::Parent#delete(object) -> REXML::Child | nil (42301.0)

• 2.1.0

• インスタンスメソッド

object を子ノード列から削除します。

object を子ノード列から削除します。

削除されたノードの親は nil に設定されます。

削除したノードを返します。削除されなかった場合は nil を返します。

@param object 削除するノード

• REXML::Parent

REXML::Parent#delete_at(index) -> REXML::Child | nil (42301.0)

• 2.1.0

• インスタンスメソッド

子ノード列上の index で指定された場所の要素を取り除きます。

子ノード列上の index で指定された場所の要素を取り除きます。

取り除いだノードを返します。indexが範囲外である場合は何もせず
nil を返します。

• REXML::Parent

REXML::Parent#delete_if -> Enumerator (42301.0)

• 2.1.0

• インスタンスメソッド

各子ノードに対しブロックを呼び出し、真を返したノードを削除します。

各子ノードに対しブロックを呼び出し、真を返したノードを削除します。

ブロックを省略した場合は Enumerator を返します。

• Enumerator
• REXML::Parent

REXML::Parent#delete_if {|object| ... } -> () (42301.0)

• 2.1.0

• インスタンスメソッド

各子ノードに対しブロックを呼び出し、真を返したノードを削除します。

各子ノードに対しブロックを呼び出し、真を返したノードを削除します。

ブロックを省略した場合は Enumerator を返します。

• Enumerator
• REXML::Parent

REXML::Parent#each_child -> Enumerator (42301.0)

• 2.1.0

• インスタンスメソッド

各子ノードに対しブロックを呼び出します。

各子ノードに対しブロックを呼び出します。

ブロックを省略した場合は Enumerator を返します。

• Enumerator
• REXML::Parent

絞り込み条件を変える

REXML::Parent#each_child {|object| ... } -> () (42301.0)

• 2.1.0

• インスタンスメソッド

各子ノードに対しブロックを呼び出します。

各子ノードに対しブロックを呼び出します。

ブロックを省略した場合は Enumerator を返します。

• Enumerator
• REXML::Parent

REXML::Parent#length -> Integer (42301.0)

• 2.1.0

• インスタンスメソッド

保持している子ノードの数を返します。

保持している子ノードの数を返します。

• REXML::Parent

REXML::Security.entity_expansion_limit -> Integer (42301.0)

• 2.1.0

• 特異メソッド

実体参照の展開回数の上限を返します。

実体参照の展開回数の上限を返します。

XML 文書(REXML::Document)ごとの展開回数がこの値を越えると
例外を発生させ、処理を中断します。

実体参照の展開処理を使った DoS 攻撃に対抗するための
仕組みです。

デフォルトは 10000 です。

@see REXML::Document.entity_expansion_limit

• REXML::Document
• REXML::Security

REXML::Security.entity_expansion_limit=(val) (42301.0)

• 2.1.0

• 特異メソッド

実体参照の展開回数の上限を指定します。

実体参照の展開回数の上限を指定します。

XML 文書(REXML::Document)ごとの展開回数がこの値を越えると
例外を発生させ、処理を中断します。

デフォルトは 10000 です。

@param val 設定する上限値(整数)
@see REXML::Document.entity_expansion_limit

• REXML::Document
• REXML::Security

REXML::Security.entity_expansion_text_limit -> Integer (42301.0)

• 2.1.0

• 特異メソッド

実体参照の展開による文字列の増分(テキストのバイト数)の 最大値を指定します。

実体参照の展開による文字列の増分(テキストのバイト数)の
最大値を指定します。

展開によって増分値がこの値を越えると
例外を発生させ、処理を中断します。

実体参照の展開処理を使った DoS 攻撃に対抗するための
仕組みです。

デフォルトは 10240 (byte) です。

@see REXML::Document.entity_expansion_text_limit=,
http://www.ruby-lang.org/ja/news/2013/02/22/rexml-dos-2013-02-22/

• REXML::Security

絞り込み条件を変える

REXML::Security.entity_expansion_text_limit=(val) (42301.0)

• 2.1.0

• 特異メソッド

実体参照の展開による文字列の増分(テキストのバイト数)の 最大値を指定します。

実体参照の展開による文字列の増分(テキストのバイト数)の
最大値を指定します。

展開によって増分値がこの値を越えると
例外を発生させ、処理を中断します。

実体参照の展開処理を使った DoS 攻撃に対抗するための
仕組みです。

デフォルトは 10240 (byte) です。

@see REXML::Document.entity_expansion_text_limit
http://www.ruby-lang.org/ja/news/2013/02/22/rexml-dos-2013-02-22/

• REXML::Security

REXML::Text#clone -> REXML::Text (42301.0)

• 2.1.0

• インスタンスメソッド

self を複製します。

self を複製します。

• REXML::Text

REXML::Text.normalize(input, doctype = nil, entity_filter = nil) -> String (42301.0)

• 2.1.0

• 特異メソッド

input を正規化(すべての entity をエスケープ)したものを 返します。

input を正規化(すべての entity をエスケープ)したものを
返します。

@param input 正規化する文字列
@param doctype DTD(REXML::DocType オブジェクト)
@param entity_filter 置換したい実体の名前の配列

• REXML::DocType
• REXML::Text

REXML::Text.unnormalize(string, doctype = nil, filter = nil, illegal = nil) -> String (42301.0)

• 2.1.0

• 特異メソッド

string を非正規化(すべての entity をアンエスケープ)したものを 返します。

string を非正規化(すべての entity をアンエスケープ)したものを
返します。

filter でアンエスケープしない実体の実体名を文字列配列で指定します。

@param string 非正規化する文字列
@param doctype DTD(REXML::DocType オブジェクト)
@param filter アンエスケープしない実体の実体名(文字列配列)
@param illegal 内部用。使わないでください。

//emlist[][ruby]{
require 'rexml/text'
REXML::Text.unnormalize("&amp; &foobar; ...

• REXML::DocType
• REXML::Text

REXML::XMLDecl#clone -> REXML::XMLDecl (42301.0)

• 2.1.0

• インスタンスメソッド

self を複製します。

self を複製します。

• REXML::XMLDecl

絞り込み条件を変える

REXML::XMLDecl#stand_alone? -> String | nil (42301.0)

• 2.1.0

• インスタンスメソッド

スタンドアロン文書であるかどうかを "yes" "no" で 返します。

スタンドアロン文書であるかどうかを "yes" "no" で
返します。

nil(省略)を返す場合もあります。

• REXML::XMLDecl

REXML::XMLDecl#standalone -> String | nil (42301.0)

• 2.1.0

• インスタンスメソッド

スタンドアロン文書であるかどうかを "yes" "no" で 返します。

スタンドアロン文書であるかどうかを "yes" "no" で
返します。

nil(省略)を返す場合もあります。

• REXML::XMLDecl

REXML::XMLDecl#standalone=(value) (42301.0)

• 2.1.0

• インスタンスメソッド

スタンドアロン文書であるかどうかを "yes" "no" で設定します。

スタンドアロン文書であるかどうかを "yes" "no" で設定します。

この属性を省略したい場合は nil を指定します。

@param value 設定値(文字列)

• REXML::XMLDecl

REXML::XMLDecl#xmldecl(version, encoding, standalone) -> () (42301.0)

• 2.1.0

• インスタンスメソッド

内容を更新します。

内容を更新します。

@param version バージョン(文字列)
@param encoding エンコーディング(文字列 or nil)
@param standalone スタンドアロン文章かどうか("yes", "no", nil)

• REXML::XMLDecl

REXML::XMLDecl.default -> REXML::XMLDecl (42301.0)

• 2.1.0

• 特異メソッド

XML宣言を含まない文章でデフォルトで使うための XMLDecl オブジェクトを生成して返します。

XML宣言を含まない文章でデフォルトで使うための
XMLDecl オブジェクトを生成して返します。

• REXML::XMLDecl

絞り込み条件を変える

REXML::XMLDecl (42055.0)

• 2.1.0

• クラス

XML 宣言を表すクラス。

XML 宣言を表すクラス。

文書から XML 宣言を取り出すには REXML::Document#xml_decl を使います。

//emlist[][ruby]{
require 'rexml/document'
doc = REXML::Document.new(<<EOS)
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<e />
EOS

xml_decl = doc.xml_decl
xml_decl.version # => "1.0"
xml_decl.encoding # => "UTF-8"
xml_de...

REXML::ExternalEntity (42019.0)

• 2.1.0

• クラス

DTD 内の宣言でパラメータ実体参照を使って宣言が されているものを表わすクラスです。

DTD 内の宣言でパラメータ実体参照を使って宣言が
されているものを表わすクラスです。

例えば、以下の DTD 宣言における %HTMLsymbol が
それにあたります。

<!ENTITY % HTMLsymbol PUBLIC
"-//W3C//ENTITIES Symbols for XHTML//EN"
"xhtml-symbol.ent">
%HTMLsymbol;

//emlist[][ruby]{
require 'rexml/document'

doctype = REXML::Document.new(<<EOS).doctype
<!DO...

REXML::Formatters::Default (42019.0)

• 2.1.0

• クラス

XMLドキュメントを(文字列として)出力するクラスです。

XMLドキュメントを(文字列として)出力するクラスです。

REXML::Formatters::Pretty と
異なりテキストの改行や空白を修正せずにそのまま出力します。

//emlist[][ruby]{
require 'rexml/document'
require 'rexml/formatters/default'
doc = REXML::Document.new <<EOS
<root>
<children>
<grandchildren/>
</children>
</root>
EOS

default_formatter = REXML::Formatters::...

• REXML::Formatters::Pretty

REXML::NotationDecl (42019.0)

• 2.1.0

• クラス

DTD の記法宣言を表すクラスです。

DTD の記法宣言を表すクラスです。


//emlist[][ruby]{
require 'rexml/document'

doctype = REXML::Document.new(<<EOS).doctype
<!DOCTYPE foo [
<!NOTATION type-image-svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
"http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<!NOTATION type-image-gif PUBLIC "image/gif">...

REXML::AttlistDecl (42001.0)

• 2.1.0

• クラス

DTD の属性リスト宣言を表すクラスです。

DTD の属性リスト宣言を表すクラスです。

絞り込み条件を変える

REXML::Child (42001.0)

• 2.1.0

• クラス

あるノード(親ノード)に子ノードとして保持されている ノードを表すクラスです。

あるノード(親ノード)に子ノードとして保持されている
ノードを表すクラスです。

親にアクセスするためには REXML::Child#parent を使います。

REXML::Declaration (42001.0)

• 2.1.0

• クラス

DTD に含まれる各種宣言ノードを表すクラスです。

DTD に含まれる各種宣言ノードを表すクラスです。

このクラス自体は直接はインスタンスを作りません。
各サブクラスのインスタンスが使われます。

REXML::Element (42001.0)

• 2.1.0

• クラス

XML の要素(エレメント、element)を表すクラス。

XML の要素(エレメント、element)を表すクラス。

要素は
* 子要素(children)
* 属性(attributes)
* 名前(name)
を持つものとして特徴付けられます。

また、要素はある別の要素の子となることもできます。

REXML::ElementDecl (42001.0)

• 2.1.0

• クラス

DTD の要素宣言(Element Declaration)を表すクラスです。

DTD の要素宣言(Element Declaration)を表すクラスです。

REXML::Elements (42001.0)

• 2.1.0

• クラス

要素の集合を表すクラスです。

要素の集合を表すクラスです。

XPath による探索をサポートします。

REXML::Element#elements はこのオブジェクトを返します。
XPath で相対パスを指定した場合は、この REXML::Element#elements の
レシーバが基準要素となります。

絞り込み条件を変える

REXML::XMLTokens (42001.0)

• 2.1.0

• モジュール

XML をパースするための正規表現を保持しているモジュールです。

XML をパースするための正規表現を保持しているモジュールです。

ユーザがこのモジュールを必要とすることはないでしょう。

REXML::DocType#write(output, indent = 0, transitive = false, ie_hack = false) -> () (33619.0)

• 2.1.0

• インスタンスメソッド

output に DTD を出力します。

output に DTD を出力します。

このメソッドは deprecated です。REXML::Formatter で
出力してください。

@param output 出力先の IO オブジェクト
@param indent インデントの深さ。指定しないでください。
@param transitive 無視されます。指定しないでください。
@param ie_hack 無視されます。指定しないでください。

//emlist[][ruby]{
require 'rexml/document'

doctype = REXML::Document.new(<<EOS).doctype
<...

• REXML::DocType
• REXML::Formatter

REXML::Element#root_node -> REXML::Document | REXML::Node (33619.0)

• 2.1.0

• インスタンスメソッド

self が属する文書のルートノードを返します。

self が属する文書のルートノードを返します。

通常はその要素が属する文書(REXML::Document) オブジェクトが
返されます。

その要素が属する REXML::Document オブジェクトが存在しない
場合は木構造上のルートノードが返されます。

//emlist[][ruby]{
require 'rexml/document'
doc = REXML::Document.new(<<EOS)
<root>
<children>
<grandchildren />
</children>
</root>
EOS

children = doc.get_elements...

• REXML::Document
• REXML::Element

REXML::Elements#<<(element = nil) -> REXML::Element (33619.0)

• 2.1.0

• インスタンスメソッド

要素 element を追加します。

要素 element を追加します。

element には文字列もしくは REXML::Element オブジェクトを
指定します。文字列を指定した場合には REXML::Element.new(element)
で生成される要素を追加します。

element を省略した場合は、空の要素が追加されます。

追加された要素が返されます。

@param element 追加する要素

//emlist[][ruby]{
require 'rexml/document'
a = REXML::Element.new('a')
a.elements.add(REXML::Element.new...

• REXML::Element
• REXML::Elements

REXML::Elements#add(element = nil) -> REXML::Element (33619.0)

• 2.1.0

• インスタンスメソッド

要素 element を追加します。

要素 element を追加します。

element には文字列もしくは REXML::Element オブジェクトを
指定します。文字列を指定した場合には REXML::Element.new(element)
で生成される要素を追加します。

element を省略した場合は、空の要素が追加されます。

追加された要素が返されます。

@param element 追加する要素

//emlist[][ruby]{
require 'rexml/document'
a = REXML::Element.new('a')
a.elements.add(REXML::Element.new...

• REXML::Element
• REXML::Elements

絞り込み条件を変える