継承図

協調図

解説

DOM パーサー（SFXXMLDOMParser）は、 XML 文書をデータの順序に関係なくアクセスできる「 DOM ツリー 」と呼ばれるツリー構造に変換します。

	仕様上の制約
	解析の対象となるファイルは、携帯端末のローカルファイルである必要があります（サーバーのファイルを直接指定することはできません）。 エンティティ参照については、エンティティの実体に置き換えられません。

	DOM（Document Object Model）の仕様
	W3C DOM レベル 3 コア仕様 : Document Object Model (DOM) Level 3 Core Specification

// 解析対象の XML 文書 ( file.xml )
<fruit>
    <name language="english" code="ascii">apple</name>
    <size>XS</size>
    <color>red</color>
</fruit>

SFCError error;             // エラー値
SFXXMLDOMParser parser;     // DOM パーサー
SFXAnsiString resultString; // 属性値を一時的に格納するための変数

// file.xml に保存した XML 文書を解析する
if ((error = parser.Parse(SFXPath("/file.xml"))) == SFERR_NO_ERROR) {

    // DOM ツリーのルートノードを取得する
    SFXXMLDocumentPtr root = parser.GetDocument(); 

    // DOM ツリーのルートノードの最初の子ノード ( XML 文書のルート要素: "fruit" 要素 ) を取得する
    SFXXMLNodePtr child = root->GetFirstChild();  
    
    // "fruit" 要素の最初の子ノード ( "name" 要素 ) を取得する
    child = child->GetFirstChild();   

    // child ノードの名前(要素名)が "name" のとき
    if (SFXAnsiString("name").Equals(child->GetNodeName())) {

        // 属性を取得するために Element ノードにキャストする
        SFXXMLElementPtr element = static_cast<SFXXMLElementPtr>(child);

        // "language" という名前(属性名)の Attribute ノードの値を取得する
        // resultString は "english" になる
        resultString = element->GetAttribute("language");

        // 名前(属性名)が "language" である Attribute ノードを取得する
        SFXXMLAttributePtr attr = element->GetAttributeNode("language");
        
        // Attribute ノードの値(属性値)を取得する
        resultString = attr->GetNodeValue();
        
        // すべての Attribute ノードを取得する
        SFXXMLNode::DOMNamedNodeMapPtr nodeMap = element->GetAttributes();

        // "code"という名前(属性名)の Attribute ノードを取得する
        attr = static_cast<SFXXMLAttributePtr>(nodeMap->GetNamedItem("code"));

        // Attribute ノードの値(属性値)を取得する
        resultString = attr->GetNodeValue();
    }
}

参照

SFXXMLSAXParser | SFXXMLDefaultHandler

メンバ

解説

このコンストラクタは、この XML パーサーの各種初期設定を行います。

解説

この関数は、この XML パーサーが使用している、 すべての内部変数をリセットします。

	注意
	内部的に SFXXMLDOMParser::Reset 関数を呼び出します。

参照

SFXXMLDOMParser::Reset

戻り値

Comment ノード生成フラグ値

解説

この関数は、Comment ノードを生成するかどうかのフラグ値（Comment ノード生成フラグ値）を取得します。

参照

SFXXMLDOMParser::SetCreateCommentNodes

戻り値

インデント処理フラグ値

解説

この関数は、インデント処理するかどうかのフラグ値（インデント処理フラグ値）を取得します。

	注意
	このフラグを ON（true）に設定すると、 XML 文書を処理するときに、 XML プロローグ、ルート要素、コメントと CDATA セクションの内部を除く各行について、 先頭タグの前と前行の末尾の空白部分をテキストとするインデント用 Text のノードが挿入されます。

参照

SFXXMLDOMParser::SetDoIndent

戻り値

名前空間処理フラグ値

解説

この関数は、名前空間を処理するかどうかのフラグ値（名前空間処理フラグ値）を取得します。

	注意
	このフラグを ON（true）に設定すると、 このパーサーで DOM ツリーを構築するときに、 Element と Attribute の各ノードに名前空間 URI が設定されます。 そして、Element ノードと Attribute ノードには、 末尾が NS である名前の関数で名前空間 URI とローカル名を指定してアクセスすることが可能になります。

参照

SFXXMLDOMParser::SetDoNamespaces

戻り値

スキーマ処理フラグ値

