ISAXDOMSerializerServices Class Reference

#include <ISAXDOMSerializerServices.h>

Inheritance diagram for ISAXDOMSerializerServices:

Public Types
enum	{ kDefaultIID = IID_ISAXDOMSERIALIZERSERVICES }

Public Member Functions
virtual bool16	SerializeDOM (IIDXMLDOMDocument *documentDOM, ISAXDOMSerializerHandler *defaultHandler, BaseProgressBar *progressBar)=0
virtual ISAXDOMSerializerHandler *	GetDefaultContentHandler () const =0
virtual void	RegisterElementHandler (const WideString &uri, const WideString &localName, ISAXDOMSerializerHandler *handler)=0
virtual ISAXDOMSerializerHandler *	QueryElementHandler (const WideString &uri, const WideString &localName) const =0
virtual void	RegisterAttributeHandler (const WideString &uri, const WideString &localName, ISAXDOMSerializerHandler *handler)=0
virtual ISAXDOMSerializerHandler *	QueryAttributeHandler (const WideString &uri, const WideString &localName) const =0
virtual void	RegisterPIHandler (const WideString &targetName, ISAXDOMSerializerHandler *handler)=0
virtual ISAXDOMSerializerHandler *	QueryPIHandler (const WideString &targetName) const =0
virtual IXMLParsingContext *	QueryCurrentParsingContext ()=0
virtual void	Push_Back (IXMLParsingContext *parsingContext)=0
virtual IXMLParsingContext *	Pop_Back ()=0
virtual IXMLParsingContext *	Back ()=0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

Class responsible for serialization of a document DOM. Clients pass in custom handlers. SAX (Simple API for XML) specifies an abstract set of interfaces a conforming serializer should implement.

See Also

ISAXDOMSerializerHandler.

Member Function Documentation

virtual IXMLParsingContext* ISAXDOMSerializerServices::Back ( )

pure virtual

Peek at the parsing context information on the top of the stack. This does not remove the context information from the stack. Useful for examining parent information.

Returns

instance of IXMLParsingContext.

virtual ISAXDOMSerializerHandler* ISAXDOMSerializerServices::GetDefaultContentHandler ( ) const

pure virtual

Return the default content handler that was supplied at the beginning of the serialization. This is only valid during a serialization. Otherwise this will return nil.

Returns

the instance of the default serialization handler. This is not addref'ed.

virtual IXMLParsingContext* ISAXDOMSerializerServices::Pop_Back ( )

pure virtual

Remove the specified set of parsing context information on a stack.

Returns

instance of IXMLParsingContext.

virtual void ISAXDOMSerializerServices::Push_Back ( IXMLParsingContext *  parsingContext )

pure virtual

Save the specified set of parsing context information on a stack. When parsing an imported XML file parent/child element parsing information is maintained on this stack. For example StartElement pushes the current parsing context information on the stack before creating a new element.

Parameters

parsingContext

a set of parsing context information, usually the current information.

virtual ISAXDOMSerializerHandler* ISAXDOMSerializerServices::QueryAttributeHandler ( const WideString &  uri, const WideString &  localName  ) const

pure virtual

Return the content handler registered for this attribute.

Parameters

uri	the uri (namespace) of the attribute
localName	the unqualifed portion of the attribute

Returns

addref'ed instance of the content handler

virtual IXMLParsingContext* ISAXDOMSerializerServices::QueryCurrentParsingContext ( )

pure virtual

Returns the current parsing context information. This includes the current element, tag name, child index, story reference, and text insertion position. Additional parsing context information can be accessed via this interface if content handlers have data interfaces to kXMLParsingLocatorBoss.

Returns

instance of IXMLParsingContext.

virtual ISAXDOMSerializerHandler* ISAXDOMSerializerServices::QueryElementHandler ( const WideString &  uri, const WideString &  localName  ) const

pure virtual

Return the content handler registered for this element tag name.

Parameters

uri	the uri (namespace) of the tag name
localName	the unqualifed portion of the tag name

Returns

addref'ed instance of the content handler

virtual ISAXDOMSerializerHandler* ISAXDOMSerializerServices::QueryPIHandler ( const WideString &  targetName ) const

pure virtual

Return the content handler registered for this processing instruction target name.

Parameters

targetName

the name of the target

Returns

addref'ed instance of the content handler

virtual void ISAXDOMSerializerServices::RegisterAttributeHandler ( const WideString &  uri, const WideString &  localName, ISAXDOMSerializerHandler *  handler  )

pure virtual

Register a content handler for a given attribute. When the serialization encounters an element with the specified attribute it will use this content handler to deal with it.

Parameters

uri	the uri (namespace) of the attribute
localName	the unqualifed portion of the attribute
handler	an instance of ISAXDOMSerializerHandler that handle this element

virtual void ISAXDOMSerializerServices::RegisterElementHandler ( const WideString &  uri, const WideString &  localName, ISAXDOMSerializerHandler *  handler  )

pure virtual

Register a content handler for a given element. When the serialization encounters an element with the specified name it will use this content handler to deal with it.

Parameters

uri	the uri (namespace) of the tag name
localName	the unqualifed portion of the tag name
handler	an instance of ISAXDOMSerializerHandler that handle this element

virtual void ISAXDOMSerializerServices::RegisterPIHandler ( const WideString &  targetName, ISAXDOMSerializerHandler *  handler  )

pure virtual

Register a content handler for a given processing instruction target. When the serialization encounters a PI with the specified target name it will use this content handler to deal with it.

Parameters

targetName	the name of the processing instruction target
handler	an instance of ISAXDOMSerializerHandler that handle this PI

virtual bool16 ISAXDOMSerializerServices::SerializeDOM ( IIDXMLDOMDocument *  documentDOM, ISAXDOMSerializerHandler *  defaultHandler, BaseProgressBar *  progressBar  )

pure virtual

Serialize the incoming document DOM, calling out to the DOMSerializerHandler as elements are encountered.

Parameters

documentDOM	specifies the document DOM to be serialzied.
defaultHandler	the default DOMSerializerHandler.
progressBar	the progress bar to use when importing XML content.

Returns

bool16