Poco::FastInfoset

class FastInfosetParser

Library: FastInfoset
Package: SAX
Header: Poco/FastInfoset/FastInfosetParser.h

Description

A FastInfosetParser parses a FISDocument translating the binary representation to method calls to optionally set XMl ContentHandlers/DTDHandlers/... Note that the parser supports external dictionaries but it doesn't support user defined encodings.

The following example code (taking from the FISParser sample) shows how the FastInfosetParse is used to convert a FastInfoset document into an xml file:

std::ifstream input;
input.open("dummy.finf", std::ios::binary);
Poco::XML::InputSource is(input);
std::ifstream output;
output.open("dummy.xml", std::ios::binary);
Poco::XML::XMLWriter writer(output, Poco::XML::XMLWriter::WRITE_XML_DECLARATION);

FastInfosetParser parser;
parser.initialize(&writer);
parser.parse(&is);
// finf file created, try catch around parse is recommended but was ommitted for simplicity

Inheritance

Direct Base Classes: Poco::XML::XMLReader

All Base Classes: Poco::XML::XMLReader

Member Summary

Member Functions: getContentHandler, getDTDHandler, getDocumentHandler, getEntityResolver, getErrorHandler, getFeature, getProperty, initialize, parse, parseMemoryNP, setContentHandler, setDTDHandler, setDocumentHandler, setEntityResolver, setErrorHandler, setFeature, setProperty, vocabulary

Inherited Functions: getContentHandler, getDTDHandler, getEntityResolver, getErrorHandler, getFeature, getProperty, parse, parseMemoryNP, setContentHandler, setDTDHandler, setEntityResolver, setErrorHandler, setFeature, setProperty

Constructors

FastInfosetParser

FastInfosetParser();

Creates the FastInfosetParser.

Destructor

~FastInfosetParser virtual

~FastInfosetParser();

Destroys the FastInfosetParser.

Member Functions

getContentHandler

Poco::XML::ContentHandler * getContentHandler() const;

Return the current content handler.

getDTDHandler

Poco::XML::DTDHandler * getDTDHandler() const;

Return the current DTD handler.

getDocumentHandler

FISDocumentHandler * getDocumentHandler() const;

Return the current Fast Infoset document handler.

getEntityResolver

Poco::XML::EntityResolver * getEntityResolver() const;

Return the current entity resolver.

getErrorHandler

Poco::XML::ErrorHandler * getErrorHandler() const;

Return the current error handler.

getFeature

bool getFeature(
    const Poco::XML::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.

getProperty

void * getProperty(
    const Poco::XML::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.

initialize

void initialize(
    FastInfosetWriter * pWriter
);

Initializes the handlers with the pWriter (incl ContentHandler, LexicalHandler, DTDHandler, FISDocumentHandler)

initialize

void initialize(
    Poco::XML::XMLWriter * pWriter
);

Initializes the handlers with the pWriter (incl ContentHandler, LexicalHandler, DTDHandler)

parse

void parse(
    Poco::XML::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.

parse

void parse(
    const Poco::XML::XMLString & systemId
);

Parse an XML document from a system identifier. See also parse(InputSource*).

parseMemoryNP virtual

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

See also: Poco::XML::XMLReader::parseMemoryNP()

setContentHandler

void setContentHandler(
    Poco::XML::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.

Instead of a Poco::XML::ContentHandler, an application can also register an instance of FISContentHandler to read encoded data (such as integers or floating point values) in their binary representation.

setDTDHandler

void setDTDHandler(
    Poco::XML::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.

setDocumentHandler

void setDocumentHandler(
    FISDocumentHandler * pDocumentHandler
);

Allow an application to register a Fast Infoset document handler.

The Fast Infoset document handler is used to work with access the vocabulary of a Fast Infoset document.

setEntityResolver

void setEntityResolver(
    Poco::XML::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.

setErrorHandler

void setErrorHandler(
    Poco::XML::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.

setFeature

void setFeature(
    const Poco::XML::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.

setProperty

void setProperty(
    const Poco::XML::XMLString & propertyId,
    const Poco::XML::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.

setProperty

void setProperty(
    const Poco::XML::XMLString & propertyId,
    void * value
);

Set the value of a property. See also setProperty(const XMLString&, const XMLString&).

vocabulary inline

const DocumentVocabulary & vocabulary() const;

Returns the vocabulary built up by the parser