class Poco::XML::SAXParser

Overview

This class provides a SAX2 (Simple API for XML) interface to expat, the XML parser toolkit. More…

#include <SAXParser.h>

class SAXParser: public Poco::XML::XMLReader
{
public:
    // fields

    static const XMLString FEATURE_PARTIAL_READS;

    // construction

    SAXParser();
    SAXParser(const XMLString& encoding);

    // methods

    void
    setEncoding(const XMLString& encoding);

    const XMLString&
    getEncoding() const;

    void
    addEncoding(
        const XMLString& name,
        Poco::TextEncoding* pEncoding
        );

    virtual
    void
    setEntityResolver(EntityResolver* pResolver);

    virtual
    EntityResolver*
    getEntityResolver() const;

    virtual
    void
    setDTDHandler(DTDHandler* pDTDHandler);

    virtual
    DTDHandler*
    getDTDHandler() const;

    virtual
    void
    setContentHandler(ContentHandler* pContentHandler);

    virtual
    ContentHandler*
    getContentHandler() const;

    virtual
    void
    setErrorHandler(ErrorHandler* pErrorHandler);

    virtual
    ErrorHandler*
    getErrorHandler() const;

    virtual
    void
    setFeature(
        const XMLString& featureId,
        bool state
        );

    virtual
    bool
    getFeature(const XMLString& featureId) const;

    virtual
    void
    setProperty(
        const XMLString& propertyId,
        const XMLString& value
        );

    virtual
    void
    setProperty(
        const XMLString& propertyId,
        void* value
        );

    virtual
    void*
    getProperty(const XMLString& propertyId) const;

    virtual
    void
    parse(InputSource* pSource);

    virtual
    void
    parse(const XMLString& systemId);

    virtual
    void
    parseMemoryNP(
        const char* xml,
        std::size_t size
        );

    void
    parseString(const std::string& xml);

protected:
    // methods

    void
    setupParse();
};

Inherited Members

public:
    // fields

    static const XMLString FEATURE_VALIDATION;
    static const XMLString FEATURE_NAMESPACES;
    static const XMLString FEATURE_NAMESPACE_PREFIXES;
    static const XMLString FEATURE_EXTERNAL_GENERAL_ENTITIES;
    static const XMLString FEATURE_EXTERNAL_PARAMETER_ENTITIES;
    static const XMLString FEATURE_STRING_INTERNING;
    static const XMLString PROPERTY_DECLARATION_HANDLER;
    static const XMLString PROPERTY_LEXICAL_HANDLER;

    // methods

    virtual
    void
    setEntityResolver(EntityResolver* pResolver) = 0;

    virtual
    EntityResolver*
    getEntityResolver() const = 0;

    virtual
    void
    setDTDHandler(DTDHandler* pDTDHandler) = 0;

    virtual
    DTDHandler*
    getDTDHandler() const = 0;

    virtual
    void
    setContentHandler(ContentHandler* pContentHandler) = 0;

    virtual
    ContentHandler*
    getContentHandler() const = 0;

    virtual
    void
    setErrorHandler(ErrorHandler* pErrorHandler) = 0;

    virtual
    ErrorHandler*
    getErrorHandler() const = 0;

    virtual
    void
    setFeature(
        const XMLString& featureId,
        bool state
        ) = 0;

    virtual
    bool
    getFeature(const XMLString& featureId) const = 0;

    virtual
    void
    setProperty(
        const XMLString& propertyId,
        const XMLString& value
        ) = 0;

    virtual
    void
    setProperty(
        const XMLString& propertyId,
        void* value
        ) = 0;

    virtual
    void*
    getProperty(const XMLString& propertyId) const = 0;

    virtual
    void
    parse(InputSource* pSource) = 0;

    virtual
    void
    parse(const XMLString& systemId) = 0;

    virtual
    void
    parseMemoryNP(
        const char* xml,
        std::size_t size
        ) = 0;

Detailed Documentation

This class provides a SAX2 (Simple API for XML) interface to expat, the XML parser toolkit.

The following SAX2 features and properties are supported:

* http://xml.org/sax/features/external-general-entities
* http://xml.org/sax/features/external-parameter-entities
* http://xml.org/sax/features/namespaces
* http://xml.org/sax/features/namespace-prefixes
* http://xml.org/sax/properties/lexical-handler
* http://xml.org/sax/properties/declaration-handler

The following proprietary extensions are supported:

* http://www.appinf.com/features/enable-partial-reads --
  see ParserEngine::setEnablePartialReads()

Construction

SAXParser()

Creates an SAXParser.

SAXParser(const XMLString& encoding)

Creates an SAXParser with the given encoding.

Methods

void
setEncoding(const XMLString& encoding)

Sets the encoding used by the parser if no encoding is specified in the XML document.

const XMLString&
getEncoding() const

Returns the name of the encoding used by the parser if no encoding is specified in the XML document.

void
addEncoding(
    const XMLString& name,
    Poco::TextEncoding* pEncoding
    )