解説

この関数は、この XML パーサーが XML 文書のスキーマを処理するかどうかのフラグ値（スキーマ処理フラグ値）を取得します。

参照

SFXXMLDOMParser::SetDoSchema

戻り値

Document ノード

解説

この関数は、SFXXMLDOMParser::Parse 関数による XML 文書解析後の DOM ツリーのルートである、 Document ノードを取得します。

	注意
	Document ノードは DOM ツリーのルートノードです。

参照

SFXXMLDOMParser::Parse

戻り値

XML 文書解析中に発生したエラーメッセージ

解説

この関数は、XML 文書解析中に発生したエラーメッセージを取得します。

	注意
	エラー値は、static_exception::static_catch 関数により取得できます。

参照

static_exception::static_catch

参照

SFXXMLDOMParser::GetFirstChildElementNS | SFXXMLDOMParser::GetNextSiblingElement | SFXXMLDOMParser::GetNextSiblingElementNS

解説

	注意
	引数で指定する、名前空間 URI、および要素のローカル名(複数指定可能)と一致する必要があります。

参照

SFXXMLDOMParser::GetFirstChildElement | SFXXMLDOMParser::GetNextSiblingElement | SFXXMLDOMParser::GetNextSiblingElementNS

戻り値

Annotation 要素検証無効フラグ値

解説

この関数は、XML スキーマの Annotation 要素の検証を無効にするかどうかのフラグ値（Annotation 要素検証無効フラグ値）を取得します。

	注意
	現バージョンでは、Annotation 要素検証無効フラグ値を OFF にしても検証は行われません（このフラグは無効です）。

参照

SFXXMLDOMParser::SetIgnoreAnnotations

戻り値

外部 DTD 読み込みフラグ値

解説

この関数は、この XML パーサーが XML 文書内に指定された、 外部 DTD ファイルをロードするかどうかのフラグ値（外部 DTD 読み込みフラグ値）を取得します。

参照

SFXXMLDOMParser::SetLoadExternalDTD

参照

SFXXMLDOMParser::GetNextSiblingElementNS | SFXXMLDOMParser::GetFirstChildElement | SFXXMLDOMParser::GetFirstChildElementNS

解説

	注意
	引数で指定する、名前空間 URI、および要素のローカル名(複数指定可能)と一致する必要があります。

参照

SFXXMLDOMParser::GetNextSiblingElement | SFXXMLDOMParser::GetFirstChildElement | SFXXMLDOMParser::GetFirstChildElementNS

戻り値

XML 文書の Standalone 宣言の内容

解説

この関数は、XML 文書の Standalone 宣言の内容を取得します。

戻り値

DTD 検証フラグ値

解説

この関数は、この XML パーサーが XML 文書を DTD で検証するかどうかのフラグ値（DTD 検証フラグ値）を取得します。

参照

SFXXMLDOMParser::SetValidationDTD

戻り値

スキーマ検証フラグ値

解説

この関数は、この XML パーサーが XML 文書をスキーマで検証するかどうかのフラグ値（スキーマ検証フラグ値）を取得します。

参照

SFXXMLDOMParser::SetValidationSchema

戻り値

XML 文書の解析後、 static_exception::static_catch 関数により取得できる、その他のエラー値は以下の通りです。

DTD 付き XML 文書の解析結果のエラーコードは以下の通りです。

スキーマ付き XML 文書の解析結果のエラーコードは以下の通りです。

詳細情報: SFCErrorEnum

解説

この関数は、XML 文書（ファイル、ストリーム、文字列）を読み込み、DOM 方式で解析します。

引数にはストリーム、ファイルパス、文字列を渡します。 ファイルパスのデフォルト ディレクトリはアプリのホームディレクトリです。

	注意
	BREW の制約により、ファイルの絶対パスは 64 文字より小さくなければいけません。 また、携帯端末内のローカルファイルを指定する必要があります（サーバーのファイルは指定できません）。

参照

static_exception::static_catch | SFCErrorEnum

解説

この関数は、この XML パーサーが使用している、 すべての内部変数をリセットします。

参照

SFXXMLDOMParser::~SFXXMLDOMParser

解説

この関数は、Comment ノードを生成するかどうかのフラグ値（Comment ノード生成フラグ値）を設定します。

