SFXXMLEntity

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

#include <SFXXMLEntity.hpp>

class SFXXMLEntity : public SFXXMLNode;

SFMTYPEDEFCLASS(SFXXMLEntity)

継承図

協調図

解説

Entity ノード (SFXXMLEntity) は、XML 文書の解析対象エンティティ (parsed entity)、または解析対象外エンティティ (unparsed entity) を保持します。

参照

メンバ

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

パブリック関数
`SFCError`	AppendChild( `SFXXMLNodeConstPtr` newchild ) 子ノードの最後にノードを追加します。
`SFCError`	CloneNode( `SFXXMLNodeHandle` clonenode , `Bool` deep ) ノードのコピーを作成します。
`DOMNodeListPtr`	GetChildNodes( `Void` ) すべての子ノードを取得します。
`ACharConstPtr`	GetEncoding( `Void` ) エンコーディングを取得します。
`SFXXMLNodePtr`	GetFirstChild( `Void` ) 最初の子ノードを取得します。
`SFXXMLNodePtr`	GetLastChild( `Void` ) 最後の子ノードを取得します。
`SFXXMLNodePtr`	GetNextSibling( `Void` ) 次の兄弟ノードを取得します。
`ACharConstPtr`	GetNodeName( `Void` ) ノードの名前を取得します。
`NodeType`	GetNodeType( `Void` ) ノードタイプを取得します。
`ACharConstPtr`	GetNodeValue( `Void` ) ノードの値を取得します。
`ACharConstPtr`	GetNotationName( `Void` ) 記法の名前を取得します。
`SFXXMLNodePtr`	GetPreviousSibling( `Void` ) 前の兄弟ノードを取得します。
`ACharConstPtr`	GetPublicID( `Void` ) 公開識別子を取得します。
`ACharConstPtr`	GetSystemID( `Void` ) システム識別子を取得します。
`ACharConstPtr`	GetValue( `Void` ) ノードの値を取得します。
`ACharConstPtr`	GetVersion( `Void` ) バージョン番号を取得します。
`Bool`	HasChildNodes( `Void` ) 子ノードを持つかどうかを判定します。
`SFCError`	InsertBefore( `SFXXMLNodeConstPtr` newchild , `SFXXMLNodeConstPtr` refchild ) ノードを挿入します。
`SFCError`	RemoveChild( `SFXXMLNodeConstPtr` oldchild ) 子孫ノードも含めて子ノードを削除します。
`SFCError`	ReplaceChild( `SFXXMLNodeConstPtr` newchild , `SFXXMLNodeConstPtr` oldchild ) 子ノードを置換します。
`Void`	SetEncoding( `ACharConstPtr` encoding ) エンコーディングを設定します。
`Void`	SetNodeValue( `ACharConstPtr` value ) ノードの値を設定します。
`Void`	SetNotationName( `ACharConstPtr` name ) 記法の名前を設定します。
`Void`	SetPublicID( `ACharConstPtr` id ) 公開識別子を設定します。
`Void`	SetSystemID( `ACharConstPtr` id ) システム公開識別子を設定します。
`Void`	SetValue( `SFXAnsiStringConstRef` value ) ノードの値を設定します。
`Void`	SetVersion( `ACharConstPtr` version ) バージョン番号を設定します。
`Bool`	EqualNode( `SFXXMLNodeConstPtr` arg ) (SFXXMLNode から継承) 指定したノードと同等かどうかを判定します。
`SFXXMLNodePtr`	GetParentNode( `Void` ) (SFXXMLNode から継承) 親ノードを取得します。
`SFXAnsiString`	GetText( `Void` ) (SFXXMLNode から継承) ノードテキストを取得します。
`Bool`	IsSameNode( `SFXXMLNodeConstPtr` other ) (SFXXMLNode から継承) 指定したノードと同一であるかを判定します。
`SFCError`	SetText( `SFXAnsiStringConstRef` text ) (SFXXMLNode から継承) ノードテキストを設定します。

型
DOMNamedNodeMap (SFXXMLNode から継承) 複数の DOM ノードを名前で管理するためのクラスです。
DOMNodeList (SFXXMLNode から継承) 複数の DOM ノードをリスト形式で管理するためのクラスです。
NodeType (SFXXMLNode から継承) ノードタイプの数値です。

SFXXMLEntity::SFXXMLEntity

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

[ public, explicit ]
SFXXMLEntity(
    SFXXMLDocumentPtr owner      // ドキュメントツリールートのオブジェクト 
    SFXAnsiStringConstRef name   // エンティティの名前 
);

[ public, explicit ]
SFXXMLEntity(
    SFXXMLEntityConstRef other   // エンティティのインスタンス 
    Bool deep = false            // 深いコピーするかどうか 
);

