オブジェクト組み込みオブジェクト

オブジェクト XmlDocument

XmlDocument オブジェクトは XML ドキュメント全体を表します

XmlDocument オブジェクトは、ドキュメント ツリーのルートであり、ドキュメント データへの最初の (または最上位の) アクセスを提供します。要素ノード、テキスト ノード、コメント、処理命令などはすべて XmlDocument の外部に存在できず、XmlDocument オブジェクトはこれらのオブジェクトを作成するためのメソッドも提供します。XmlNode オブジェクトは、オブジェクトが作成された XmlDocument に関連付ける ownerDocument プロパティを提供します。

継承

#lineWidth: 1.5 #font: Helvetica,sans-Serif #fontSize: 10 #leading: 1.6 #.this: fill=lightgray #.class: fill=white [<class>object|toString();toJSON()] [<class>XmlNode|nodeType;nodeName;nodeValue;ownerDocument;parentNode;childNodes;firstChild;lastChild;previousSibling;nextSibling|hasChildNodes();normalize();cloneNode();lookupPrefix();lookupNamespaceURI();insertBefore();insertAfter();appendChild();replaceChild();removeChild()] [<this>XmlDocument|new XmlDocument()|inputEncoding;xmlStandalone;xmlVersion;doctype;documentElement;head;title;body|load();getElementsByTagName();getElementsByTagNameNS();getElementById();getElementsByClassName();createElement();createElementNS();createTextNode();createComment();createCDATASection();createProcessingInstruction()] [object] <:- [XmlNode] [XmlNode] <:- [XmlDocument] XmlDocument new XmlDocument() inputEncoding xmlStandalone xmlVersion doctype documentElement head title body load() getElementsByTagName() getElementsByTagNameNS() getElementById() getElementsByClassName() createElement() createElementNS() createTextNode() createComment() createCDATASection() createProcessingInstruction() XmlNode nodeType nodeName nodeValue ownerDocument parentNode childNodes firstChild lastChild previousSibling nextSibling hasChildNodes() normalize() cloneNode() lookupPrefix() lookupNamespaceURI() insertBefore() insertAfter() appendChild() replaceChild() removeChild() object toString() toJSON()

コンストラクタ

XmlDocument

XmlDocument オブジェクトを構築する

1
new XmlDocument(String type = "text/xml");

呼び出しパラメータ:

  • type: 文字列、ドキュメント オブジェクトのタイプを指定します。デフォルトは「text/xml"、htmlを処理する必要がある場合は、「text/html」を指定する必要があります

メンバーの属性

inputEncoding

文字列、ドキュメントに使用されるエンコーディングを返します (解析時)

1
readonly String XmlDocument.inputEncoding;

xmlStandalone

ブール値、ドキュメントがスタンドアロンかどうかを設定または返します

1
Boolean XmlDocument.xmlStandalone;

xmlVersion

文字列、ドキュメントの XML バージョンを設定または返します

1
String XmlDocument.xmlVersion;

doctype

XmlDocumentType, 文書に関連する文書型宣言を返します (文書型宣言)

1
readonly XmlDocumentType XmlDocument.doctype;

DTD のない XML ドキュメントの場合、null が返されます。この属性は提供できますXmlDocumentType オブジェクト (XmlDocument の子ノード) への直接アクセス。


documentElement

XmlElement、ドキュメントのルート ノードを返します

1
readonly XmlElement XmlDocument.documentElement;

XmlElement、HTML ドキュメントのヘッド ノードを返します。html モードでのみ有効です。

1
readonly XmlElement XmlDocument.head;

title

文字列、HTML ドキュメントのタイトル ノードのコンテンツを返します。html モードでのみ有効です。

1
readonly String XmlDocument.title;

body

XmlElement、HTML ドキュメントの body ノードを返します。html モードでのみ有効です。

1
readonly XmlElement XmlDocument.body;

nodeType

整数、ノードのノード タイプを返します

1
readonly Integer XmlDocument.nodeType;

異なるオブジェクトの nodeType は異なる値を返します。


nodeName

文字列、タイプに応じてノードの名前を返します

1
readonly String XmlDocument.nodeName;

異なるオブジェクトの nodeName は異なる値を返します。


nodeValue

文字列、タイプに応じてノードの名前を返します