デフォルト値: OFF（false）[デフォルトの設定では、Comment ノードは生成されません。]

参照

SFXXMLDOMParser::GetCreateCommentNodes

解説

この関数は、インデント処理するかどうかのフラグ値（インデント処理フラグ値）を設定します。

デフォルト値: OFF（false）[デフォルトの設定では、インデント処理されません。]

	注意
	このフラグを ON（true）に設定すると、 XML 文書を処理するときに、 XML プロローグ、ルート要素、コメントと CDATA セクションの内部を除く各行について、 先頭タグの前と前行の末尾の空白部分をテキストとするインデント用 Text のノードが挿入されます。

参照

SFXXMLDOMParser::GetDoIndent

解説

この関数は、名前空間を処理するかどうかのフラグ値（名前空間処理フラグ値）を設定します。

デフォルト値: OFF（false）[デフォルトの設定では、名前空間は処理されません。]

	注意
	SFXXMLDOMParser::SetDoSchema 関数によりスキーマ処理フラグを ON に設定する場合は、 この関数を呼び出して名前空間処理フラグも ON にする必要があります。

	注意
	このフラグを ON（true）に設定すると、 このパーサーで DOM ツリーを構築するときに、 Element と Attribute の各ノードに名前空間 URI が設定されます。 そして、Element ノードと Attribute ノードには、 末尾が NS である名前の関数で名前空間 URI とローカル名を指定してアクセスすることが可能になります。

参照

SFXXMLDOMParser::GetDoNamespaces | SFXXMLDOMParser::GetFirstChildElementNS | SFXXMLDOMParser::GetNextSiblingElementNS | SFXXMLDOMParser::SetDoSchema

解説

この関数は、この XML パーサーが XML 文書のスキーマを処理するかどうかのフラグ値（スキーマ処理フラグ値）を設定します。

デフォルト値: OFF（false）[デフォルトの設定では、スキーマは処理されません。]

	注意
	XML 文書のスキーマを処理するには、 SFXXMLDOMParser::SetDoNamespaces 関数を呼び出して名前空間処理フラグを ON にする必要があります。

	注意
	XML 文書をスキーマで検証するには、以下の設定も必要です。 SFXXMLDOMParser::SetGrammar 関数を呼び出して文法を SFXXMLGrammar::GRAMMAR_SCHEMA に設定します。 SFXXMLDOMParser::SetDoNamespaces 関数を呼び出して名前空間処理フラグを ON に設定します。 SFXXMLDOMParser::SetValidationSchema 関数を呼び出してスキーマ検証フラグを ON に設定します。 SFXXMLDOMParser::SetSchemaLocation 関数を呼び出して XSD ファイルを設定します。

参照

SFXXMLDOMParser::GetDoSchema | SFXXMLDOMParser::SetDoNamespaces | SFXXMLGrammar::GrammarType | SFXXMLDOMParser::SetValidationSchema | SFXXMLDOMParser::SetSchemaLocation

引数

解説

この関数は、XML パーサーが解析する XML 文書の記述内容を規定する文法（言語）を設定します。

grammar 引数に指定できる文法の種類は以下の通りです。

デフォルト値: SFXXMLGrammar::GRAMMAR_UNKNOWN（XML 文書の記述内容を規定する文法なし）

	DOCTYPE 宣言
	XML 文書内の DOCTYPE 宣言の内容は、 この関数で文法が SFXXMLGrammar::GRAMMAR_DTD に設定された場合にだけ読み込まれます。 デフォルトの設定（SFXXMLGrammar::GRAMMAR_UNKNOWN）では読み込まれません。

参照

SFXXMLGrammar::GrammarType | SFXXMLDOMParser::SetValidationDTD | SFXXMLDOMParser::SetLoadExternalDTD | SFXXMLDOMParser::SetDoSchema | SFXXMLDOMParser::SetValidationSchema | SFXXMLDOMParser::SetSchemaLocation

解説

この関数は、 XML スキーマの Annotation 要素の検証を無効にするかどうかのフラグ値（Annotation 要素検証無効フラグ値）を設定します。

デフォルト値: ON（true）

	注意
	Annotation 要素検証無効フラグは、XML 文書を XML スキーマで検証する場合のみ有効です。 デフォルトの設定では、Annotation 要素検証無効フラグは true なので、 XML スキーマの Annotation 要素の検証は行われません。

	注意
	現バージョンでは、Annotation 要素検証無効フラグ値を OFF にしても検証は行われません（このフラグは無効です）。

