summaryrefslogtreecommitdiffstats
path: root/cpp/sdo/samples/GettingStarted.html
blob: 0223e05c7dd880b314ca11982afe8e858af9a74b (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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 
<!--
   Licensed to the Apache Software Foundation (ASF) under one
   or more contributor license agreements.  See the NOTICE file
   distributed with this work for additional information
   regarding copyright ownership.  The ASF licenses this file
   to you under the Apache License, Version 2.0 (the
   "License"); you may not use this file except in compliance
   with the License.  You may obtain a copy of the License at
   
     http://www.apache.org/licenses/LICENSE-2.0
     
   Unless required by applicable law or agreed to in writing,
   software distributed under the License is distributed on an
   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
   KIND, either express or implied.  See the License for the
   specific language governing permissions and limitations
   under the License.
-->

<HTML>
<HEAD>
   <META CONTENT="text/html; charset=iso-8859-1" HTTP-EQUIV="Content-Type">
   <META CONTENT="text/css" HTTP-EQUIV="Content-Style-Type">
   <STYLE MEDIA="all" TYPE="text/css">
@import url("../doc/css/maven-base.css");
@import url("../doc/css/maven-theme.css");
   </STYLE> 

    <LINK HREF="../doc/css/maven-theme.css" MEDIA="print" REL="stylesheet"
         TYPE="text/css">
   <TITLE>Tuscany SDO C++ Samples - Getting Started</TITLE>
</HEAD>

<BODY>
<DIV ID="bodyColumn"> 
   <DIV ID="contentBox"> 
      <DIV CLASS="section"> 
         <H1>Tuscany Samples - Getting Started - SDO C++ Milestone release 3</H1> 

         <P>Tuscany SDO C++ includes some simple technology samples that demonstrate some of the basic sceanrios for C++ SDO. 
            This page describes the samples and what is needed to install and run them.
         </P>
          <UL>              
             <LI>The ObjectCreation sample demonstrates building the metadata programmatically, followed by use 
                of the metadata to instantiate objects in a graph.
             </LI>
             <LI>The XSDLoading sample shows how to load metadata from an XSD, and how to check for errors during 
                parsing. The parser gathers all non-fatal errors into one list, so all errors can be checked at one
                time after parsing. Elements which contained errors will have been omitted from the resulting metadata.
             </LI>
             <LI>The ChangeSummarySave sample modifies a data graph of employees, and saves the modified graph with
                its change summary. The output in ChangeSummarySave-output.xml shows the summary and its relationship 
                by references to the data graph.
             </LI>
             <LI>The Substitutes sample shows how to use substitites in XSD  to achieve a property which will accept a 
                range of types.
             </LI>
             <LI>The Query sample shows how to use XPath to navigate within a graph to the required element. Note 
                that exceptions such as "path not found" may well be thrown if the XPath specified does not lead to
                a real object in the graph.
             </LI>
          </UL>
         <P>The SDO samples are built together into a single executable called sdo_misc.exe on Windows and sdo_misc on Linux
         </P>
      </DIV>

      <DIV CLASS="section"> 
         <H2>Contents</H2> 
         <OL>
            <LI><A HREF="#linuxbld">Building the samples on Linux or Mac OS X</A></LI>
            <!--LI><A HREF="#linuxbldstdcxx">Building the samples on Linux with Apache STDCXX</A></LI-->
            <LI><A HREF="#linuxrun">Running the samples on Linux or Mac OS X</A></LI>
            <LI><A HREF="#winbld">Building the samples on Windows</A></LI>
            <LI><A HREF="#winbldstdcxx">Building the samples on Windows with Apache STDCXX</A></LI>
            <LI><A HREF="#winrun">Running the samples on Windows</A></LI>
         </OL>
      </DIV>


       <DIV CLASS="section"> 
         <A NAME="linuxbld"><H2>Building the samples on Linux or Mac OS X</H2></A>
         <OL>
             <LI>The following environment variables are required:                                 
                <UL>
                  <LI>TUSCANY_SDOCPP=&lt;path to installed Tuscany SDO&gt;</LI>
                </UL></LI>
             </LI>
             <LI>Build the source with the following command sequence:
                  <UL>
                      <LI>cd &lt;tuscany_sdo_install_dir&gt;/samples</LI>
                      <LI>./configure --prefix=&lt;tuscany_sdo_install_dir&gt;/deploy --enable-static=no</LI>
                      <LI>make</LI>
                      <LI>make install</LI>
                  </UL>
	              NOTE: If you don't provide a --prefix configure option, it will by default install into
                  /usr/local/tuscany/sdo/samples/misc</LI>
         </OL>
         <p>
         A script, <b>build.sh</b>, is provided that will build and deploy the SDO for C++ samples to $TUSCANY_SCACPP/samples.
                                                           
        </DIV>

       <!--DIV CLASS="section"> 
         <A NAME="linuxbldstdcxx"><H2>Building the samples on Linux with Apache STDCXX</H2></A>
         <OL>
             <LI>The following environment variables are required:                                 
                <UL>
                  <LI>TUSCANY_SDOCPP=&lt;path to installed Tuscany SDO&gt;                                      
                  <LI>AXIS2C_HOME=&lt;path to axis2c version 0.94&gt;</LI>
                </UL></LI>
             </LI>
             <LI>Build the source with the following command sequence:
                  <UL>
                      <LI>cd &lt;tuscany_sdo_install_dir&gt;/samples</LI>
                      <LI>./configure</LI>
                      <LI>make</LI>
                      <LI>make install</LI>
                  </UL>
	              NOTE: If you don't provide a --prefix configure option, it will by default install into
                  /usr/local/tuscany/sdo/samples/misc</LI>
         </OL>                                                  
        </DIV-->

       <DIV CLASS="section"> 
         <A NAME="linuxrun"><H2>Running the samples on Linux or Mac OS X</H2></A>
         <OL>
             <LI>Ensure that &lt;tuscany_sdo_install_dir&gt;/lib is included in the LD_LIBRARY_PATH environment variable
             </LI>
             <LI>Run the sample with the following commands:
                <UL>
                   <LI>cd &lt;tuscany_sdo_install_dir&gt;/samples/misc/deploy</LI>
                   <LI>./bin/sdo_misc</LI>
                </UL>
             </LI>
         </OL>                                                  
        </DIV>

        <DIV CLASS="section">
         <A NAME="winbld"><H2>Building the samples on Windows</H2></A>
         <P>If using the binary distribution the samples are built and installed in
            &lt;tuscany_sdo_install_dir&gt;/samples - go directly to <A HREF="#winrun">Running the samples on Windows</A>.</P>
         <OL>
             <LI>The following environment variables are required:                                 
                <UL>
                  <LI>TUSCANY_SDOCPP=&lt;path to installed Tuscany SDO&gt;</LI>
                </UL></LI>
             </LI>
             <LI>You must have set up the environment for Microsoft Visual Studio Express C++ tools.
                 The build command will call vcvars32 to set the environment. Ensure the 
                 directory containing this is on your path. This will be where you 
                 installed the compiler.
             </LI>
             <LI>Build the source, either via the Visual Studio Express projects under 
                 &lt;tuscany_sdo_install_dir&gt;\samples\misc\VSExpress or via the command-line build file
                 found at &lt;tuscany_sdo_install_dir&gt;\samples\misc\build.bat
                 which will build and deploy the sample.
             </LI>
         </OL>                                                  
        </DIV>

         <DIV CLASS="section">
         <A NAME="winbldstdcxx"><H2>Building the samples on Windows with Apache STDCXX</H2></A>
          <P>STDCXX is an implementation of the C++ Standard Library provided by Apache.
             The website is at <A HREF="http://incubator.apache.org/stdcxx/">http://incubator.apache.org/stdcxx/</A>.
          </P>
          <P>You must begin by downloading and building STDCXX as described <A HREF="../doc/BuildingSTDCXX.html">here</A>
          </P>
          <P>STDCXX is supported only when used with Microsoft Visual Studio C++ V7.1. Launch the 
             MSVC++ 7.1 studio by opening the file 
             &lt;tuscany_sdo_install_dir&gt;samples\ides\devstudio7\projects\misc\misc.sln
          </P>
          <P>The sdo_misc project includes build configurations that
             use STDCXX. There are several ways to access the build configurations, and all
             are equally effective. As an example, open the Property pages for sdo_misc by
             right clicking on sdo_misc in the Solution Explorer pane and selecting
             Properties. The Configuration property in the top left corner of the pane is a
             drop down box offering four options: Debug, Release, stdcxx-Debug,
             stdcxx-Release. Choose the one you want and then launch the build.
          </P>
          <P>All components that are linked (by the linker) must all use the same C++
             Standard library. Therefore, if either sdo_misc or sdo_runtime are built with
             STDCXX then both must be.
          </P>                                                  
        </DIV>

       <DIV CLASS="section"> 
         <A NAME="winrun"><H2>Running the samples on Windows</H2></A>
         <OL>
             <LI>Ensure that &lt;tuscany_sdo_install_dir&gt;\bin is included in the PATH environment variable
             </LI>
             <LI>Run the sample with the following commands:
                <UL>
                   <LI>cd &lt;tuscany_sdo_install_dir&gt;/samples/misc/deploy</LI>
                   <LI>bin\sdo_misc</LI>
                </UL>
             </LI>
         </OL>                                                  
      </DIV>

              
      <DIV CLASS="section"> 
         <A NAME="help"><H2>Getting Help</H2></A>

         <P>First place to look is at the Tuscany FAQ at 
         <A HREF="http://cwiki.apache.org/TUSCANY/tuscany-sdo-faq.html"
            TARGET="_blank">http://cwiki.apache.org/TUSCANY/tuscany-sdo-faq.html</A> </P>

         <P>Any problem with this release can be reported to the Tuscany 
         <A HREF="http://cwiki.apache.org/TUSCANY/mailing-lists.html"
            TARGET="_blank">mailing lists</A> or create a JIRA issue at&nbsp;<A HREF="http://issues.apache.org/jira/browse/Tuscany"
                                                                                TARGET="_blank">http://issues.apache.org/jira/browse/Tuscany</A>.</P>
         

         <P>&nbsp;</P> 

         <P>&nbsp;</P> 

         <P>&nbsp;</P> 
         <TABLE CLASS="bodyTable">
            <TBODY>
            <TR CLASS="a">
               <TD> 

                  <P>Thank you for your interest in Tuscany.</P> <STRONG><EM>-The
                  Tuscany Development Team</EM></STRONG> 
               </TD>
            </TR>
            </TBODY>
         </TABLE>
      </DIV>
   </DIV>
</DIV>
</BODY>

</HTML>