summaryrefslogtreecommitdiff
path: root/xsd-examples/cxx/tree/order/element/README
diff options
context:
space:
mode:
Diffstat (limited to 'xsd-examples/cxx/tree/order/element/README')
-rw-r--r--xsd-examples/cxx/tree/order/element/README51
1 files changed, 51 insertions, 0 deletions
diff --git a/xsd-examples/cxx/tree/order/element/README b/xsd-examples/cxx/tree/order/element/README
new file mode 100644
index 0000000..bd6d0c9
--- /dev/null
+++ b/xsd-examples/cxx/tree/order/element/README
@@ -0,0 +1,51 @@
+This example shows how to use ordered types to capture and maintain
+element order, including element wildcards.
+
+The example consists of the following files:
+
+transactions.xsd
+ XML Schema which describes various bank transactions. A batch of
+ transactions can contain any number of different transactions in
+ any order but the order of transaction in the batch is significant.
+
+transactions.xml
+ Sample XML instance document.
+
+transactions.hxx
+transactions.cxx
+ C++ types that represent the given vocabulary as well as a set of
+ parsing and serialization functions.
+
+ These files are generated by the XSD compiler from transactions.xsd
+ using the following command line:
+
+ xsd cxx-tree --generate-serialization --generate-wildcard \
+ --ordered-type batch transactions.xsd
+
+ Note that the --ordered-type option is used to indicate to the XSD
+ compiler that the batch type is ordered. We also use the
+ --generate-wildcard option to enable wildcard support. An element
+ wildcard is used in the batch to allow transaction extensions.
+
+driver.cxx
+ Driver for the example. It first calls one of the parsing functions
+ that constructs the object model from the input XML file. It then
+ iterates over transactions in the batch using the content order
+ sequence. The driver then performs various modifications of the
+ object model while showing how to maintain the content order.
+ Finally, it saves the modified transaction batch back to XML to
+ verify that the content order is preserved in the output document.
+
+To compile and link the example manually from the command line we can use
+the following commands (replace 'c++' with your C++ compiler name):
+
+c++ -DXSD_CXX11 -c transactions.cxx
+c++ -DXSD_CXX11 -c driver.cxx
+c++ -o driver driver.o transactions.o -lxerces-c
+
+Note that we need to define the XSD_CXX11 preprocessor macro since the
+source code includes libxsd headers directly.
+
+To run the example on the sample XML instance document execute:
+
+./driver transactions.xml