zeus::IXSDDocument Class Reference

#include <IXSDDocument.hpp>

Inheritance diagram for zeus::IXSDDocument:

List of all members.

Public Member Functions
virtual Retval MQUALIFIER	saveContainerDocument (const IString &strFileName) const =0
virtual Retval MQUALIFIER	getNamedNode (const IString &strXSDQualifier, const IString &strName, IXSDNode *&rpNode)=0
virtual Retval MQUALIFIER	getSpecificNodes (const IString &strXSDQualifier, IXSDNodes *&rpNodes)=0
virtual Retval MQUALIFIER	getElement (const IString &strElementName, IXSDNode *&rpNode)=0
virtual Retval MQUALIFIER	getSimpleType (const IString &strSimpleTypeName, IXSDNode *&rpNode)=0
virtual Retval MQUALIFIER	getComplexType (const IString &strComplexTypeName, IXSDNode *&rpNode)=0
virtual Retval MQUALIFIER	getElementsOfComplexType (const IString &strComplexTypeName, IXSDNodes *&rpElements)=0
virtual Retval MQUALIFIER	getElementOfComplexType (const IString &strComplexTypeName, const IString &strElementName, IXSDNode *&rpElement)=0
virtual Retval MQUALIFIER	getAttributesOfComplexType (const IString &strComplexTypeName, IXSDNodes *&rpAttributes)=0
virtual Retval MQUALIFIER	getAttributeOfComplexType (const IString &strComplexTypeName, const IString &strAttributeName, IXSDNode *&rpAttribute)=0
virtual Retval MQUALIFIER	getComplexTypes (IXSDNodes *&rpComplexTypes)=0
virtual Retval MQUALIFIER	getSimpleTypes (IXSDNodes *&rpSimpleTypes)=0
virtual Retval MQUALIFIER	getAllElementsOfComplexType (const IString &strComplexTypeName, IXSDNodes *&rpElements)=0
virtual Retval MQUALIFIER	createNewXSDChildNode (IXSDNode &rParentNode, const IString &strName, bool bPrefixSchemaNamespace, IXSDNode *&rpNode)=0
virtual bool MQUALIFIER	isXSDNodeIncludedInFile (const IXSDNode &rNode, const IString &strFilePath) const =0
virtual Retval MQUALIFIER	getIncludeFileMainNode (const IString &strIncludeFile, IXSDNode *&rpNode)=0

---

Detailed Description

The IXSDDocument extends the IXMLDocument, but does not derive IXMLDocument directly to avoid multiple inheritance in the implementation class.

---

Member Function Documentation

virtual Retval MQUALIFIER zeus::IXSDDocument::createNewXSDChildNode	(	IXSDNode &	rParentNode,
		const IString &	strName,
		bool	bPrefixSchemaNamespace,
		IXSDNode *&	rpNode
	)		[pure virtual]

See also:

IXMLNode::createNewChildNode

Parameters:

rParentNode	[IN]: The parent node.
strName	[IN]: name of the child nose
bPrefixSchemaNamespace	[IN]: Prefix the schema namespace at the beginning of strName.
rpNode	[OUT]: return parameter of the new node

Returns:

error codes

virtual Retval MQUALIFIER zeus::IXSDDocument::getAllElementsOfComplexType	(	const IString &	strComplexTypeName,
		IXSDNodes *&	rpElements
	)		[pure virtual]

Get a list of all element nodes in the entire schema of a given xsd complex type.

Parameters:

strComplexTypeName	[IN] : Name of the complex type.
rpElements	[OUT]: Pointer to a collection of element nodes.

Returns:

Error code.

virtual Retval MQUALIFIER zeus::IXSDDocument::getAttributeOfComplexType	(	const IString &	strComplexTypeName,
		const IString &	strAttributeName,
		IXSDNode *&	rpAttribute
	)		[pure virtual]

Get one specific attribute sub node of a given xsd complex type.

Parameters:

strComplexTypeName	[IN] : Name of the complex type.
strAttributeName	[IN] : Name of the attribute.
rpAttribute	[OUT]: Pointer to the attribute node.

Returns:

Error code.

virtual Retval MQUALIFIER zeus::IXSDDocument::getAttributesOfComplexType	(	const IString &	strComplexTypeName,
		IXSDNodes *&	rpAttributes
	)		[pure virtual]

Get a list of all attribute sub nodes of a given xsd complex type.

Parameters:

strComplexTypeName	[IN] : Name of the complex type.
rpAttributes	[OUT]: Pointer to a collection of attribute nodes.

Returns:

Error code.

