summaryrefslogtreecommitdiffstats
path: root/sdo-java/tags/1.0-incubator-M3/sdo/sample/src/main/java/org/apache/tuscany/samples/sdo/overview.html
blob: 4cfd70f17fcd6381ff94da1f4facab2bc38c7929 (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
<html>
<!--
 *
 *  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.
 * -->
<head>
	<title>SDO Sample Overview</title>
</head>
<BODY>
<h1>Tuscany Service Data Object (SDO) Sample Programs</h1>  
<h2>Overview</h2>
This sample code is from the <a href="http://incubator.apache.org/tuscany"
 target="_blank"> Apache Tuscany</a> project. The samples were written to help users
understand and experiment with SDO. They are grouped into three packages according to the source of the example material. Some are based upon example code contained
within the <a
 href="http://osoa.org/display/Main/Service+Data+Objects+Specifications"
 target="_bank">SDO Specification</a>, and are intended to be read alongside the specification. Others are based upon papers and published material
 (see the documentation for each sample for the reference to the publication),
 or were simply written specifically for these samples.
<H2>Experimentation</H2>
The SDO samples are written to be used in conjunction with the specification and other documents.  However, 
the most important function that these samples provide is a place to begin experimenting with the SDO API
and programming model.  Developers are encouraged to extend and experiment with the current set of samples.  
If a sample is unclear, is missing documentation or a tutorial, or does not cover a desired area ,
please send feedback to the tuscany mailing lists,
or better still send us a patch or join the Tuscany team and contribute back to the
<A href="http://incubator.apache.org/tuscany">project</A>.
  

<h3>Getting Ready to run the Samples</h3>
The samples depend on the following libraries<UL>
		<LI>The SDO API and the Tuscany SDO Implementation
		<UL>
			<LI>sdo-api-{version}.jar - SDO API</LI>
			<LI>tuscany-sdo-impl-{version}.jar - Tuscany SDO implementation</LI>
		</UL>
		</LI>
		<LI>EMF dependencies.
		<UL>
			<LI>common-{version}.jar - some common framework utility and base
			classes</LI>
			<LI>ecore-{version}.jar - the EMF core runtime implementation
			classes (the Ecore metamodel)</LI>
			<LI>ecore-change-{version}.jar - the EMF change recorder and
			framework</LI>
			<LI>ecore-xmi-{version}.jar - EMF's default XML (and XMI)
			serializer and loader</LI>
			<LI>xsd-{version}.jar - the XML Schema model</LI></UL></LI></UL>
<P>If you are running these samples from a Tuscany samples distribution you can resolve these dependencies by ensuring that all the jar files in the lib directory of the extracted distribution are on your classpath.<BR>
<BR>
If you are running these samples as a result of building Tuscany SDO for Java from a Tuscany source distribution using maven then these dependencies will be resolved by having followed the build instructions.<BR>
<BR>To run these samples against the current Tuscany codebase, follow the instructions at <A
	href="http://cwiki.apache.org/TUSCANY/developing-sdo-java.html">Developing SDO Java</A>, which describes how to build Tuscany SDO for Java in an Eclipse SDK environment.</P>
<H3>Running the Samples</H3>
<P>In order to get an overview of the samples the user may wish to run
{@link org.apache.tuscany.samples.sdo.ExecuteSamples} which will execute
all the command line examples.<BR>
<FONT face="Courier">java org.apache.tuscany.samples.sdo.ExecuteSamples</FONT></P><P>Alternatively, browse the JavaDoc for the sample program classes and run an
individual example of your choice in the same way. Another suggestion is to read the
SDO specifciaton in conjunction with the examples in {@link
org.apache.tuscany.samples.sdo.specExampleSection}.</P></BODY></html>