1
String XmlDocument.nodeValue;

異なるオブジェクトの nodeName は異なる値を返します。


ownerDocument

XmlDocument、ノードのルート要素を返します (XmlDocument オブジェクト)

1
readonly XmlDocument XmlDocument.ownerDocument;

parentNode

XmlNode、ノードの親ノードを返すことができます

1
readonly XmlNode XmlDocument.parentNode;

childNodes

XmlNodeList, 指定されたノードの子ノードのノード リストを返します

1
readonly XmlNodeList XmlDocument.childNodes;

firstChild

XmlNode、ノードの最初の子ノードを返します

1
readonly XmlNode XmlDocument.firstChild;

lastChild

XmlNode、ノードの最後の子ノードを返します

1
readonly XmlNode XmlDocument.lastChild;

previousSibling

XmlNode, 特定のノード (同じツリー レベル) の直前のノードを返します。そのようなノードがない場合、属性は null を返します。

1
readonly XmlNode XmlDocument.previousSibling;

nextSibling

XmlNode(同じツリー レベル内の) 要素の直後のノードを返します。そのようなノードがない場合、プロパティは null を返します。

1
readonly XmlNode XmlDocument.nextSibling;

メンバー関数

load

XML/HTML 文字列を解析してドキュメントを作成します。多言語をサポートしていません

1
XmlDocument.load(String source);

呼び出しパラメータ:

  • source: 文字列、作成時のドキュメントの種類に応じて解析される XML/HTML テキスト

ドキュメントはバイナリXML/HTML文字列を解析して構成され、言語に従って自動的に変換されます

1
XmlDocument.load(Buffer source);

呼び出しパラメータ:

  • source: Buffer、解析される XML/HTML テキストは、作成時のドキュメントの種類によって異なります

getElementsByTagName

指定された名前を持つすべての要素のノード リストを返します。

1
XmlNodeList XmlDocument.getElementsByTagName(String tagName);

呼び出しパラメータ:

  • tagName: 文字列、取得するタグ名。値「*」はすべてのタグに一致します

結果を返す:

  • XmlNodeList、ドキュメントツリー内の指定されたマークで XmlElement 節点 XmlNodeListセットする。返される要素ノードの順序は、ソース ドキュメントに表示される順序です。

このメソッドは XmlNodeList オブジェクト (読み取り専用配列として処理可能)、オブジェクトは指定されたタグ名を持つすべてのドキュメントを格納します XmlElement ノード、それらが保存される順序は、ソース ドキュメントに表示される順序です。 XmlNodeList オブジェクトは「ライブ」です。つまり、指定されたタグ名を持つ要素がドキュメントに追加または削除されると、そのコンテンツは必要に応じて自動的に更新されます。


getElementsByTagNameNS

指定された名前空間と名前のすべての要素を持つノードのリストを返します

1 2
XmlNodeList XmlDocument.getElementsByTagNameNS(String namespaceURI, String localName);

呼び出しパラメータ:

  • namespaceURI: 文字列、取得する名前空間 URI を指定します。値「*」はすべてのタグに一致します
  • localName: 文字列、取得するタグ名。値「*」はすべてのタグに一致します

結果を返す:

  • XmlNodeList、ドキュメントツリー内の指定されたマークで XmlElement 節点 XmlNodeListセットする。返される要素ノードの順序は、ソース ドキュメントに表示される順序です。

このメソッドは getElementsByTagName() メソッドに似ていますが、名前空間と名前に基づいて要素を取得する点が異なります。


getElementById

指定されたid属性を持つ要素を返します

1
XmlElement XmlDocument.getElementById(String id);

呼び出しパラメータ:

  • id: 文字列、取得するID

結果を返す:

このメソッドは、ドキュメントの子孫ノードをトラバースし、 XmlElementノード オブジェクトは、指定された id 属性を持つ最初のドキュメント要素を表します。.


getElementsByClassName

指定されたクラス名を持つすべての要素のノード リストを返します。

1
XmlNodeList XmlDocument.getElementsByClassName(String className);

呼び出しパラメータ:

  • className: 文字列、取得するクラスの名前

結果を返す:

  • XmlNodeList、ドキュメントツリー内の指定されたクラス名で XmlElement 節点 XmlNodeListセットする。返される要素ノードの順序は、ソース ドキュメントに表示される順序です。