Adds an encoding to the parser. Does not take ownership of the pointer!

virtual
void
setEntityResolver(EntityResolver* pResolver)

Allow an application to register an entity resolver.

If the application does not register an entity resolver, the XMLReader will perform its own default resolution.

Applications may register a new or different resolver in the middle of a parse, and the SAX parser must begin using the new resolver immediately.

virtual
EntityResolver*
getEntityResolver() const

Return the current entity resolver.

virtual
void
setDTDHandler(DTDHandler* pDTDHandler)

Allow an application to register a DTD event handler.

If the application does not register a DTD handler, all DTD events reported by the SAX parser will be silently ignored.

Applications may register a new or different handler in the middle of a parse, and the SAX parser must begin using the new handler immediately.

virtual
DTDHandler*
getDTDHandler() const

Return the current DTD handler.

virtual
void
setContentHandler(ContentHandler* pContentHandler)

Allow an application to register a content event handler.

If the application does not register a content handler, all content events reported by the SAX parser will be silently ignored.

Applications may register a new or different handler in the middle of a parse, and the SAX parser must begin using the new handler immediately.

virtual
ContentHandler*
getContentHandler() const

Return the current content handler.

virtual
void
setErrorHandler(ErrorHandler* pErrorHandler)

Allow an application to register an error event handler.

If the application does not register an error handler, all error events reported by the SAX parser will be silently ignored; however, normal processing may not continue. It is highly recommended that all SAX applications implement an error handler to avoid unexpected bugs.

Applications may register a new or different handler in the middle of a parse, and the SAX parser must begin using the new handler immediately.

virtual
ErrorHandler*
getErrorHandler() const

Return the current error handler.

virtual
void
setFeature(
    const XMLString& featureId,
    bool state
    )

Set the state of a feature.

The feature name is any fully-qualified URI. It is possible for an XMLReader to expose a feature value but to be unable to change the current value. Some feature values may be immutable or mutable only in specific contexts, such as before, during, or after a parse.

All XMLReaders are required to support setting http://xml.org/sax/features/namespaces to true and http://xml.org/sax/features/namespace-prefixes to false.

virtual
bool
getFeature(const XMLString& featureId) const

Look up the value of a feature.

The feature name is any fully-qualified URI. It is possible for an XMLReader to recognize a feature name but temporarily be unable to return its value. Some feature values may be available only in specific contexts, such as before, during, or after a parse. Also, some feature values may not be programmatically accessible. (In the case of an adapter for SAX1 Parser, there is no implementation-independent way to expose whether the underlying parser is performing validation, expanding external entities, and so forth.)

All XMLReaders are required to recognize the http://xml.org/sax/features/namespaces and the http://xml.org/sax/features/namespace-prefixes feature names. Implementors are free (and encouraged) to invent their own features, using names built on their own URIs.

virtual
void
setProperty(
    const XMLString& propertyId,
    const XMLString& value
    )

Set the value of a property.

The property name is any fully-qualified URI. It is possible for an XMLReader to recognize a property name but to be unable to change the current value. Some property values may be immutable or mutable only in specific contexts, such as before, during, or after a parse.

XMLReaders are not required to recognize setting any specific property names, though a core set is defined by SAX2.

This method is also the standard mechanism for setting extended handlers.

virtual
void
setProperty(
    const XMLString& propertyId,
    void* value
    )

Set the value of a property.

See also setProperty(const XMLString&, const XMLString&).

virtual
void*
getProperty(const XMLString& propertyId) const

Look up the value of a property.

String values are returned as XMLChar* The property name is any fully-qualified URI. It is possible for an XMLReader to recognize a property name but temporarily be unable to return its value. Some property values may be available only in specific contexts, such as before, during, or after a parse.

XMLReaders are not required to recognize any specific property names, though an initial core set is documented for SAX2.

Implementors are free (and encouraged) to invent their own properties, using names built on their own URIs.

virtual
void
parse(InputSource* pSource)

Parse an XML document.

The application can use this method to instruct the XML reader to begin parsing an XML document from any valid input source (a character stream, a byte stream, or a URI).

Applications may not invoke this method while a parse is in progress (they should create a new XMLReader instead for each nested XML document). Once a parse is complete, an application may reuse the same XMLReader object, possibly with a different input source. Configuration of the XMLReader object (such as handler bindings and values established for feature flags and properties) is unchanged by completion of a parse, unless the definition of that aspect of the configuration explicitly specifies other behavior. (For example, feature flags or properties exposing characteristics of the document being parsed.)

During the parse, the XMLReader will provide information about the XML document through the registered event handlers.

This method is synchronous: it will not return until parsing has ended. If a client application wants to terminate parsing early, it should throw an exception.

virtual
void
parse(const XMLString& systemId)

Parse an XML document from a system identifier.

See also parse(InputSource*).

virtual
void
parseMemoryNP(
    const char* xml,
    std::size_t size
    )

Parse an XML document from memory.

See also parse(InputSource*).