Public Member Functions

zeus::IXMLDocument Class Reference

#include <IXMLDocument.hpp>

Inheritance diagram for zeus::IXMLDocument:
zeus::IZUnknown zeus::IXSDDocument

List of all members.

Public Member Functions

virtual Retval MQUALIFIER getMainNode (IXMLNode *&rpMainNode)=0
virtual Retval MQUALIFIER getStream (IString &rstrStream) const =0
virtual Retval MQUALIFIER save ()=0
virtual Retval MQUALIFIER saveAs (const IString &rstrFilename, bool bKeepOrginalFileName=false)=0
virtual Retval MQUALIFIER createNewNode (IXMLNode::ENodeType eNodeType, const IString &rstrName, const IString &rstrUri, IXMLNode *&rpNode)=0
virtual Retval MQUALIFIER validate (IXMLErrorReporter *pReporter=NULL)=0
virtual Retval MQUALIFIER getNodeList (IXMLNodeList *&rpList)=0
virtual void MQUALIFIER getFileName (IString &rstrFileName) const =0
virtual void MQUALIFIER useNamespace (const IString &rstrPrefix, const IString &rstrNameSpace)=0
virtual void MQUALIFIER removeNamespace (const IString &rstrPrefix)=0

Detailed Description

The interface defines a complete xml document (as DOM tree).


Member Function Documentation

virtual Retval MQUALIFIER zeus::IXMLDocument::createNewNode ( IXMLNode::ENodeType  eNodeType,
const IString rstrName,
const IString rstrUri,
IXMLNode *&  rpNode 
) [pure virtual]

Creates a new xml DOM node. The node will be returned to the caller and can be inserted or added using the IXMLNode method insert() or append().

Parameters:
eNodeType,:Type of the node (see defines)
rstrName,:Name of the node
rstrUri,:Ressource identifier (not used for all types -> see XML spec. of xercesc and MSXML).
rpNode,:return parameter of the created node.
Return values:
RET_NOERROR,:Node created.
RET_REQUEST_FAILED,:Could not create the node
virtual void MQUALIFIER zeus::IXMLDocument::getFileName ( IString rstrFileName ) const [pure virtual]

Returns the file name of the XML document. If the file name is empty, the document was built out of a stream.

Parameters:
rstrFileName,:Return parameter of file name
virtual Retval MQUALIFIER zeus::IXMLDocument::getMainNode ( IXMLNode *&  rpMainNode ) [pure virtual]

Returns the main node of the xml dom tree

Parameters:
rpMainNode,:return parameter of the main node
Return values:
RET_NOERROR,:main node returned.
RET_REQUEST_FAILED,:Could not return the main node
virtual Retval MQUALIFIER zeus::IXMLDocument::getNodeList ( IXMLNodeList *&  rpList ) [pure virtual]

Returns the complete node list of the xml dom tree.

Parameters:
rpList,:return parameter of the list
Return values:
RET_NOERROR,:list returned.
RET_REQUEST_FAILED,:Could not return the list
virtual Retval MQUALIFIER zeus::IXMLDocument::getStream ( IString rstrStream ) const [pure virtual]

Returns the DOM buffer as a stream.

Parameters:
rstrStream,:return parameter of a stream of data
Return values:
RET_NOERROR,:Stream returned
RET_REQUEST_FAILED,:Could return stream
virtual void MQUALIFIER zeus::IXMLDocument::removeNamespace ( const IString rstrPrefix ) [pure virtual]

Removes a specific name space.

Parameters:
rstrPrefix,:Prefix to use
virtual Retval MQUALIFIER zeus::IXMLDocument::save (  ) [pure virtual]

Saves the document. This method will fail, if a stream has been loaded previously.

Return values:
RET_NOERROR,:File saved
RET_REQUEST_FAILED,:Could not save file
virtual Retval MQUALIFIER zeus::IXMLDocument::saveAs ( const IString rstrFilename,
bool  bKeepOrginalFileName = false 
) [pure virtual]

Saves the document using a new file name. This method will fail, if a stream has been loaded previously.

Parameters:
rstrFilename,:Name of the new file
bKeepOrginalFileName,:Keeps the original file name stored. This flag is needed to store a copy.
Return values:
RET_NOERROR,:File saved
RET_REQUEST_FAILED,:Could not save file
virtual void MQUALIFIER zeus::IXMLDocument::useNamespace ( const IString rstrPrefix,
const IString rstrNameSpace 
) [pure virtual]

Sets the prefix for a specific name space. Use this method before querying data with X-Path.

Parameters:
rstrPrefix,:Prefix to use
rstrNameSpace,:Name space
virtual Retval MQUALIFIER zeus::IXMLDocument::validate ( IXMLErrorReporter pReporter = NULL ) [pure virtual]

Validates the xml document. Te errors will be returned by the the error handler registered.

Parameters:
pReporter,:Optional reporter instance
Return values:
RET_NOERROR,:XML is ok
RET_INVALID_DATA,:XML is not valid.

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


Written by Benjamin Hadorn http://www.xatlantis.ch.
Last change made on Sun Jan 22 2012 15:28:37