このメソッドは XmlNodeList ドキュメント内の指定されたクラス名を持つすべてのファイルを格納するオブジェクト (読み取り専用配列として処理可能) XmlElement ノード、それらが保存される順序は、ソース ドキュメントに表示される順序です。 XmlNodeList オブジェクトは「ライブ」です。つまり、指定されたタグ名を持つ要素がドキュメントに追加または削除されると、そのコンテンツは必要に応じて自動的に更新されます。


createElement

要素ノードを作成

1
XmlElement XmlDocument.createElement(String tagName);

呼び出しパラメータ:

  • tagName: 文字列、要素ノードの指定された名前を指定します

結果を返す:

  • XmlElement、新しく作成したものを返す XmlElement 指定されたラベル名を持つノード

createElementNS

指定された名前空間で要素ノードを作成します

1 2
XmlElement XmlDocument.createElementNS(String namespaceURI, String qualifiedName);

呼び出しパラメータ:

  • namespaceURI: 文字列、要素ノードの名前空間の URI を指定します
  • qualifiedName: 文字列、要素ノードの指定された名前を指定します

結果を返す:

  • XmlElement、新しく作成したものを返す XmlElement 指定されたラベル名を持つノード

createTextNode

テキストノードを作成

1
XmlText XmlDocument.createTextNode(String data);

呼び出しパラメータ:

  • data: 文字列、このノードのテキストを指定します

結果を返す:

  • XmlText、新しく作成したものを返す XmlText 指定されたデータ文字列を表すノード

createComment

コメントノードの作成

1
XmlComment XmlDocument.createComment(String data);

呼び出しパラメータ:

  • data: 文字列、このノードのコメント テキストを指定します

結果を返す:

  • XmlComment、新しく作成したものを返す XmlComment ノード、コメントテキストは指定されたデータです

createCDATASection

作成する XmlCDATASection ノード

1
XmlCDATASection XmlDocument.createCDATASection(String data);

呼び出しパラメータ:

  • data: 文字列、このノードを指定してCDATAデータを指定します

結果を返す:


createProcessingInstruction

作成する XmlProcessingInstruction ノード

1 2
XmlProcessingInstruction XmlDocument.createProcessingInstruction(String target, String data);

呼び出しパラメータ:

  • target: 文字列、処理命令の対象を指定
  • data: 文字列、処理命令の内容テキストを指定します

結果を返す:


hasChildNodes

子ノードがあるかどうかを問い合わせる

1
Boolean XmlDocument.hasChildNodes();

結果を返す:

  • Boolean、子ノードがある場合は true を返し、そうでない場合は false を返します。

normalize

隣接するテキスト ノードをマージし、空のテキスト ノードを削除します

1
XmlDocument.normalize();

このメソッドは、現在のノードのすべての子孫をトラバースし、空の Text ノードを削除し、隣接するすべての Text ノードをマージすることによってドキュメントを正規化します。このメソッドは、ノードを挿入または削除した後で、ドキュメント ツリーの構造を簡素化する場合に便利です。


cloneNode

指定されたノードの正確なコピーを作成します

1
XmlNode XmlDocument.cloneNode(Boolean deep = true);

呼び出しパラメータ:

  • deep: ブール値、ディープ コピーするかどうか、true の場合、クローン ノードは元のノードのすべての子ノードをクローンします

結果を返す:

  • XmlNode、コピーしたノードを返す

このメソッドは、それを呼び出したノードのコピーをコピーして返します。渡されたパラメータが true の場合、現在のノードのすべての子孫も再帰的にコピーします。それ以外の場合は、現在のノードのみをコピーします。返されたノードはドキュメント ツリーに属しておらず、その parentNode プロパティは null です。Element ノードがコピーされると、そのすべての属性がコピーされます。


lookupPrefix

現在のノードで指定された名前空間 URI に一致するプレフィックスを返します。

1
String XmlDocument.lookupPrefix(String namespaceURI);

呼び出しパラメータ:

  • namespaceURI: 文字列、一致する名前空間 URI を指定します

結果を返す:

  • String、一致したプレフィックスを返し、一致しない場合は null を返します

lookupNamespaceURI

現在のノードで指定されたプレフィックスに一致する名前空間 URI を返します

