Namespace XmlWriter
Class CXmlWriter

class CXmlWriter: public Sax::CContentHandler {
public:
    CXmlWriter();
    virtual ~CXmlWriter();
public:
    virtual bool GetUri(CString &strUri) = 0;
    virtual bool GetNamespaces(bool &bNamespaces) = 0;
    virtual bool GetMethod(
        CString &strNamespaceUri, 
        CString &strLocalName) = 0;
    virtual bool GetVersion(CString &strVersion) = 0;
    virtual bool GetEncoding(CString &strEncoding) = 0;
    virtual bool GetOmitXmlDeclaration(
        bool &bOmitXmlDeclaration) = 0;
    virtual bool GetStandalone(bool &bStandalone) = 0;
    virtual bool GetDoctypePublic(CString &strDoctypePublic) = 0;
    virtual bool GetDoctypeSystem(CString &strDoctypeSystem) = 0;
    virtual bool GetIndent(bool &bIndent) = 0;
    virtual bool GetMediaType(CString &strMediaType) = 0;
public:
    virtual void SetUri(const CString &strUri) = 0;
    virtual void SetNamespaces(bool bNamespaces) = 0;
    virtual void SetMethod(
        const CString &strNamespaceUri,
        const CString &strLocalName) = 0;
    virtual void SetVersion(const CString &strVersion) = 0;
    virtual void SetEncoding(const CString &strEncoding) = 0;
    virtual void SetOmitXmlDeclaration(bool bOmitXmlDeclaration) = 0;
    virtual void SetStandalone(bool bStandalone) = 0;
    virtual void SetDoctypePublic(
        const CString &strDoctypePublic) = 0;
    virtual void SetDoctypeSystem(
        const CString &strDoctypeSystem) = 0;
    virtual void SetIndent(bool bIndent) = 0;
    virtual void SetMediaType(const CString &strMediaType) = 0;
    };

The abstract interface to XML writers.

XML writer is represented as the subclass of SAX content handler (see Sax::CContentHandler ). It accepts the stream of XML content events as input. The application programmer must specify whether the input stream is expected to perform namespace processing (see Sax for the detailed discussion of the namespace processing in SAX).

XML writer generates the output text stream in the specified format and sends it to the specified target URI.

XML writer engine is modelled after the output facility specified in XSL Transformations (XSLT) Version 1.0.

In particular, every XML writer owns a collection of properties corresponding to various attributes specified for XSLT xsl:output element. For each property the CXmlWriter class provides a pair of member functions designed to get or set the property value. Each property may be assigned a particular value, or may be undefined.

Following is the complete list of writer properties. Refer to XSL Transformations (XSLT) Version 1.0 for the detailed description of semantics of these properties.

• the name of the output method. This is a pair of a namespace URI and a local name. Corresponds to the method attribute on xsl:output .
• the version of the output method. Corresponds to the version attribute on xsl:output .
• the preferred character encoding. Corresponds to the encoding attribute on xsl:output .
• the omit XML declaration indicator. The boolean which specifies whether the writer should output an XML declaration. Corresponds to the omit-xml-declaration attribute on xsl:output .
• the standalone indicator. The boolean which specifies whether the writer should output a standalone XML declaration. Corresponds to the standalone attribute on xsl:output .
• the system identifier to be used in the document type declaration. Corresponds to the doctype-system attribute on xsl:output .
• the public identifier to be used in the document type declaration. Corresponds to the doctype-public attribute on xsl:output .
• the indent indicator. The boolean which specifies whether the writer may insert additional whitespace. Corresponds to the indent attribute on xsl:output .
• the media type of the data generated by the writer. Corresponds to the media-type attribute on xsl:output .

Additionaly, there are two writer properties which have no equivalent in XSLT:

• the target URI. The writer must send the generated data to the resource specified by this URI.
• the namespace processing indicator. The boolean which specifies whether the input content event stream is expected to perform namespace processing.

Since:

1.00.00

Version:

1.00.00

Author:

Alexey Gokhberg

CXmlWriter

CXmlWriter();

Constructs the XML writer.

~CXmlWriter

virtual ~CXmlWriter();

Destroys the XML writer.

GetUri

virtual bool GetUri(CString &strUri) = 0;

Queries the target URI.

Parameters:

strUri - on return, the string representing the target URI, if defined

Returns:

true if the target URI is defined; false otherwise

GetNamespaces

virtual bool GetNamespaces(bool &bNamespaces) = 0;

Queries the namespace processing indicator.

Parameters:

bNamespaces - on return, the boolean namespace processing indicator, if defined