SFXXMLEntity::~SFXXMLEntity

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

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

SFXXMLEntity::AppendChild

子ノードの最後にノードを追加します。

[ public, virtual ]
SFCError AppendChild(
    SFXXMLNodeConstPtr newchild   // 追加するノード
);

戻り値

成功したとき : SFERR_NO_ERROR
引数が不正であるとき : SFERR_INVALID_PARAM
メモリ不足のとき : SFERR_NO_MEMORY

解説

newchild ノードをコピーせずにそのまま追加します。

newchild ノードが別の DOM ツリー内に存在する場合、その DOM ツリー内からは削除されます。

参照

SFXXMLNode::AppendChild | SFXXMLNode

SFXXMLEntity::CloneNode

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

[ public, virtual ]
SFCError CloneNode(
    SFXXMLNodeHandle clonenode   // コピー先のノード(Handle 型)
    Bool deep                    // 子ノードが再帰的にコピーされるかどうか
);

引数

clonenode

コピー先ノードを指定します。

deep

true の場合、子ノードを再帰的にコピーします。

false の場合、ノード自身だけをコピーします。

戻り値

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

参照

SFXXMLNode::CloneNode | SFXXMLNode

SFXXMLEntity::GetChildNodes

すべての子ノードを取得します。

[ public, virtual, const ]
DOMNodeListPtr GetChildNodes(Void);

戻り値

指定した Entity ノードのすべての子ノードを SFXXMLNode::DOMNodeList へのポインターとして返します。子ノードがないときは null を返します。

解説

	注意
	`SFXXMLNode::DOMNodeList` の各要素は、SFXXMLNode 型へのポインターです。

参照

SFXXMLNode::DOMNodeList | SFXXMLNode::GetChildNodes | SFXXMLNode

SFXXMLEntity::GetEncoding

エンコーディングを取得します。

[ public, const ]
ACharConstPtr GetEncoding(Void);

戻り値

解析対象エンティティの場合に、エンティティのエンコーディングを返します。解析対象外エンティティの場合は null を返します。

参照

SFXXMLEntity::SetEncoding

SFXXMLEntity::GetFirstChild

最初の子ノードを取得します。

[ public, virtual, const ]
SFXXMLNodePtr GetFirstChild(Void);

戻り値

最初の子ノードを返します。子ノードがないときは null を返します。

参照

SFXXMLNode::GetFirstChild | SFXXMLNode

SFXXMLEntity::GetLastChild

最後の子ノードを取得します。

[ public, virtual, const ]
SFXXMLNodePtr GetLastChild(Void);

戻り値

最後の子ノードを返します。子ノードがないときは null を返します。

参照

SFXXMLNode::GetLastChild | SFXXMLNode

SFXXMLEntity::GetNextSibling

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

[ public, virtual, const ]
SFXXMLNodePtr GetNextSibling(Void);

戻り値

指定したノードの次の兄弟ノードを返します。次の兄弟ノードがないときは null を返します。

参照

SFXXMLEntity::GetPreviousSibling | SFXXMLNode::GetNextSibling| SFXXMLNode::GetPreviousSibling | SFXXMLNode

SFXXMLEntity::GetNodeName

ノードの名前を取得します。

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

解説

Entity ノードの名前(エンティティ名)を返します。

参照

SFXXMLNode::GetNodeName | SFXXMLNode

SFXXMLEntity::GetNodeType

ノードタイプを取得します。

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

戻り値

ENTITY_NODE を返します。

参照

SFXXMLNode::NodeType | SFXXMLNode::GetNodeType | SFXXMLNode

SFXXMLEntity::GetNodeValue

ノードの値を取得します。

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

解説

Entity ノードの値を取得します。

SFXXMLEntity::GetValue 関数を呼び出すのと同等です。

参照

SFXXMLEntity::GetValue | SFXXMLNode::GetNodeValue | SFXXMLNode

SFXXMLEntity::GetNotationName

記法の名前を取得します。

[ public, const ]
ACharConstPtr GetNotationName(Void);

戻り値

解析対象エンティティの場合、エンティティの記法 ( Notation ) の名前を返します。解析対象外エンティティの場合は null を返します。

参照

SFXXMLEntity::SetNotationName

SFXXMLEntity::GetPreviousSibling

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

[ public, virtual, const ]
SFXXMLNodePtr GetPreviousSibling(Void);

戻り値

指定したノードの前の兄弟ノードを返します。前の兄弟ノードがないときは null を返します。

参照

SFXXMLEntity::GetNextSibling | SFXXMLNode::GetPreviousSibling | SFXXMLNode::GetNextSibling | SFXXMLNode

