Logo Search packages:      
Sourcecode: poco version File versions  Download package

XMLFilterImpl.h

//
// XMLFilterImpl.h
//
// $Id: //poco/1.2/XML/include/Poco/SAX/XMLFilterImpl.h#1 $
//
// Library: XML
// Package: SAX
// Module:  SAXFilters
//
// SAX2 XMLFilterImpl class.
//
// Copyright (c) 2004-2006, Applied Informatics Software Engineering GmbH.
// and Contributors.
//
// Permission is hereby granted, free of charge, to any person or organization
// obtaining a copy of the software and accompanying documentation covered by
// this license (the "Software") to use, reproduce, display, distribute,
// execute, and transmit the Software, and to prepare derivative works of the
// Software, and to permit third-parties to whom the Software is furnished to
// do so, all subject to the following:
// 
// The copyright notices in the Software and this entire statement, including
// the above license grant, this restriction and the following disclaimer,
// must be included in all copies of the Software, in whole or in part, and
// all derivative works of the Software, unless such copies or derivative
// works are solely in the form of machine-executable object code generated by
// a source language processor.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
// SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
// FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
//


#ifndef SAX_XMLFilterImpl_INCLUDED
#define SAX_XMLFilterImpl_INCLUDED


#include "Poco/XML/XML.h"
#include "Poco/SAX/XMLFilter.h"
#include "Poco/SAX/EntityResolver.h"
#include "Poco/SAX/DTDHandler.h"
#include "Poco/SAX/ContentHandler.h"
#include "Poco/SAX/ErrorHandler.h"


namespace Poco {
namespace XML {


00055 class XML_API XMLFilterImpl: public XMLFilter, public EntityResolver, public DTDHandler, public ContentHandler, public ErrorHandler
      /// Base class for deriving an XML filter.
      ///
      /// This class is designed to sit between an XMLReader and the client application's event 
      /// handlers. By default, it does nothing but pass requests up to the reader and events on to 
      /// the handlers unmodified, but subclasses can override specific methods to modify the event 
      /// stream or the configuration requests as they pass through.
{
public:
      XMLFilterImpl();
            /// Construct an empty XML filter, with no parent.
            ///
            /// This filter will have no parent: you must assign a parent before you start a parse or do any 
            /// configuration with setFeature or setProperty, unless you use this as a pure event consumer rather 
            /// than as an XMLReader.
            
      XMLFilterImpl(XMLReader* pParent);
            /// Construct an XML filter with the specified parent.
            
      ~XMLFilterImpl();
            /// Destroys the XMLFilterImpl.
      
      // XMLFilter
      XMLReader* getParent() const;
      void setParent(XMLReader* pParent);

      // XMLReader
      void setEntityResolver(EntityResolver* pResolver);
      EntityResolver* getEntityResolver() const;
      void setDTDHandler(DTDHandler* pDTDHandler);
      DTDHandler* getDTDHandler() const;
      void setContentHandler(ContentHandler* pContentHandler);
      ContentHandler* getContentHandler() const;
      void setErrorHandler(ErrorHandler* pErrorHandler);
      ErrorHandler* getErrorHandler() const;
      void setFeature(const XMLString& featureId, bool state);
      bool getFeature(const XMLString& featureId) const;
      void setProperty(const XMLString& propertyId, const XMLString& value);
      void setProperty(const XMLString& propertyId, void* value);
      void* getProperty(const XMLString& propertyId) const;
      void parse(InputSource* pSource);
      void parse(const XMLString& systemId);

      // EntityResolver
      InputSource* resolveEntity(const XMLString* publicId, const XMLString& systemId);
      void releaseInputSource(InputSource* pSource);
      
      // DTDHandler
      void notationDecl(const XMLString& name, const XMLString* publicId, const XMLString* systemId);
      void unparsedEntityDecl(const XMLString& name, const XMLString* publicId, const XMLString& systemId, const XMLString& notationName);

      // ContentHandler
      void setDocumentLocator(const Locator* loc);
      void startDocument();
      void endDocument();
      void startElement(const XMLString& uri, const XMLString& localName, const XMLString& qname, const Attributes& attrList);
      void endElement(const XMLString& uri, const XMLString& localName, const XMLString& qname);
      void characters(const XMLChar ch[], int start, int length);
      void ignorableWhitespace(const XMLChar ch[], int start, int length);
      void processingInstruction(const XMLString& target, const XMLString& data);
      void startPrefixMapping(const XMLString& prefix, const XMLString& uri);
      void endPrefixMapping(const XMLString& prefix);
      void skippedEntity(const XMLString& prefix);
      void warning(const SAXException& e);
      void error(const SAXException& e);
      void fatalError(const SAXException& e);

protected:
      XMLReader* parent() const;
            /// Return a pointer to the parent reader.
            /// Subclasses can use this method instead of
            /// getParent() for better performance - this method
            /// is non-virtual and implemented as inline.
      
      virtual void setupParse();
            /// Setup the event handlers in the parent reader.
      
private:
00133       XMLReader*      _pParent;
      EntityResolver* _pEntityResolver;
      DTDHandler*     _pDTDHandler;
      ContentHandler* _pContentHandler;
      ErrorHandler*   _pErrorHandler;
};


//
// inlines
//
inline XMLReader* XMLFilterImpl::parent() const
{
      return _pParent;
}


} } // namespace Poco::XML


#endif // SAX_XMLFilterImpl_INCLUDED

Generated by  Doxygen 1.6.0   Back to index