summaryrefslogtreecommitdiff
path: root/examples/cxx/tree/streaming/README
blob: 5a467e02061957a644fe462061b776adeba73e9d (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
This example shows how to perform stream-oriented, partially in-memory
XML processing using the C++/Tree mapping. With the partially in-memory
parsing and serialization only a part of the object model is in memory at
any given time. With this approach we can process parts of the document
as they become available as well as handle documents that are too large
to fit into memory.

The example consists of the following files:

position.xsd
  XML Schema which describes a simple object position vocabulary. The
  position is represented as a potentially large series of latitude and
  longitude measurements.

position.xml
  Sample object position document.

position.hxx
position.cxx
  C++ types that represent the position vocabulary as well as parsing
  and serialization functions. These are generated by XSD from
  position.xsd.

parser.hxx
parser.cxx
  Stream-oriented DOM parser implementation that is built on top of the
  Xerces-C++ SAX2 parser in the progressive parsing mode. This parser
  allows us to parse an XML document as a series of DOM fragments.

serializer.hxx
serializer.cxx
  Stream-oriented DOM serializer implementation that allows us to
  serialize an XML Document as a series of object model fragments.

grammar-input-stream.hxx
grammar-input-stream.cxx
  Input stream implementation with the special-purpose schema grammar
  decompression algorithm. It is used internally by the streaming parser.

driver.cxx
  Driver for the example. It parses the input file into a series of DOM
  fragments which are then parsed into the object model fragments. The
  driver prints the information from the document as it becomes available.
  It also serializes the object model fragments into a new XML document
  (out.xml).

To run the example simply execute:

$ ./driver position.xml

The serialization results are written to the out.xml file.