Inheritance diagram for zeus::IXMLParser:

Public Member Functions
virtual Retval MQUALIFIER	loadFromFile (const IString &rFileName, IXMLDocument *&rpDocu)=0
virtual Retval MQUALIFIER	loadXSDFromFile (const IString &rFileName, IXSDDocument &rpDocu, IString &strErrors, const char strSchemaNamespacePrefix="xsd")=0
virtual Retval MQUALIFIER	parseStream (const IString &rStream, IXMLDocument *&rpDocu)=0
virtual void MQUALIFIER	addErrorReporter (IXMLErrorReporter &rReporter)=0
virtual Retval MQUALIFIER	removeErrorReporter (IXMLErrorReporter &rReporter)=0
virtual bool MQUALIFIER	getProperty (const IString &rName) const =0
virtual void MQUALIFIER	setProperty (const IString &rName, bool bValue)=0

Detailed Description

Das IXMLParser Interface definiert einen XML Parser

Member Function Documentation

virtual void MQUALIFIER zeus::IXMLParser::addErrorReporter ( IXMLErrorReporter & rReporter ) [pure virtual]

Adds a error reporter to the parser. Throu this reporter, all errors during parsing the xml will be posted.

Parameters:

rReporter : Reference of the reporter

virtual bool MQUALIFIER zeus::IXMLParser::getProperty ( const IString & rName ) const [pure virtual]

Gets a named parser property. Check the property defines for the parser to lookup different possibilities.

Parameters:

rName : Name of the property

virtual Retval MQUALIFIER zeus::IXMLParser::loadFromFile	(	const IString &	rFileName,
		IXMLDocument *&	rpDocu
	)		`[pure virtual]`

This method loads a xml file into the buffer using a dom parser.

Parameters:

rFileName	: name of the file (path)
rpDocu	: Return parameter of the parsed document

Return values:

RET_NOERROR	: File loaded.
RET_INVALID_PARAMETER	: Invalid parameter received

virtual Retval MQUALIFIER zeus::IXMLParser::loadXSDFromFile	(	const IString &	rFileName,
		IXSDDocument *&	rpDocu,
		IString &	strErrors,
		const char *	strSchemaNamespacePrefix = `"xsd"`
	)		`[pure virtual]`

This method loads an xsd file.

Parameters:

rFileName	[IN] : Name and path of the file.
rpDocu	[OUT]: Return parameter of the parsed document
strErrors	[OUT]: Error descriptions.
strSchemaNamespacePrefix	[IN] : Optional: Namespace prefix of the schema namespace. Defaults to xsd. Give this parameter if you with to use xs or other prefixes.

Return values:

:	Error code.

virtual Retval MQUALIFIER zeus::IXMLParser::parseStream	(	const IString &	rStream,
		IXMLDocument *&	rpDocu
	)		`[pure virtual]`

This method loads a xml from a stream (string) into the buffer using a dom parser.

Parameters:

rStream	: stream of data
rpDocu	: Return parameter of the parsed document

Return values:

RET_NOERROR	: Stream loaded.
RET_INVALID_PARAMETER	: Invalid parameter received

virtual Retval MQUALIFIER zeus::IXMLParser::removeErrorReporter ( IXMLErrorReporter & rReporter ) [pure virtual]

Removes a error reporter of the parser.

Parameters:

rReporter : Reference of the reporter

Return values:

RET_NOERROR	: Reporter removed
RET_REQUEST_FAILED	: No such reporter was added

virtual void MQUALIFIER zeus::IXMLParser::setProperty	(	const IString &	rName,
		bool	bValue
	)		`[pure virtual]`

Sets the parser properties. Check the property defines for the parser to lookup different possibilities.

Parameters:

rName	: Name of the property
bValue	: Parser property

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