CXmlEngDeserializer Class Reference

#include <xml/dom/xmlengdeserializer.h>

class CXmlEngDeserializer : public CBase

Inherits from

Public Member Functions
virtual ~CXmlEngDeserializer()
virtual IMPORT_C voidDeserializeL()
virtual IMPORT_C voidDeserializeL(const TDesC &, const TXmlEngParsingOptions &)
virtual IMPORT_C voidDeserializeL(RFs &, const TDesC &, const TXmlEngParsingOptions &)
virtual IMPORT_C voidDeserializeL(const TDesC8 &, const TXmlEngParsingOptions &)
virtual IMPORT_C TIntDisableFeature(TInt)
virtual IMPORT_C TIntEnableFeature(TInt)
IMPORT_C RArray< TXmlEngDataContainer > *ExternalData()
TXmlEngDataContainer *GetDataContainer(const TDesC8 &)
virtual IMPORT_C TBoolIsFeatureEnabled(TInt)
IMPORT_C CXmlEngDeserializer *NewL(Xml::MContentHandler &, TXmlEngDeserializerType)
virtual IMPORT_C const TXmlEngParsingOptions &ParsingOptions()
virtual IMPORT_C voidSetContentHandlerL(Xml::MContentHandler &)
IMPORT_C voidSetInputBuffer(const TDesC8 &)
IMPORT_C voidSetInputFileL(const TDesC &)
virtual IMPORT_C voidSetParsingOptions(TXmlEngParsingOptions &)
IMPORT_C voidUseExternalDataL(RArray< TXmlEngDataContainer > &)
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

Provides deserialization and parsing for XML content using a SAX callback interface. Derived classes provide deserialization for specific formats, whereas this class defines the interface and provides default (plain XML) deserialization.

See also: TXmlEngDeserializerType

Deserialization generates SAX events that are passed to a MContentHandler.

See also: Xml::MContentHandler

For deserialization to a DOM tree, see CXmlEngDeserializerDOM.

See also: CXmlEngDeserializerDOM

Support for data stored outside the DOM tree, such as data linked by xop:include references, is provided. The external data must be set with UseExternalDataL() prior to deserialization. The data is then returned through the MContentHandler interface.

Constructor & Destructor Documentation

~CXmlEngDeserializer ( )

~CXmlEngDeserializer()[virtual]

Destructor

Member Function Documentation

DeserializeL ( )

IMPORT_C voidDeserializeL()[virtual]

Deserializes the file or buffer previously set by SetInputFileL() or SetInputBuffer().

The result of deserialization is passed to the content handler as SAX events.

Leave Codes
KXmlEngErrNoParametersNo file or buffer has been previously set

DeserializeL ( const TDesC &, const TXmlEngParsingOptions & )

IMPORT_C voidDeserializeL(const TDesC &aFileName,
const TXmlEngParsingOptions &aOptions =  TXmlEngParsingOptions()
)[virtual]

Deserializes the given file. Any filename previously set with SetInputFileL() is ignored.

The result of deserialization is passed to the content handler as SAX events.

Parameters
aFileNameThe file to be parsed
aOptionsParsing options
Leave Codes

DeserializeL ( RFs &, const TDesC &, const TXmlEngParsingOptions & )

IMPORT_C voidDeserializeL(RFs &aRFs,
const TDesC &aFileName,
const TXmlEngParsingOptions &aOptions =  TXmlEngParsingOptions()
)[virtual]

Deserializes the given file. Any filename previously set with SetInputFileL() is ignored.

The result of deserialization is passed to the content handler as SAX events.

Parameters
aRFsFile Server session
aFileNameThe file to be parsed
aOptionsParsing options
Leave Codes

DeserializeL ( const TDesC8 &, const TXmlEngParsingOptions & )

IMPORT_C voidDeserializeL(const TDesC8 &aBuffer,
const TXmlEngParsingOptions &aOptions =  TXmlEngParsingOptions()
)[virtual]

Deserializes the given buffer. Any buffer previously set with SetInputBuffer() is ignored.

The result of deserialization is passed to the content handler as SAX events.

Parameters
aBufferThe buffer to be parsed
aOptionsParsing options
Leave Codes

DisableFeature ( TInt )

IMPORT_C TIntDisableFeature(TIntaParserFeature)[virtual]

Disables parser features.

See also: Xml::CParser::DisableFeature() Xml::CParser::TParserFeature

Parameters
aParserFeatureThe parser feature to disable
Return Value
KErrNone if successful, otherwise one of the system-wide error codes

EnableFeature ( TInt )

IMPORT_C TIntEnableFeature(TIntaParserFeature)[virtual]

Enables parser features.

See also: Xml::CParser::EnableFeature() Xml::CParser::TParserFeature

Parameters
aParserFeatureThe parser feature to enable
Return Value
KErrNone if successful, otherwise one of the system-wide error codes

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

GetDataContainer ( const TDesC8 & )

TXmlEngDataContainer *GetDataContainer(const TDesC8 &aCid)

Retrieves a pointer to the data container referenced by CID.

Parameters
aCidThe aCid corresponding to the data container required
Return Value
The data container or NULL if no matching container is found

IsFeatureEnabled ( TInt )

IMPORT_C TBoolIsFeatureEnabled(TIntaParserFeature)const [virtual]

Checks if a parser feature is enabled.

See also: Xml::CParser::IsFeatureEnabled() Xml::CParser::TParserFeature

Parameters
aParserFeatureThe parser feature to check
Return Value
ETrue if feature is enabled, otherwise EFalse

NewL ( Xml::MContentHandler &, TXmlEngDeserializerType )

IMPORT_C CXmlEngDeserializer *NewL(Xml::MContentHandler &aContentHandler,
TXmlEngDeserializerTypeaType = EDeserializerDefault
)[static]

Creates a deserializer of the given type. Returns an instance of this class or a derived class.

Parameters
aTypeDeserializer type
Return Value
The deserializer
Leave Codes

ParsingOptions ( )

IMPORT_C const TXmlEngParsingOptions &ParsingOptions()[virtual]

Gets the parsing options

Return Value
The parsing options

SetContentHandlerL ( Xml::MContentHandler & )

IMPORT_C voidSetContentHandlerL(Xml::MContentHandler &aContentHandler)[virtual]

Sets the content handler which handles SAX events raised during deserialization. Clients must derive from Xml::MContentHandler in order to receive SAX callbacks.

Parameters
aContentHandlerThe content handler
Leave Codes

SetInputBuffer ( const TDesC8 & )

IMPORT_C voidSetInputBuffer(const TDesC8 &aBuffer)

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

Parameters
aBufferThe buffer to deserialize

SetInputFileL ( const TDesC & )

IMPORT_C voidSetInputFileL(const TDesC &aFileName)
Sets the input type to file and saves the file name for later deserialization.
Parameters
aFileNameThe file name of the file to deserialize
Leave Codes

SetParsingOptions ( TXmlEngParsingOptions & )

IMPORT_C voidSetParsingOptions(TXmlEngParsingOptions &aOptions)[virtual]

Sets parsing options used for deserialization.

Parameters
aOptionsParsing options to set. A copy of the options is stored.

UseExternalDataL ( RArray< TXmlEngDataContainer > & )

IMPORT_C voidUseExternalDataL(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
aListThe list of data containers
Leave Codes
© Nokia 2005.