zeus::IXMLDocument Class Reference

#include <IXMLDocument.hpp>

Inheritance diagram for zeus::IXMLDocument:

Public Member Functions
virtual Retval MQUALIFIER	getMainNode (IXMLNode *&rpMainNode)=0
virtual Retval MQUALIFIER	getStream (IString &rstrStream) const =0
virtual Retval MQUALIFIER	getStream2 (IOutputStream &rStream) const =0
virtual Retval MQUALIFIER	save (bool bDoAutoFormat=false)=0
virtual Retval MQUALIFIER	saveAs (const IString &rstrFilename, bool bKeepOrginalFileName=false, bool bDoAutoFormat=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	setFileName (const IString &rstrFileName)=0
virtual void MQUALIFIER	useNamespace (const IString &rstrPrefix, const IString &rstrNameSpace)=0
virtual void MQUALIFIER	removeNamespace (const IString &rstrPrefix)=0
virtual Retval MQUALIFIER	getImplPtr (INativePointer &rImpl) const =0
Public Member Functions inherited from zeus::IZUnknown
virtual Retval MQUALIFIER	askForInterface (const InterfaceID &rInterfaceID, IZUnknown *&rpIface)=0
virtual void MQUALIFIER	addRef () const =0
virtual void MQUALIFIER	release () const =0

Detailed Description

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

Member Function Documentation

createNewNode()

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

getFileName()

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

getImplPtr()

virtual Retval MQUALIFIER zeus::IXMLDocument::getImplPtr ( INativePointer &  rImpl ) const

pure virtual

This method returns the implementation pointer of a concrete xml document. Do not use this method outside of the XML_Service module

Parameters

rImpl

return parameter

Return values

RET_NOERROR	API pointer returned
RET_REQUEST_FAILED	no API pointer found

getMainNode()

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

getNodeList()

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

getStream()

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

getStream2()

virtual Retval MQUALIFIER zeus::IXMLDocument::getStream2 ( IOutputStream &  rStream ) const

pure virtual

Returns the DOM buffer as a output stream.

Parameters

rStream

return parameter of a stream of data

Return values

RET_NOERROR	Stream returned
RET_REQUEST_FAILED	Could return stream

removeNamespace()

virtual void MQUALIFIER zeus::IXMLDocument::removeNamespace ( const IString &  rstrPrefix )

pure virtual

Removes a specific name space.

Parameters

rstrPrefix

Prefix to use

save()

virtual Retval MQUALIFIER zeus::IXMLDocument::save ( bool  bDoAutoFormat = false )

pure virtual

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

Parameters

bDoAutoFormat

Enable auto format tags on saved file.

Return values

RET_NOERROR	File saved
RET_REQUEST_FAILED	Could not save file

saveAs()

virtual Retval MQUALIFIER zeus::IXMLDocument::saveAs ( const IString &  rstrFilename, bool  bKeepOrginalFileName = false, bool  bDoAutoFormat = 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.
bDoAutoFormat	Enable auto format tags on saved file.

Return values

RET_NOERROR	File saved
RET_REQUEST_FAILED	Could not save file

setFileName()

virtual void MQUALIFIER zeus::IXMLDocument::setFileName ( const IString &  rstrFileName )

pure virtual

Set the file name of the XML document.

Parameters

rstrFileName

[IN]: File name.

useNamespace()

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

validate()

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:

• IXMLDocument.hpp