1
String XmlDocument.lookupNamespaceURI(String prefix);

呼び出しパラメータ:

  • prefix: 文字列、一致するプレフィックスを指定します

結果を返す:

  • String、一致する名前空間 URI を返し、一致しない場合は null を返します

insertBefore

既存の子ノードの前に新しい子ノードを挿入します

1 2
XmlNode XmlDocument.insertBefore(XmlNode newChild, XmlNode refChild);

呼び出しパラメータ:

  • newChild: XmlNode、新しいノードを挿入
  • refChild: XmlNode, このノードの前に新しいノードを挿入します

結果を返す:

  • XmlNode、新しい子ノードを返す

newChild がドキュメント ツリーに既に存在する場合は、ドキュメント ツリーから削除され、新しい位置に再挿入されます。あるドキュメントのノード (または 1 つのドキュメントによって作成されたノード) を別のドキュメントに挿入することはできません。つまり、newChild の ownerDocument プロパティは、現在のノードの ownerDocument プロパティと同じである必要があります。


insertAfter

既存の子ノードの後に​​新しい子ノードを挿入します

1 2
XmlNode XmlDocument.insertAfter(XmlNode newChild, XmlNode refChild);

呼び出しパラメータ:

  • newChild: XmlNode、新しいノードを挿入
  • refChild: XmlNode, このノードの後に​​新しいノードを挿入します

結果を返す:

  • XmlNode、新しい子ノードを返す

newChild がドキュメント ツリーに既に存在する場合は、ドキュメント ツリーから削除され、新しい位置に再挿入されます。あるドキュメントのノード (または 1 つのドキュメントによって作成されたノード) を別のドキュメントに挿入することはできません。つまり、newChild の ownerDocument プロパティは、現在のノードの ownerDocument プロパティと同じである必要があります。


appendChild

ノードの子ノード リストの最後に新しい子ノードを追加します

1
XmlNode XmlDocument.appendChild(XmlNode newChild);

呼び出しパラメータ:

  • newChild: XmlNode、追加したノードを指定

結果を返す:

  • XmlNode、この新しい子ノードを返す

newChild がドキュメント ツリーに既に存在する場合は、ドキュメント ツリーから削除され、新しい位置に再挿入されます。あるドキュメントのノード (または 1 つのドキュメントによって作成されたノード) を別のドキュメントに挿入することはできません。つまり、newChild の ownerDocument プロパティは、現在のノードの ownerDocument プロパティと同じである必要があります。


replaceChild

子ノードを別の子ノードに置き換える

1 2
XmlNode XmlDocument.replaceChild(XmlNode newChild, XmlNode oldChild);

呼び出しパラメータ:

  • newChild: XmlNode、新しいノードを指定
  • oldChild: XmlNode、交換するノードを指定

結果を返す:

  • XmlNode、置換が成功した場合、このメソッドは置換されたノードを返すことができ、置換が失敗した場合は null を返します

newChild がドキュメント ツリーに既に存在する場合は、ドキュメント ツリーから削除され、新しい位置に再挿入されます。あるドキュメントのノード (または 1 つのドキュメントによって作成されたノード) を別のドキュメントに挿入することはできません。つまり、newChild の ownerDocument プロパティは、現在のノードの ownerDocument プロパティと同じである必要があります。


removeChild

子ノードのリストからノードを削除します

1
XmlNode XmlDocument.removeChild(XmlNode oldChild);

呼び出しパラメータ:

  • oldChild: XmlNode、削除するノードを指定

結果を返す:

  • XmlNode、削除が成功した場合、このメソッドは削除されたノードを返すことができ、失敗した場合は null を返します。

toString

オブジェクトの文字列表現を返します。通常は「[ネイティブ オブジェクト]」を返します。オブジェクトは独自の特性に従って再実装できます。

1
String XmlDocument.toString();

結果を返す:

  • String、オブジェクトの文字列表現を返します

toJSON

オブジェクトの JSON 形式の表現を返します。通常は、オブジェクトによって定義された読み取り可能な属性のコレクションを返します。

1
Value XmlDocument.toJSON(String key = "");

呼び出しパラメータ:

  • key: ストリング、未使用

結果を返す:

  • Value、シリアライズ可能なJSONを含む値を返します