SFXXMLEntity::GetPublicID

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

[ public, const ]
ACharConstPtr GetPublicID(Void);

戻り値

Entity ノードに公開識別子が設定されていないときは null を返します。

参照

SFXXMLEntity::SetPublicID

SFXXMLEntity::GetSystemID

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

[ public, const ]
ACharConstPtr GetSystemID(Void);

戻り値

Entity ノードにシステム識別子が設定されていないときは null を返します。

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

参照

SFXXMLEntity::SetSystemID

SFXXMLEntity::GetValue

ノードの値を取得します。

[ public, const ]
ACharConstPtr GetValue(Void);

解説

Entity ノードの値を取得します。

SFXXMLEntity::GetNodeValue 関数を呼び出すのと同等です。

参照

SFXXMLEntity::GetNodeValue

SFXXMLEntity::GetVersion

バージョン番号を取得します。

[ public, const ]
ACharConstPtr GetVersion(Void);

戻り値

解析対象エンティティの場合、エンティティのバージョン番号を返します。解析対象外エンティティの場合は null を返します。

参照

SFXXMLEntity::SetVersion

SFXXMLEntity::HasChildNodes

子ノードを持つかどうかを判定します。

[ public, virtual, const ]
Bool HasChildNodes(Void);

戻り値

持つとき : true
持たないとき : false

参照

SFXXMLNode::HasChildNodes | SFXXMLNode

SFXXMLEntity::InsertBefore

ノードを挿入します。

[ public, virtual ]
SFCError InsertBefore(
    SFXXMLNodeConstPtr newchild   // 挿入するノード
    SFXXMLNodeConstPtr refchild   // 参照ノード、このノードの直前に挿入される
);

戻り値

成功したとき : SFERR_NO_ERROR
引数が不正であるとき : SFERR_INVALID_PARAM
メモリ不足のとき : SFERR_NO_MEMORY
失敗したとき : SFERR_FAILED

参照

SFXXMLNode::InsertBefore | SFXXMLNode

SFXXMLEntity::RemoveChild

子孫ノードも含めて子ノードを削除します。

[ public, virtual ]
SFCError RemoveChild(
    SFXXMLNodeConstPtr oldchild   // 削除する子ノード
);

戻り値

成功したとき : SFERR_NO_ERROR
引数が不正であるとき : SFERR_INVALID_PARAM
メモリ不足のとき : SFERR_NO_MEMORY
失敗したとき : SFERR_FAILED

参照

SFXXMLNode::RemoveChild | SFXXMLNode

SFXXMLEntity::ReplaceChild

子ノードを置換します。

[ public, virtual ]
SFCError ReplaceChild(
    SFXXMLNodeConstPtr newchild   // 置換後ノード
    SFXXMLNodeConstPtr oldchild   // 置換前ノード
);

戻り値

成功したとき : SFERR_NO_ERROR
引数が不正であるとき : SFERR_INVALID_PARAM
メモリ不足のとき : SFERR_NO_MEMORY
失敗したとき : SFERR_FAILED

参照

SFXXMLNode::ReplaceChild | SFXXMLNode

SFXXMLEntity::SetEncoding

エンコーディングを設定します。

[ public ]
Void SetEncoding(
    ACharConstPtr encoding   // エンコーディング
);

参照

SFXXMLEntity::GetEncoding

SFXXMLEntity::SetNodeValue

ノードの値を設定します。

[ public, virtual ]
Void SetNodeValue(
    ACharConstPtr value   //新たなノード内容 
);

解説

Entity ノードの値を設定します。

SFXXMLEntity::SetValue 関数を呼び出すのと同等です。

参照

SFXXMLEntity::SetValue | SFXXMLNode::SetNodeValue | SFXXMLNode

SFXXMLEntity::SetNotationName

記法の名前を設定します。

[ public ]
Void SetNotationName(
    ACharConstPtr name   // エンティティの記法の名前
);

参照

SFXXMLEntity::GetNotationName

SFXXMLEntity::SetPublicID

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

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

参照

SFXXMLEntity::GetPublicID

SFXXMLEntity::SetSystemID

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

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

参照

SFXXMLEntity::GetSystemID

SFXXMLEntity::SetValue

ノードの値を設定します。

[ public ]
Void SetValue(
    SFXAnsiStringConstRef value   // エンティティの値
);

解説

Entity ノードの値を設定します。

SFXXMLEntity::SetNodeValue 関数を呼び出すのと同等です。

参照

SFXXMLEntity::SetNodeValue

SFXXMLEntity::SetVersion

バージョン番号を設定します。

[ public ]
Void SetVersion(
    ACharConstPtr version   // バージョン番号
);

参照

SFXXMLEntity::GetVersion