IXMLNode Class Referenceabstract

Symbolize a node in a XML tree structure. More...

Inherited by IXMLNodeImpl.

Public Member Functions

virtual XML::boolean addAttribute (const char *sAttributeName, const char *sAttributeValue)=0
 Add the attribute sAttributeName with value sAttributeValue to the node. More...
 
virtual XML::boolean hasAttribute (const char *sAttributeName) const =0
 Indicate if an attribute exists or not. More...
 
virtual const char * getAttribute (const char *sAttributeName) const =0
 Return the value of an attribute. More...
 
virtual void setPCData (const char *childData)=0
 Set the PCDATA of the node. More...
 
virtual void appendPCData (const char *childData)=0
 Apppend a string to the current PCDATA of the node. More...
 
virtual const char * getPCData (void) const =0
 Return the PCDATA of the node. More...
 
virtual void addChild (XML::IXMLNode *ChildNode)=0
 Add a node child of the. More...
 
virtual XML::IXMLNodegetChild (const size_t iChildIndex) const =0
 Return the ith child of the node. More...
 
virtual XML::IXMLNodegetChildByName (const char *sName) const =0
 Return the first child with the name sName. More...
 
virtual size_t getChildCount (void) const =0
 Return the amount of child the node has. More...
 
virtual char * getXML (const XML::uint32 depth=0) const =0
 Return a string which contains the XML of the node. The string is dynamically instantiate so it requires to be free. More...
 

Detailed Description

Symbolize a node in a XML tree structure.

Author
Serrière Guillaume (INRIA/Loria)
See also
XML

Member Function Documentation

virtual XML::boolean addAttribute ( const char *  sAttributeName,
const char *  sAttributeValue 
)
pure virtual

Add the attribute sAttributeName with value sAttributeValue to the node.

Parameters
sAttributeName[in] : Name of the attribute
sAttributeValue[in] : Value of the attribute
Returns
true in success, false otherwise
virtual XML::boolean hasAttribute ( const char *  sAttributeName) const
pure virtual

Indicate if an attribute exists or not.

Parameters
sAttributeName[in] : Name of the attribute
Returns
true if attribute exists, false otherwise
virtual const char* getAttribute ( const char *  sAttributeName) const
pure virtual

Return the value of an attribute.

Parameters
sAttributeName[in] : Name of the attribute
Returns
Value of the attribute
virtual void setPCData ( const char *  childData)
pure virtual

Set the PCDATA of the node.

Parameters
childData[in] : Value of the PCDATA
virtual void appendPCData ( const char *  childData)
pure virtual

Apppend a string to the current PCDATA of the node.

Parameters
childData[in] : Value of teh PCDATA to append
virtual const char* getPCData ( void  ) const
pure virtual

Return the PCDATA of the node.

Returns
Value of PCDATA
virtual void addChild ( XML::IXMLNode ChildNode)
pure virtual

Add a node child of the.

Parameters
ChildNode[in] : The Node that will became the new child
virtual XML::IXMLNode* getChild ( const size_t  iChildIndex) const
pure virtual

Return the ith child of the node.

Parameters
iChildIndex[in] : index of the child.
Returns
The ith child of the node.
virtual XML::IXMLNode* getChildByName ( const char *  sName) const
pure virtual

Return the first child with the name sName.

Parameters
sName[in]] : Name of th child
Returns
The first child of the node which name is sName.
virtual size_t getChildCount ( void  ) const
pure virtual

Return the amount of child the node has.

Returns
Amount of child.
virtual char* getXML ( const XML::uint32  depth = 0) const
pure virtual

Return a string which contains the XML of the node. The string is dynamically instantiate so it requires to be free.

Parameters
depth[in] : Amount of indentation
Returns
XML string describing the node and its childs.