SFXXMLNotation

[XML] Notation ノードを表すクラスです。

#include <SFXXMLNotation.hpp>

class SFXXMLNotation : public SFXXMLNode;

SFMTYPEDEFCLASS(SFXXMLNotation)

継承図

協調図

解説

Notation ノード（SFXXMLNotation）は、 XML 文書の DTD で宣言された記法（Notation）を保持します。

	システム識別子（System Identifier）と公開識別子（Public Identifier）
システム識別子（System Identifier）とは、外部サブセットの位置を示すもので、URIで表現されます。 XML プロセッサは、この位置情報から外部サブセットを入手します。公開識別子（Public Identifier）とは、 XML プロセッサが識別できる、特定の外部サブセットを表す文字列のことです。認識できない場合のために、公開識別子の後ろにシステム識別子を指定することも可能です。具体的には、以下のように指定します。 PUBLIC "公開識別子" "システム識別子"

システム識別子（System Identifier）と公開識別子（Public Identifier）

システム識別子（System Identifier）とは、外部サブセットの位置を示すもので、URIで表現されます。 XML プロセッサは、この位置情報から外部サブセットを入手します。

公開識別子（Public Identifier）とは、 XML プロセッサが識別できる、特定の外部サブセットを表す文字列のことです。認識できない場合のために、公開識別子の後ろにシステム識別子を指定することも可能です。具体的には、以下のように指定します。

PUBLIC "公開識別子" "システム識別子"

参照

SFXXMLNode | SFXXMLDocument | SFXXMLDocumentType

メンバ

コンストラクタ/デストラクタ
SFXXMLNotation( `SFXXMLDocumentPtr` owner , `SFXAnsiStringConstRef` name ) SFXXMLNotation クラスのコンストラクタです。
SFXXMLNotation( `SFXXMLNotationConstRef` other , `Bool` deep = false ) SFXXMLNotation クラスのコンストラクタです。
~SFXXMLNotation( `Void` ) SFXXMLNotation クラスのデストラクタです。

パブリック関数
`SFCError`	CloneNode( `SFXXMLNodeHandle` clonenode , `Bool` deep ) ノードのコピーを作成します。
`ACharConstPtr`	GetNodeName( `Void` ) ノードの名前（nodeName 属性値）を取得します。
`NodeType`	GetNodeType( `Void` ) ノードタイプ（nodeType 属性値）を取得します。
`ACharConstPtr`	GetPublicID( `Void` ) 公開識別子を取得します。
`ACharConstPtr`	GetSystemID( `Void` ) システム識別子を取得します。
`Void`	SetPublicID( `ACharConstPtr` id ) 公開識別子を設定します。
`Void`	SetSystemID( `ACharConstPtr` id ) システム識別子を設定します。
`SFCError`	AppendChild( `SFXXMLNodeConstPtr` newchild ) (SFXXMLNode から継承) 【無効】子ノードの最後にノードを追加します。
`Bool`	EqualNode( `SFXXMLNodeConstPtr` arg ) (SFXXMLNode から継承) 指定されたノードと同等かどうかを判定します。
`DOMNodeListPtr`	GetChildNodes( `Void` ) (SFXXMLNode から継承) 【無効】すべての子ノードを取得します。
`SFXXMLNodePtr`	GetFirstChild( `Void` ) (SFXXMLNode から継承) 【無効】最初の子ノードを取得します。
`SFXXMLNodePtr`	GetLastChild( `Void` ) (SFXXMLNode から継承) 【無効】最後の子ノードを取得します。
`SFXXMLNodePtr`	GetNextSibling( `Void` ) (SFXXMLNode から継承) 【無効】次の兄弟ノードを取得します。
`ACharConstPtr`	GetNodeValue( `Void` ) (SFXXMLNode から継承) ノードの値（nodeValue 属性値）を取得します。
`SFXXMLNodePtr`	GetParentNode( `Void` ) (SFXXMLNode から継承) 【無効】親ノードを取得します。
`SFXXMLNodePtr`	GetPreviousSibling( `Void` ) (SFXXMLNode から継承) 【無効】前の兄弟ノードを取得します。
`SFXAnsiString`	GetText( `Void` ) (SFXXMLNode から継承) ノードテキストを取得します。
`Bool`	HasChildNodes( `Void` ) (SFXXMLNode から継承) 【無効】子ノードを持つかどうかを判定します。
`SFCError`	InsertBefore( `SFXXMLNodeConstPtr` newchild , `SFXXMLNodeConstPtr` refchild ) (SFXXMLNode から継承) 【無効】ノードを挿入します。
`Bool`	IsSameNode( `SFXXMLNodeConstPtr` other ) (SFXXMLNode から継承) 指定されたノードと同一であるか判定します。
`SFCError`	RemoveChild( `SFXXMLNodeConstPtr` oldchild ) (SFXXMLNode から継承) 【無効】子孫ノードも含めて子ノードを削除します。
`SFCError`	ReplaceChild( `SFXXMLNodeConstPtr` newchild , `SFXXMLNodeConstPtr` oldchild ) (SFXXMLNode から継承) 【無効】子ノードを置換します。
`Void`	SetNodeValue( `ACharConstPtr` value ) (SFXXMLNode から継承) ノードの値（nodeValue 属性値）を設定します。
`SFCError`	SetText( `SFXAnsiStringConstRef` text ) (SFXXMLNode から継承) ノードテキストを設定します。

