CXmlEngDeserializerDOM Class Reference

#include <xml/dom/xmlengdeserializerdom.h>

class CXmlEngDeserializerDOM : public CBase

Inherits from

CXmlEngDeserializerDOM
- CBase

Protected Attributes
TPtrC8	iBuffer
RArray< TXmlEngDataContainer > *	iDataList
RXmlEngDOMImplementation *	iImpl
HBufC *	iInputFileName
TXmlEngDeserializerType	iType

Public Member Functions
	~CXmlEngDeserializerDOM()
IMPORT_C RXmlEngDocument	DeserializeL()
IMPORT_C RXmlEngDocument	DeserializeL(const TDesC &, TXmlEngDeserializerType)
IMPORT_C RXmlEngDocument	DeserializeL(RFs &, const TDesC &, TXmlEngDeserializerType)
IMPORT_C RXmlEngDocument	DeserializeL(const TDesC8 &, TXmlEngDeserializerType)
IMPORT_C RArray< TXmlEngDataContainer > *	ExternalData()
IMPORT_C CXmlEngDeserializerDOM *	NewL()
IMPORT_C void	SetInputBuffer(const TDesC8 &, TXmlEngDeserializerType)
IMPORT_C void	SetInputFileL(const TDesC &, TXmlEngDeserializerType)
IMPORT_C void	UseDOMImplementationL(RXmlEngDOMImplementation &)
IMPORT_C void	UseExternalDataL(RArray< TXmlEngDataContainer > &)

Protected Member Functions
	CXmlEngDeserializerDOM()

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Detailed Description

Deserializes a XML file to a DOM tree.

Sample code for deserialization to a DOM tree:

     // create deserializer
     CXmlEngDeserializerDOM* deserializer = CXmlEngDeserializerDOM::NewL();
     CleanupStack::PushL(deserializer);
     // configure deserializer
     deserializer->SetInputFileL(KInputFile, EDeserializerGZip);
     // Set the DOM Implementation
     deserializer->UseDOMImplementationL(iDomImpl);
     // deserialize
     RXmlEngDocument doc = deserializer->DeserializeL();
     CleanupStack::PopAndDestroy();// deserializer

Member Attribute Documentation

iBuffer

TPtrC8

iBuffer

[protected]

Buffer to be parsed

iDataList

RArray< TXmlEngDataContainer > *

iDataList

[protected]

Array of external data

iImpl

RXmlEngDOMImplementation *

iImpl

[protected]

DOM implementation

iInputFileName

HBufC *

iInputFileName

[protected]

File to be parsed

iType

TXmlEngDeserializerType

iType

[protected]

Deserializer type

Constructor & Destructor Documentation

CXmlEngDeserializerDOM ( )

CXmlEngDeserializerDOM

(

)

[protected]

Default constructor.

~CXmlEngDeserializerDOM ( )

~CXmlEngDeserializerDOM

(

)

Destructor.

Member Function Documentation

DeserializeL ( )

IMPORT_C RXmlEngDocument

DeserializeL

(

)

Deserializes the file or buffer previously set by SetInputFileL() or SetInputBuffer() and creates a new document that holds the DOM tree.

Return Value: The document that holds the DOM tree

Leave Codes
KXmlEngErrNoParameters	No file or buffer has been previously set
KXmlEngErrWrongUseOfAPI	DOM Implementation not set

DeserializeL ( const TDesC &, TXmlEngDeserializerType )

IMPORT_C RXmlEngDocument	DeserializeL	(	const TDesC &	aFileName,
			TXmlEngDeserializerType	aType = EDeserializerDefault
		)

Deserializes the given file and creates a new document that holds the DOM tree. Any filename previously set with SetInputFileL() is ignored.

Parameters
aFileName	The file to be deserialized
aType	The deserialization format

Return Value: The document that holds the DOM tree

Leave Codes
KXmlEngErrWrongUseOfAPI	DOM Implementation not set

DeserializeL ( RFs &, const TDesC &, TXmlEngDeserializerType )

IMPORT_C RXmlEngDocument	DeserializeL	(	RFs &	aRFs,
			const TDesC &	aFileName,
			TXmlEngDeserializerType	aType = EDeserializerDefault
		)

Deserializes the given file and creates a new document that holds the DOM tree. Any filename previously set with SetInputFileL() is ignored.

Parameters
aRFs	File Server session
aFileName	The file to be deserialized
aType	The deserialization format

Return Value: The document that holds the DOM tree

Leave Codes
KXmlEngErrWrongUseOfAPI	DOM Implementation not set

DeserializeL ( const TDesC8 &, TXmlEngDeserializerType )

IMPORT_C RXmlEngDocument	DeserializeL	(	const TDesC8 &	aBuffer,
			TXmlEngDeserializerType	aType = EDeserializerDefault
		)

Deserializes the given buffer and creates a new document that holds the DOM tree. Any buffer previously set with SetInputBuffer() is ignored.

Parameters
aBuffer	Buffer to be parsed
aType	Input type

Return Value: The document that holds the DOM tree

Leave Codes
KXmlEngErrWrongUseOfAPI	DOM Implementation not set

ExternalData ( )

IMPORT_C RArray< TXmlEngDataContainer > *

ExternalData

(

)

Gets the list of external data containers.

Return Value: The list of data containers or NULL if no external data is registered

NewL ( )

IMPORT_C CXmlEngDeserializerDOM *

NewL

(

)

[static]

Creates an instance of CXmlEngDeserializerDOM.

Return Value: The DOM deserializer instance

Leave Codes
KErrNoMemory	Memory allocation failure

SetInputBuffer ( const TDesC8 &, TXmlEngDeserializerType )

IMPORT_C void	SetInputBuffer	(	const TDesC8 &	aBuffer,
			TXmlEngDeserializerType	aType = EDeserializerDefault
		)

Sets the input to to buffer and saves the buffer for later deserialization.

Parameters
aBuffer	The buffer to deserialize
aType	The deserialization format

SetInputFileL ( const TDesC &, TXmlEngDeserializerType )

IMPORT_C void	SetInputFileL	(	const TDesC &	aFileName,
			TXmlEngDeserializerType	aType = EDeserializerDefault
		)

Sets the input type to file and saves the file name for later deserialization.

Parameters
aFileName	The file name of the file to deserialize
aType	The deserialization format

Leave Codes

UseDOMImplementationL ( RXmlEngDOMImplementation & )

IMPORT_C void

UseDOMImplementationL

(

RXmlEngDOMImplementation &

aImpl

)

Sets the DOM implementation that will be used to create the DOM tree

Parameters
aImpl	The DOM implementation

Leave Codes

UseExternalDataL ( RArray< TXmlEngDataContainer > & )

IMPORT_C void

UseExternalDataL

(

RArray< TXmlEngDataContainer > &

aList

)

Sets a list of data containers and indicates that the XML to be deserialized contains references (such as xop:include) to data stored outside the DOM tree.

Upon deserialization, the references are substituted with the matching data containers and returned via the content handler.

This often occurs when a multipart MIME message is received. The text XML content may be in one part, while the binary content is in another part. Each part containing binary content must be placed into a data container using RXmlEngDocument::CreateBinaryContainerL() or similar. When deserialization of the XML occurs, the data containers are retrieved by content-id.

Ownership is not transferred and the list must stay in scope for the lifetime of the deserializer.

Parameters
aList	The list of data containers

Leave Codes