SFXXMLNotation

[XML] Class which represents a Notation node.

#include <SFXXMLNotation.hpp>

class SFXXMLNotation : public SFXXMLNode;

SFMTYPEDEFCLASS(SFXXMLNotation)

Inheritance diagram

Collaboration diagram

Description

A Notation node(SFXXMLNotation) contains a notation declared in the DTD of the XML document.

Reference

Member

Constructor/Destructor
SFXXMLNotation( `SFXXMLDocumentPtr` owner , `SFXAnsiStringConstRef` name ) Constructor of the SFXXMLNotation class.
SFXXMLNotation( `SFXXMLNotationConstRef` other , `Bool` deep = false ) Constructor of the SFXXMLNotation class.
~SFXXMLNotation( `Void` ) Destructor of the SFXXMLNotation class.

Public Functions
`SFCError`	CloneNode( `SFXXMLNodeHandle` clonenode , `Bool` deep ) Create a copy of this node.
`ACharConstPtr`	GetNodeName( `Void` ) Get the node name.
`NodeType`	GetNodeType( `Void` ) Get the node type.
`ACharConstPtr`	GetPublicID( `Void` ) Get the public identifier of this Notation node.
`ACharConstPtr`	GetSystemID( `Void` ) Get the system identifier of this Notation node.
`Void`	SetPublicID( `ACharConstPtr` id ) Set the public identifier.
`Void`	SetSystemID( `ACharConstPtr` id ) Set the system identifier.
`SFCError`	AppendChild( `SFXXMLNodeConstPtr` newchild ) (inherits from SFXXMLNode) Append the specified child node at the end.
`Bool`	EqualNode( `SFXXMLNodeConstPtr` arg ) (inherits from SFXXMLNode) Check whether this node equals the specified node or not.
`DOMNodeListPtr`	GetChildNodes( `Void` ) (inherits from SFXXMLNode) Get all the child nodes.
`SFXXMLNodePtr`	GetFirstChild( `Void` ) (inherits from SFXXMLNode) Get the first child node.
`SFXXMLNodePtr`	GetLastChild( `Void` ) (inherits from SFXXMLNode) Get the last child node.
`SFXXMLNodePtr`	GetNextSibling( `Void` ) (inherits from SFXXMLNode) Get the next sibling node.
`ACharConstPtr`	GetNodeValue( `Void` ) (inherits from SFXXMLNode) Get the node value.
`SFXXMLNodePtr`	GetParentNode( `Void` ) (inherits from SFXXMLNode) Get the parent node.
`SFXXMLNodePtr`	GetPreviousSibling( `Void` ) (inherits from SFXXMLNode) Get the previous sibling node.
`SFXAnsiString`	GetText( `Void` ) (inherits from SFXXMLNode) Get the node text.
`Bool`	HasChildNodes( `Void` ) (inherits from SFXXMLNode) Check whether this node has any child nodes or not.
`SFCError`	InsertBefore( `SFXXMLNodeConstPtr` newchild , `SFXXMLNodeConstPtr` refchild ) (inherits from SFXXMLNode) Insert the specified node.
`Bool`	IsSameNode( `SFXXMLNodeConstPtr` other ) (inherits from SFXXMLNode) Check whether this node is the same as the specified one or not.
`SFCError`	RemoveChild( `SFXXMLNodeConstPtr` oldchild ) (inherits from SFXXMLNode) Remove the specified child node including its descendant nodes.
`SFCError`	ReplaceChild( `SFXXMLNodeConstPtr` newchild , `SFXXMLNodeConstPtr` oldchild ) (inherits from SFXXMLNode) Replace the specified child node.
`Void`	SetNodeValue( `ACharConstPtr` value ) (inherits from SFXXMLNode) Set the node value.
`SFCError`	SetText( `SFXAnsiStringConstRef` text ) (inherits from SFXXMLNode) Set the node text.

Types
DOMNamedNodeMap (inherits from SFXXMLNode) Class to manage the DOM nodes by name
DOMNodeList (inherits from SFXXMLNode) Class to manage the DOM nodes by list
NodeType (inherits from SFXXMLNode) SFXXMLNode::NodeType is an enumeration type of NodeType values defined in the W3C DOM Level 1 Specification. Document Object Model (DOM) Level 1 Specification )

SFXXMLNotation::SFXXMLNotation

Constructor of the SFXXMLNotation class.

[ public, explicit ]
SFXXMLNotation(
    SFXXMLDocumentPtr owner      // root node of the DOM tree
    SFXAnsiStringConstRef name   // name of the Notation node
);

[ public, explicit ]
SFXXMLNotation(
    SFXXMLNotationConstRef other   // Notation node 
    Bool deep = false              // whether or not to copy the child nodes recursively
);

SFXXMLNotation::~SFXXMLNotation

Destructor of the SFXXMLNotation class.

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

SFXXMLNotation::CloneNode

Create a copy of this node.

[ public, virtual ]
SFCError CloneNode(
    SFXXMLNodeHandle clonenode   // target node where to copy this node(Handle type)
    Bool deep                    // whether or not to copy the child nodes recursively
);

Argument

clonenode

Specify the target node where to copy this node.

deep

If true is set to this argument, copy the child nodes recursively.

Otherwise, copy only this node.

Return value

If succeeds: SFERR_NO_ERROR
If failed: SFERR_FAILED

Reference

SFXXMLNode::CloneNode

SFXXMLNotation::GetNodeName

Get the node name.

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

Description

	Note
	The name of the Notation node is the notation name of the XML document.

Reference

SFXXMLNode::GetNodeName

SFXXMLNotation::GetNodeType

Get the node type.

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

Return value

Return NOTATION_NODE.

Reference

SFXXMLNode::NodeType | SFXXMLNode::GetNodeType | SFXXMLNode

SFXXMLNotation::GetPublicID

Get the public identifier of this Notation node.

[ public, const ]
ACharConstPtr GetPublicID(Void);

Rerurn value

If the public identifier is not set to this node, null is returned.

Reference

SFXXMLNotation::SetPublicID

SFXXMLNotation::GetSystemID

Get the system identifier of this Notation node.

[ public, const ]
ACharConstPtr GetSystemID(Void);

Return value

If the system identifier is not set to this node, null is returned.

Description

	Note
	In some cases, the system identifier of this notation may be an absolute URI.

Reference

SFXXMLNotation::SetSystemID

SFXXMLNotation::SetPublicID

Set the public identifier.

[ public ]
Void SetPublicID(
    ACharConstPtr id   // public identifier to set to this Notation node
);

Reference

SFXXMLNotation::GetPublicID

SFXXMLNotation::SetSystemID

Set the system identifier.

[ public ]
Void SetSystemID(
    ACharConstPtr id   // system identifier to set to this Notation node
);

Reference

SFXXMLNotation::GetSystemID