参照

SFXXMLDOMParser::GetIgnoreAnnotations | SFXXMLDOMParser::SetGrammar | SFXXMLDOMParser::SetDoSchema | SFXXMLDOMParser::SetValidationSchema | SFXXMLDOMParser::SetSchemaLocation

解説

この関数は、この XML パーサーが XML 文書内に指定された、 外部 DTD ファイルをロードするかどうかのフラグ値（外部 DTD 読み込みフラグ値）を設定します。

デフォルト値: OFF（false）[デフォルトの設定では、外部 DTD ファイルはロードされません。]

	注意
	XML 文書を外部 DTD ファイルをロードして検証するには、以下の設定も必要です。 SFXXMLDOMParser::SetGrammar 関数を呼び出して文法を SFXXMLGrammar::GRAMMAR_DTD に設定します。 SFXXMLDOMParser::SetValidationDTD 関数を呼び出して DTD 検証フラグを ON にします。 DTD 検証フラグが ON の場合は、外部 DTD ファイルは自動的にロードされます。

	注意
	BREW の制約により、ファイルの絶対パスは 64 文字より小さくなければいけません。 また、携帯端末内のローカルファイルを指定する必要があります（サーバーのファイルは指定できません）。

参照

SFXXMLDOMParser::SetGrammar | SFXXMLDOMParser::SetValidationDTD | SFXXMLGrammar::GrammarType | SFXXMLDOMParser::GetLoadExternalDTD

解説

この関数は、この XML パーサーが XML 文書を検証するための XSD ファイルを設定します。

	注意
	XML 文書をスキーマで検証するには、以下の設定も必要です。 SFXXMLDOMParser::SetGrammar 関数を呼び出して文法を SFXXMLGrammar::GRAMMAR_SCHEMA に設定します。 SFXXMLDOMParser::SetDoSchema 関数を呼び出してスキーマ処理フラグを ON に設定します。 SFXXMLDOMParser::SetDoNamespaces 関数を呼び出して名前空間処理フラグを ON に設定します。 SFXXMLDOMParser::SetValidationSchema 関数を呼び出してスキーマ検証フラグを ON に設定します。

	注意
	BREW の制約により、ファイルの絶対パスは 64 文字より小さくなければいけません。 また、携帯端末内のローカルファイルを指定する必要があります（サーバーのファイルは指定できません）。

参照

SFXXMLGrammar::GrammarType | SFXXMLDOMParser::SetDoSchema | SFXXMLDOMParser::SetDoNamespaces | SFXXMLDOMParser::SetValidationSchema | SFXXMLDOMParser::GetValidationSchema

解説

この関数は、この XML パーサーが XML 文書を DTD で検証するかどうかのフラグ値（DTD 検証フラグ値）を設定します。

デフォルト値: OFF（false）[デフォルトの設定では、DTD で検証されません。]

	注意
	XML 文書を DTD で検証するには、以下の設定も必要です。 SFXXMLDOMParser::SetGrammar 関数を呼び出して文法を SFXXMLGrammar::GRAMMAR_DTD に設定します。 DTD が外部ファイルである場合は、 SFXXMLDOMParser::SetLoadExternalDTD 関数を呼び出して 外部 DTD 読み込みフラグを ON に設定します（省略可）。 DTD 検証フラグが ON の場合は、外部 DTD ファイルは自動的にロードされます。

	注意
	XML 文書の検証は部分的に行われます。現在のところ、完全な検証はサポートされていません。

使用例

// 解析対象の XML 文書 ( file.xml )
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE Mail SYSTEM "personal.dtd">
<Mail>
  <From>&name;</From>
  <To>Receiver</To>
  <Cc>&Email;</Cc>
  <Date> Thu, 7 Oct 1999 11:15:16 -0600</Date>
  <Subject>XML Introduction</Subject>
  <Body>Comments:<P align = "right">Thanks for reading<br/>this article</P>
    <br/>
    <P>Hope you enjoyed this article</P>
    <P>&copyright;</P>
  </Body>
</Mail>

// 検証用の DTD ファイル ( personal.dtd )
<?xml encoding="ISO-8859-1"?>

<!-- @version: 10.1-->

