zeus::TXMLFile Class Reference

#include <XMLFile.h>

Inheritance diagram for zeus::TXMLFile:

List of all members.

Public Member Functions
	TXMLFile (const TString &rFileName)
void	closeXML ()
Retval	createXMLFile (const IString &rstrMainNodeName)
Retval	createXMLFile (const IString &rstrMainNodeName, IXMLNode *&rpMainNode)
Retval	createXMLFileFromStream (const IString &rStream)
Retval	createXMLFileFromStream (const wchar_t *pStream)
Retval	createXObjectFile (const IString &rObjectName, const IString &rRootClassName, const IString &rCodeModule)
Retval	createXObjectFile (const wchar_t *pObjectName, const wchar_t *pRootClassName, const wchar_t *pCodeModule)
Retval	loadXML (NAMESPACE_Zeus::IXMLDocument *&rpDocument)
Retval	loadXObjects (IXObject *&rpObject, bool dDoUnfreeze=true, bool bKeepXObjectAfterClosing=false)
TString	getDocumentStream () const
Retval	getMainNode (IXMLNode *&rpMainNode)
Retval	selectNode (const IString &rXPath, IXMLNode *&rpNode)
Retval	selectNode (const wchar_t *pXPath, IXMLNode *&rpNode)
Retval	selectNodes (const IString &rXPath, IXPathResults *&rpResults)
Retval	selectNodes (const wchar_t *pXPath, IXPathResults *&rpResults)
Retval	selectNodeValue (const IString &rXPath, IString &rValue)
Retval	selectNodeValue (const wchar_t *pXPath, IString &rValue)
Retval	selectObject (const IString &rXObjectPath, IXObject *&rpObject)
Retval	selectObject (const wchar_t *pXObjectPath, IXObject *&rpObject)
Retval	selectObjects (const IString &rXObjectPath, IXObjectCollection *&rpCollection)
Retval	selectObjects (const wchar_t *pXObjectPath, IXObjectCollection *&rpCollection)
Retval	selectCastedObject (const IString &rXObjectPath, const InterfaceID &rInterfaceID, IZUnknown *&rpObject)
Retval	selectCastedObject (const wchar_t *pXObjectPath, const InterfaceID &rInterfaceID, IZUnknown *&rpObject)
void	useNamespace (const IString &rPrefix, const IString &rNamespace)
void	useNamespace (const wchar_t *pPrefix, const wchar_t *pNamespace)
Retval	useDefaultNamespaceAs (const IString &rstrPrefix)
Retval	writeNodeValue (const IString &rXPath, const IString &rValue)
Retval	writeNodeValue (const wchar_t *pXPath, const wchar_t *pValue)
Retval	save ()
Retval	saveAs (const IString &rFileName, bool bKeepOrginalFileName)
Protected Member Functions
virtual	~TXMLFile ()
virtual Retval	loadXML_internal ()

---

Detailed Description

An xml file loads xml data nodes and may return XObjects using the factory methods

---

Constructor & Destructor Documentation

TXMLFile::TXMLFile

(

const TString &

rFileName )

Creates an XML File

TXMLFile::~TXMLFile

(

)

[protected, virtual]

Destroys the XML File

---

Member Function Documentation

void zeus::TXMLFile::closeXML

(

)

[inline]

Closes the XML File

Retval TXMLFile::createXMLFile

(

const IString &

rMainNodeName )

Creates an XML file.

Parameters:

rMainNodeName

[IN]: Name of the main node to be created.

Returns:

Error code.

Retval TXMLFile::createXMLFile	(	const IString &	rstrMainNodeName,
		IXMLNode *&	rpMainNode
	)

Creates an XML file.

Parameters:

rstrMainNodeName	[IN] : Name of the main node to be created.
rpMainNode	[OUT]: The main node created.

Returns:

Error code.

Retval TXMLFile::createXMLFileFromStream

(

const IString &

rStream )

creates a xml file out of a stream

Parameters:

rStream

: Stream containing xml data

Retval zeus::TXMLFile::createXMLFileFromStream

(

const wchar_t *

pStream )

[inline]

creates an xml document out of a stream

Retval TXMLFile::createXObjectFile	(	const IString &	rObjectName,
		const IString &	rRootClassName,
		const IString &	rCodeModule
	)

creates a x-object file.

Parameters:

rObjectName	: Name of the object
rRootClassName	: root class
rCodeModule	: code module of the root class

Retval zeus::TXMLFile::createXObjectFile	(	const wchar_t *	pObjectName,
		const wchar_t *	pRootClassName,
		const wchar_t *	pCodeModule
	)		[inline]

creates an xml documeht for xobjects