virtual Retval MQUALIFIER zeus::IXSDDocument::getComplexType	(	const IString &	strComplexTypeName,
		IXSDNode *&	rpNode
	)		[pure virtual]

Get a complex type node.

Parameters:

strComplexTypeName	[IN] : Name of the complex type.
rpNode	[OUT]: Pointer to an IXSDNode.

Returns:

Error code.

virtual Retval MQUALIFIER zeus::IXSDDocument::getComplexTypes

(

IXSDNodes *&

rpComplexTypes )

[pure virtual]

Get a list of all complex types.

Parameters:

rpComplexTypes

[OUT]: Pointer to a collection of complex type nodes.

Returns:

Error code.

virtual Retval MQUALIFIER zeus::IXSDDocument::getElement	(	const IString &	strElementName,
		IXSDNode *&	rpNode
	)		[pure virtual]

Get an element node.

Parameters:

strElementName	[IN] : The element's name.
rpNode	[OUT]: Pointer to an IXSDNode.

Returns:

Error code.

virtual Retval MQUALIFIER zeus::IXSDDocument::getElementOfComplexType	(	const IString &	strComplexTypeName,
		const IString &	strElementName,
		IXSDNode *&	rpElement
	)		[pure virtual]

Get one specific element sub node of a given xsd complex type.

Parameters:

strComplexTypeName	[IN] : Name of the complex type.
strElementName	[IN] : Name of the element.
rpElement	[OUT]: Pointer to the element node.

Returns:

Error code.

virtual Retval MQUALIFIER zeus::IXSDDocument::getElementsOfComplexType	(	const IString &	strComplexTypeName,
		IXSDNodes *&	rpElements
	)		[pure virtual]

Get a list of all element sub nodes of a given xsd complex type.

Parameters:

strComplexTypeName	[IN] : Name of the complex type.
rpElements	[OUT]: Pointer to a collection of element nodes.

Returns:

Error code.

virtual Retval MQUALIFIER zeus::IXSDDocument::getIncludeFileMainNode	(	const IString &	strIncludeFile,
		IXSDNode *&	rpNode
	)		[pure virtual]

Get the main node of a given include file.

Parameters:

strIncludeFile	[IN] : Absolute file path of the include file.
rpNode	[OUT]: The main node.

Returns:

Error code.

virtual Retval MQUALIFIER zeus::IXSDDocument::getNamedNode	(	const IString &	strXSDQualifier,
		const IString &	strName,
		IXSDNode *&	rpNode
	)		[pure virtual]

Get a specific named node.

Parameters:

strXSDQualifier	[IN] : XSD qualifier like 'element' or 'complexType'.
strName	[IN] : The name used within the desired node.
rpNode	[OUT]: Pointer to an IXSDNode.

Returns:

Error code.

virtual Retval MQUALIFIER zeus::IXSDDocument::getSimpleType	(	const IString &	strSimpleTypeName,
		IXSDNode *&	rpNode
	)		[pure virtual]

Get a simple type node.

Parameters:

strSimpleTypeName	[IN] : Name of the simple type.
rpNode	[OUT]: Pointer to an IXSDNode.

Returns:

Error code.

virtual Retval MQUALIFIER zeus::IXSDDocument::getSimpleTypes

(

IXSDNodes *&

rpSimpleTypes )

[pure virtual]

Get a list of all simple types.

Parameters:

rpSimpleTypes

[OUT]: Pointer to a collection of simple type nodes.

Returns:

Error code.

virtual Retval MQUALIFIER zeus::IXSDDocument::getSpecificNodes	(	const IString &	strXSDQualifier,
		IXSDNodes *&	rpNodes
	)		[pure virtual]

Get a collection of specific nodes.

Parameters:

strXSDQualifier	[IN] : XSD qualifier like 'element' or 'complexType'.
rpNodes	[OUT]: Pointer to a collection of IXSDNodes.

Returns:

Error code.

virtual bool MQUALIFIER zeus::IXSDDocument::isXSDNodeIncludedInFile	(	const IXSDNode &	rNode,
		const IString &	strFilePath
	)		const [pure virtual]

Is an XSD node in a specific include file?

Parameters:

rNode	[IN]: The XSD node.
strFilePath	[IN]: Absolute file path of the include file.

Return values:

true	: rNode is included in strFilePath.
false,:	rNode is not included in strFilePath.

virtual Retval MQUALIFIER zeus::IXSDDocument::saveContainerDocument

(

const IString &

strFileName )

const [pure virtual]

Save the container document.

Parameters:

strFileName

[IN] : File name.

Returns:

Error code.

---

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

• IXSDDocument.hpp