1 | // |
---|
2 | // XMLFilter.h |
---|
3 | // |
---|
4 | // $Id: //poco/1.3/XML/include/Poco/SAX/XMLFilter.h#1 $ |
---|
5 | // |
---|
6 | // Library: XML |
---|
7 | // Package: SAX |
---|
8 | // Module: SAXFilters |
---|
9 | // |
---|
10 | // SAX2 XMLFilter Interface. |
---|
11 | // |
---|
12 | // Copyright (c) 2004-2006, Applied Informatics Software Engineering GmbH. |
---|
13 | // and Contributors. |
---|
14 | // |
---|
15 | // Permission is hereby granted, free of charge, to any person or organization |
---|
16 | // obtaining a copy of the software and accompanying documentation covered by |
---|
17 | // this license (the "Software") to use, reproduce, display, distribute, |
---|
18 | // execute, and transmit the Software, and to prepare derivative works of the |
---|
19 | // Software, and to permit third-parties to whom the Software is furnished to |
---|
20 | // do so, all subject to the following: |
---|
21 | // |
---|
22 | // The copyright notices in the Software and this entire statement, including |
---|
23 | // the above license grant, this restriction and the following disclaimer, |
---|
24 | // must be included in all copies of the Software, in whole or in part, and |
---|
25 | // all derivative works of the Software, unless such copies or derivative |
---|
26 | // works are solely in the form of machine-executable object code generated by |
---|
27 | // a source language processor. |
---|
28 | // |
---|
29 | // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
---|
30 | // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
---|
31 | // FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT |
---|
32 | // SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE |
---|
33 | // FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, |
---|
34 | // ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER |
---|
35 | // DEALINGS IN THE SOFTWARE. |
---|
36 | // |
---|
37 | |
---|
38 | |
---|
39 | #ifndef SAX_XMLFilter_INCLUDED |
---|
40 | #define SAX_XMLFilter_INCLUDED |
---|
41 | |
---|
42 | |
---|
43 | #include "Poco/XML/XML.h" |
---|
44 | #include "Poco/SAX/XMLReader.h" |
---|
45 | |
---|
46 | |
---|
47 | namespace Poco { |
---|
48 | namespace XML { |
---|
49 | |
---|
50 | |
---|
51 | class XML_API XMLFilter: public XMLReader |
---|
52 | /// Interface for an XML filter. |
---|
53 | /// |
---|
54 | /// An XML filter is like an XML reader, except that it obtains its events from another XML reader |
---|
55 | /// rather than a primary source like an XML document or database. Filters can modify a stream of |
---|
56 | /// events as they pass on to the final application. |
---|
57 | /// |
---|
58 | /// The XMLFilterImpl helper class provides a convenient base for creating SAX2 filters, by passing on |
---|
59 | /// all EntityResolver, DTDHandler, ContentHandler and ErrorHandler events automatically. |
---|
60 | { |
---|
61 | public: |
---|
62 | virtual XMLReader* getParent() const = 0; |
---|
63 | /// Set the parent reader. |
---|
64 | /// |
---|
65 | /// This method allows the application to link the filter to a parent reader (which may be another |
---|
66 | /// filter). The argument may not be null. |
---|
67 | |
---|
68 | virtual void setParent(XMLReader* pParent) = 0; |
---|
69 | /// Get the parent reader. |
---|
70 | /// |
---|
71 | /// This method allows the application to query the parent reader (which may be another filter). |
---|
72 | /// It is generally a bad idea to perform any operations on the parent reader directly: they should |
---|
73 | /// all pass through this filter. |
---|
74 | |
---|
75 | protected: |
---|
76 | virtual ~XMLFilter(); |
---|
77 | }; |
---|
78 | |
---|
79 | |
---|
80 | } } // namespace Poco::XML |
---|
81 | |
---|
82 | |
---|
83 | #endif // SAX_XMLFilter_INCLUDED |
---|