<!ELEMENT Mail (From, To, Cc?, Date?, Subject, Body)>
<!ELEMENT From (#PCDATA)>
<!ELEMENT To (#PCDATA)>
<!ELEMENT Cc (#PCDATA)>
<!ELEMENT Date (#PCDATA)>
<!ELEMENT Subject (#PCDATA)>
<!ELEMENT Body (#PCDATA | P | Br)*>
<!ELEMENT P (#PCDATA | br)*>
<!ATTLIST P align (left | right | justify) "left">
<!ELEMENT br EMPTY>
<!ENTITY  name "sophia">
<!ENTITY  Email "&name;@s-cradle.com">
<!ENTITY  copyright "Copyright (C) 2002 - 2024 Sophia Cradle Incorporated.">

// DTD 付き XML 文書の解析
SFXXMLDOMParser parser;
SFCError error;

// DTD 付き XML 文書を解析するため、文法タイプを設定する
parser.SetGrammar(SFXXMLGrammar::GRAMMAR_DTD);

// XML 文書を DTD で検証するように設定する
parser.SetValidationDTD(true);

// DTD を外部から読み込むように設定する
parser.SetLoadExternalDTD(true);

// DOM パーサーを使用して DTD 付き XML 文書を解析する
error = parser.Parse(SFXPath("/file.xml"));

if (error == SFERR_NO_ERROR) {
    // ルート要素を取得する
    SFXXMLDocumentPtr root = parser.GetDocument();

    // ドキュメント型を取得する
    SFXXMLDocumentTypePtr documentType = root->GetDocumentType();

    // 外部サブセット ( external DTD subset ) のシステム識別子を取得する
    // id は "personal.dtd" になる
    SFXAnsiString id = documentType->GetSystemID();

    // DTD に定義されているエンティティを DOMNamedNodeMap として取得する
    SFXXMLNode::DOMNamedNodeMapPtr entitymap = documentType->GetEntities();

    // "name" エンティティの値を取得する
    // name は "sophia" になる
    SFXAnsiString name = SFXXMLEntityPtr(entitymap->GetNamedItem("name"))->GetValue();
}

参照

SFXXMLGrammar::GrammarType | SFXXMLDOMParser::SetValidationDTD | SFXXMLDOMParser::SetLoadExternalDTD | SFXXMLDOMParser::GetValidationDTD

解説

この関数は、この XML パーサーが XML 文書をスキーマで検証するかどうかのフラグ値（スキーマ検証フラグ値）を設定します。

デフォルト値: OFF（false）[デフォルトの設定では、スキーマで検証されません。]

	注意
	XML 文書をスキーマで検証するには、以下の設定も必要です。 SFXXMLDOMParser::SetGrammar 関数を呼び出して文法を SFXXMLGrammar::GRAMMAR_SCHEMA に設定します。 SFXXMLDOMParser::SetDoNamespaces 関数を呼び出して名前空間処理フラグを ON に設定します。 SFXXMLDOMParser::SetDoSchema 関数を呼び出してスキーマ処理フラグを ON に設定します。 SFXXMLDOMParser::SetSchemaLocation 関数を呼び出して XSD ファイルを設定します。

	注意
	XML 文書の検証は部分的に行われます。現在のところ、完全な検証はサポートされていません。

使用例

SFXXMLDOMParser parser;

// Comment ノードを作成するように設定する
parser.SetCreateCommentNodes(true);

// 名前空間を処理するように設定する
parser.SetDoNamespaces(true);

// スキーマ付き XML 文書を解析するため、文法タイプを設定する
parser.SetGrammar(SFXXMLGrammar::GRAMMAR_SCHEMA);

// スキーマを処理するように設定する
parser.SetDoSchema(true);

// XSD ファイルを設定する
// ( デフォルト ディレクトリ: アプリのホームディレクトリ )
parser.SetSchemaLocation("schema.xsd");

// XML 文書をスキーマで検証するように設定する
parser.SetValidationSchema(true);

// DOM パーサーを使用して スキーマ付き XML 文書を解析する
error = parser.Parse(SFXPath("/file.xml"));

参照

SFXXMLGrammar::GrammarType | SFXXMLDOMParser::SetDoSchema | SFXXMLDOMParser::SetSchemaLocation | SFXXMLDOMParser::GetValidationSchema