Returns:

true if the namespace processing indicator is defined; false otherwise

GetMethod

virtual bool GetMethod(
    CString &strNamespaceUri, 
    CString &strLocalName) = 0;

Queries the name of the output method.

Parameters:

strNamespaceUri - on return, the output method namespace URI, if defined

strLocalName - on return, the output method local name, if defined

Returns:

true if the name of the output method is defined; false otherwise

GetVersion

virtual bool GetVersion(CString &strVersion) = 0;

Queries the version of the output method.

Parameters:

strVersion - on return, the version of the output method, if defined

Returns:

true if the version of the output method is defined, false otherwise

GetEncoding

virtual bool GetEncoding(CString &strEncoding) = 0;

Queries the preferred character encoding.

Parameters:

strEncoding - on return, the string representing the encoding name, if defined

Returns:

true if the encoding name is defined; false otherwise

GetOmitXmlDeclaration

virtual bool GetOmitXmlDeclaration(
    bool &bOmitXmlDeclaration) = 0;

Queries the omit XML declaration indicator.

Parameters:

bOmitXmlDeclaration - on return, the boolean XML declaration indicator, if defined

Returns:

true if the omit XML declaration indicator is defined; false otherwise

GetStandalone

virtual bool GetStandalone(bool &bStandalone) = 0;

Queries the standalone indicator.

Parameters:

bStandalone - on return, the boolean standalone indicator, if defined

Returns:

true if the standalone indicator is defined; false otherwise

GetDoctypePublic

virtual bool GetDoctypePublic(CString &strDoctypePublic) = 0;

Queries the document type system identifier.

Parameters:

strDoctypePublic - on return, the string representing the document type system identifier, if defined

Returns:

true if the document system identifier is defined; false otherwise

GetDoctypeSystem

virtual bool GetDoctypeSystem(CString &strDoctypeSystem) = 0;

Queries the document type public identifier.

Parameters:

strDoctypeSystem - on return, the string representing the document type public identifier, if defined

Returns:

true if the document system identifier is defined; false otherwise

GetIndent

virtual bool GetIndent(bool &bIndent) = 0;

Queries the indent indicator.

Parameters:

bIndent - on return, the boolean indent indicator, if defined

Returns:

true if the indent indicator is defined; false otherwise

GetMediaType

virtual bool GetMediaType(CString &strMediaType) = 0;

Queries the media type.

Parameters:

strMediaType - on return, the string representing the media type, if defined

Returns:

true if the media type is defined; false otherwise

SetUri

virtual void SetUri(const CString &strUri) = 0;

Sets the target URI.

Parameters:

strUri - the string representing the target URI

SetNamespaces

virtual void SetNamespaces(bool bNamespaces) = 0;

Sets the namepace processing indicator.

Parameters:

bNamespaces - the boolean namespace processing indicator

SetMethod

virtual void SetMethod(
    const CString &strNamespaceUri,
    const CString &strLocalName) = 0;

Sets the name of the output method.

Parameters:

strNamespaceUri - the output method namespace URI

strLocalName - the output method local name

SetVersion

virtual void SetVersion(const CString &strVersion) = 0;

Sets the version of the output method.

Parameters:

strVersion - the version of the output method

SetEncoding

virtual void SetEncoding(const CString &strEncoding) = 0;

Sets the preferred character encoding.

Parameters:

strEncoding - the string representing the encoding name

SetOmitXmlDeclaration

virtual void SetOmitXmlDeclaration(bool bOmitXmlDeclaration) = 0;

Sets the omit XML declaration indicator.

Parameters:

bOmitXmlDeclaration - the boolean omit XML declaration indicator

SetStandalone

virtual void SetStandalone(bool bStandalone) = 0;

Sets the standalone indicator.

Parameters:

bStandalone - the boolean standalone indicator

SetDoctypePublic

virtual void SetDoctypePublic(
    const CString &strDoctypePublic) = 0;

Sets the document type public identifier.

Parameters:

strDoctypePublic - the string representing the document type public identifier

SetDoctypeSystem

virtual void SetDoctypeSystem(
    const CString &strDoctypeSystem) = 0;

Sets the document type system identifier.

Parameters:

strDoctypeSystem - the string representing the document type system identifier

SetIndent

virtual void SetIndent(bool bIndent) = 0;

Sets the indent indicator.

Parameters:

bIndent - the boolean indent indicator

SetMediaType

virtual void SetMediaType(const CString &strMediaType) = 0;

Sets the media type.

Parameters:

strMediaType - the string representing the media type