TString zeus::TXMLFile::getDocumentStream

(

)

const [inline]

See also:

TXMLDataSource::getDocumentStream

Retval TXMLFile::getMainNode

(

IXMLNode *&

rpMainNode )

Get the main node.

Parameters:

rpMainNode

[OUT]: The main node.

Returns:

: Error code.

Retval zeus::TXMLFile::loadXML

(

NAMESPACE_Zeus::IXMLDocument *&

rpDocument )

[inline]

See also:

TXMLDataSource::loadXML

Retval TXMLFile::loadXML_internal

(

)

[protected, virtual]

loads an XML file into the internal document

Return values:

RET_REQUEST_FAILED	: could not load the XML file
RET_NOERROR	: File loaded

Retval zeus::TXMLFile::loadXObjects	(	IXObject *&	rpObject,
		bool	dDoUnfreeze = true,
		bool	bKeepXObjectAfterClosing = false
	)		[inline]

See also:

TXMLDataSource::loadXObjects

Retval TXMLFile::save

(

)

Save the XML File

Retval TXMLFile::saveAs	(	const IString &	rFileName,
		bool	bKeepOrginalFileName
	)

Save the XML File with an other filename

Retval zeus::TXMLFile::selectCastedObject	(	const IString &	rXObjectPath,
		const InterfaceID &	rInterfaceID,
		IZUnknown *&	rpObject
	)		[inline]

See also:

TXMLDataSource::selectCastedObject

Retval zeus::TXMLFile::selectCastedObject	(	const wchar_t *	pXObjectPath,
		const InterfaceID &	rInterfaceID,
		IZUnknown *&	rpObject
	)		[inline]

queries a casted object

Retval zeus::TXMLFile::selectNode	(	const IString &	rXPath,
		IXMLNode *&	rpNode
	)		[inline]

See also:

TXMLDataSource::selectNode

Retval zeus::TXMLFile::selectNode	(	const wchar_t *	pXPath,
		IXMLNode *&	rpNode
	)		[inline]

queries an xml node

Retval zeus::TXMLFile::selectNodes	(	const IString &	rXPath,
		IXPathResults *&	rpResults
	)		[inline]

See also:

TXMLDataSource::selectNodes

Retval zeus::TXMLFile::selectNodes	(	const wchar_t *	pXPath,
		IXPathResults *&	rpResults
	)		[inline]

selects a xpath result (list of nodes)

Retval zeus::TXMLFile::selectNodeValue	(	const IString &	rXPath,
		IString &	rValue
	)		[inline]

See also:

TXMLDataSource::selectNodeValue

Retval zeus::TXMLFile::selectNodeValue	(	const wchar_t *	pXPath,
		IString &	rValue
	)		[inline]

queries an xml node value

Retval zeus::TXMLFile::selectObject	(	const IString &	rXObjectPath,
		IXObject *&	rpObject
	)		[inline]

See also:

TXMLDataSource::selectObject

Retval zeus::TXMLFile::selectObject	(	const wchar_t *	pXObjectPath,
		IXObject *&	rpObject
	)		[inline]

queries an x-object

Retval zeus::TXMLFile::selectObjects	(	const wchar_t *	pXObjectPath,
		IXObjectCollection *&	rpCollection
	)		[inline]

queries a set of x-objects

Retval zeus::TXMLFile::selectObjects	(	const IString &	rXObjectPath,
		IXObjectCollection *&	rpCollection
	)		[inline]

See also:

TXMLDataSource::selectObjects

Retval TXMLFile::useDefaultNamespaceAs

(

const IString &

rstrPrefix )

In case the XML file contains a default namespace like xmlns="http://...", it is necessary to use it under a freely selectable prefix. This prefix must then be used in all calls to selectNode/s.

Parameters:

rstrPrefix

[IN]: The freely selectable prefix.

Returns:

: Error code.

void zeus::TXMLFile::useNamespace	(	const IString &	rPrefix,
		const IString &	rNamespace
	)		[inline]

sets a prefix for namspace

void zeus::TXMLFile::useNamespace	(	const wchar_t *	pPrefix,
		const wchar_t *	pNamespace
	)		[inline]

sets a prefix for namspace

Retval zeus::TXMLFile::writeNodeValue	(	const IString &	rXPath,
		const IString &	rValue
	)		[inline]

See also:

TXMLDataSource::writeNodeValue

Retval zeus::TXMLFile::writeNodeValue	(	const wchar_t *	pXPath,
		const wchar_t *	pValue
	)		[inline]

writes a node value to the XML file

---

The documentation for this class was generated from the following files:

• XMLFile.h
• XMLFile.cpp