summaryrefslogtreecommitdiff
path: root/ACE/ACEXML/common/XMLFilter.h
blob: c012ee706e2538b474fb0705a313904efb10f85e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
// -*- C++ -*-

//=============================================================================
/**
 *  @file    XMLFilter.h
 *
 *  $Id$
 *
 *  @author Nanbor Wang <nanbor@cs.wustl.edu>
 */
//=============================================================================
#ifndef _ACEXML_XMLFILTER_H_
#define _ACEXML_XMLFILTER_H_

#include /**/ "ace/pre.h"
#include "ACEXML/common/ACEXML_Export.h"

#if !defined (ACE_LACKS_PRAGMA_ONCE)
#pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */

#include "ACEXML/common/XMLReader.h"

/**
 * @class ACEXML_XMLFilter XMLFilter.h "ACEXML/common/XMLFilter.h"
 *
 * @brief ACEXML_XMLFilter
 *
 * An XML filter is like an XML reader, except that it obtains its events
 * from another XML reader rather than a primary source like an XML
 * document or database. Filters can modify a stream of events as they pass
 * on to the final application.
 *
 * The XMLFilterImpl helper class provides a convenient base for creating
 * SAX2 filters, by passing on all ACEXML_EntityResolver,
 * ACEXML_DTDHandler, ACEXML_ContentHandler and ACEXML_ErrorHandler events
 * automatically.
 */
class ACEXML_Export ACEXML_XMLFilter : public ACEXML_XMLReader
{
public:
  /**
   * Get the parent reader.
   */
  virtual ACEXML_XMLReader *getParent (void) const = 0;

  /**
   * Set the parent reader.
   */
  virtual void setParent (ACEXML_XMLReader *parent) = 0;
};


#include /**/ "ace/post.h"

#endif /* _ACEXML_XMLFILTER_H_ */