型
DOMNamedNodeMap (SFXXMLNode から継承) 複数の DOM ノードを名前またはローカル名と名前空間 URI で管理するためのクラスです。
DOMNodeList (SFXXMLNode から継承) 複数の DOM ノードをリスト形式で管理するためのクラスです。
NodeType (SFXXMLNode から継承) ノードタイプを表す定数です。

SFXXMLNotation::SFXXMLNotation

SFXXMLNotation クラスのコンストラクタです。

[ public, explicit ]
SFXXMLNotation(
    SFXXMLDocumentPtr owner      // ドキュメントツリーのルート
    SFXAnsiStringConstRef name   // 記法名
);

[ public, explicit ]
SFXXMLNotation(
    SFXXMLNotationConstRef other   // Notation ノード
    Bool deep = false              // 子ノードを再帰的にコピーするかどうか【無効】 
);

解説

このコンストラクタは、指定された値をこのノードに設定します。

引数には、このノードを所有するドキュメントツリーのルート（SFXXMLDocument）と記法名、または別の Notation ノードのいずれかを指定することが可能です。

	注意
	name 引数に指定される記法名は、 `SFXXMLNotation::GetNodeName` 関数で取得できる、このノードの nodeName 属性として設定されます。

	注意
	Notation ノードは子ノードを持たないので、 deep 引数は無効です。true を指定しても、false を指定しても結果は同じです。

参照

SFXXMLNotation::GetNodeName | SFXXMLDocument

SFXXMLNotation::~SFXXMLNotation

SFXXMLNotation クラスのデストラクタです。

[ public, virtual ]
virtual ~SFXXMLNotation(Void);

解説

このデストラクタは、何も行いません。

SFXXMLNotation::CloneNode

ノードのコピーを作成します。

[ public, virtual ]
SFCError CloneNode(
    SFXXMLNodeHandle clonenode   // コピー先のノード(Handle 型)
    Bool deep                    // 子ノードを再帰的にコピーするかどうか【無効】
);

引数

clonenode: コピー先ノードを指定します。
deep: この引数は無効です。

戻り値

成功したとき: SFERR_NO_ERROR
失敗したとき: SFERR_FAILED

解説

この関数は、このノードのコピーを作成し、clonenode 引数に返します。

	注意
	Notation ノードは子ノードを持たないので、 deep 引数は無効です。true を指定しても、false を指定しても結果は同じです。

参照

SFXXMLNotation::SFXXMLNotation | SFXXMLNode::CloneNode | SFXXMLNode

SFXXMLNotation::GetNodeName

ノードの名前（nodeName 属性値）を取得します。

[ public, virtual, const ]
ACharConstPtr GetNodeName(Void);

戻り値

ノードの名前（nodeName 属性値）

解説

この関数は、このノードの名前（nodeName 属性値）を取得します。

Notation ノードの場合、nodeName 属性値は XML 文書の DTD で宣言する記法名のことです。

	注意
	記法名は、`SFXXMLNotation::SFXXMLNotation` コンストラクタの name 引数で設定します。

参照

SFXXMLNotation::SFXXMLNotation | SFXXMLNode::GetNodeName | SFXXMLNode

SFXXMLNotation::GetNodeType

ノードタイプ（nodeType 属性値）を取得します。

[ public, virtual, const ]
NodeType GetNodeType(Void);

戻り値

SFXXMLNode::NOTATION_NODE

解説

この関数は、このノードのタイプ（nodeType 属性値）を取得します。

Notation ノードの場合、nodeType 属性値は SFXXMLNode::NOTATION_NODE です。

参照

SFXXMLNode::GetNodeType | SFXXMLNode::NodeType | SFXXMLNode

SFXXMLNotation::GetPublicID

公開識別子を取得します。

[ public, const ]
ACharConstPtr GetPublicID(Void);

戻り値

公開識別子

解説

この関数は、このノードの公開識別子を取得します。

設定されていない場合は、null を返します。

参照

SFXXMLNotation::SetPublicID

SFXXMLNotation::GetSystemID

システム識別子を取得します。

[ public, const ]
ACharConstPtr GetSystemID(Void);

戻り値

システム識別子

解説

この関数は、このノードのシステム識別子を取得します。

設定されていない場合は、null を返します。

	注意
	戻り値のシステム識別子は、絶対 URI である場合と、そうでない場合があります。

参照

SFXXMLNotation::SetSystemID

SFXXMLNotation::SetPublicID

公開識別子を設定します。

[ public ]
Void SetPublicID(
    ACharConstPtr id   // 公開識別子
);

解説

この関数は、このノードに指定された公開識別子を設定します。

参照

SFXXMLNotation::GetPublicID

SFXXMLNotation::SetSystemID

システム識別子を設定します。

[ public ]
Void SetSystemID(
    ACharConstPtr id   // システム識別子
);

解説

この関数は、このノードに指定されたシステム識別子を設定します。

参照

SFXXMLNotation::GetSystemID