blob: 9236ad1fb224da0e4ef9134bc6e5792f3bcc3dda (
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
|
/**
*
* 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.
*/
package org.apache.tuscany.samples.sdo.specCodeSnippets;
import java.io.InputStream;
import org.apache.tuscany.samples.sdo.SdoSampleConstants;
import org.apache.tuscany.sdo.util.SDOUtil;
import commonj.sdo.helper.XMLHelper;
import commonj.sdo.helper.XSDHelper;
import commonj.sdo.DataObject;
import commonj.sdo.DataGraph;
import commonj.sdo.Sequence;
/**
* Demonstrates a variety of methods available to obtain the root DataObject
* contained within an xml representation of a DataGraph. This is currently a grey
* area of the specification and this samples demonstrates spec compliant means, as
* well as utility methods that have been added to Tuscany to address issues within
* the specification.
*
* The following sample is from the <a href="http://incubator.apache.org/tuscany"
* target="_blank"> Apache Tuscany</a> project. It was written to help users
* understand and experiment with SDO. It is based upon example code contained
* within, and is meant for use with, and reference to the <a
* href="http://osoa.org/download/attachments/36/Java-SDO-Spec-v2.1.0-FINAL.pdf?version=1"
* target="_bank">SDO Specification</a>. This sample attempts to clarify aspects of
* the the AccessDataObjectsUsingXPath example from the Examples section of the SDO
* specification.<br>
* <br>
* To define the correct Types for each DataObject ( CompanyType, DepartmentType etc )
* this sample relies upon
* {@link org.apache.tuscany.samples.sdo.SdoSampleConstants#COMPANY_XSD} which is
* provided in the resources directory of these samples. The xml file
* {@link org.apache.tuscany.samples.sdo.SdoSampleConstants#COMPANY_DATAGRAPH_XML} is
* used to load the DataGraph and is also located in this resources directory. <br>
* <P>
* <b>Usage:</b> <br>
* This sample can easily be run from within Eclipse as a Java Application if tuscany or
* the sample-sdo project is imported into Eclipse as an existing project.
* <br><br>
* If executing as a standalone application please do the following:
* <br>
* <UL>
* <LI>Include the following jar files on your classpath :
* <UL>
* <LI>SDO API and Tuscany Implementation
* <UL>
* <LI>sdo-api-{version}.jar - SDO API
* <LI>tuscany-sdo-impl-{version}.jar - Tuscany SDO implementation
* </UL>
* </LI>
* <LI>EMF dependencies.
* <UL>
* <LI>emf-common-{version}.jar - some common framework utility and base classes
* <LI>emf-ecore-{version}.jar - the EMF core runtime implementation classes (the Ecore metamodel)
* <LI>emf-ecore-change-{version}.jar - the EMF change recorder and framework
* <LI>emf-ecore-xmi-{version}.jar - EMF's default XML (and XMI) serializer and loader
* <LI>xsd-{version}.jar - the XML Schema model
* </UL>
* </LI>
* </UL>
*
* These jar files can be obtained by downloading and unpacking a <a href="http://cwiki.apache.org/TUSCANY/sdo-downloads.html" target="_blank">Tuscany binary distribution</a> </LI>
* <LI>Execute: <br>
* java org.apache.tuscany.samples.sdo.specCodeSnippets.ObtainingDataGraphFromXml</LI>
* </UL>
*
* @see org.apache.tuscany.samples.sdo.specExampleSection.AccessDataObjectsUsingXPath
*/
public class ObtainingDataGraphFromXml {
/**
* Execute this method in order to run the sample.
*
* @param args
*/
public static void main(String[] args) {
System.out.println("***************************************");
System.out.println("SDO Sample ObtainingDataGraphFromXml");
System.out.println("***************************************");
System.out.println("Demonstrates a vareity of methods available to obtain the root DataObject"
+ " contained within an xml representation of a DataGraph.");
System.out.println("***************************************");
// define Types
try {
System.out.println("Defining Types using XSD");
InputStream is = null;
is = ClassLoader.getSystemResourceAsStream(SdoSampleConstants.COMPANY_XSD);
XSDHelper.INSTANCE.define(is, null);
is.close();
System.out.println("Type definition completed");
} catch (Exception e) {
System.out.println("Exception caught defining types " + e.toString());
e.printStackTrace();
}
try {
/**
* A DataGraph is an optional envelope for a graph of DataObjects and an
* associated ChangeSummary.
*
* The specification group is currently investigating options regarding
* obtaining a DataGraph from an xml file as well as the role of the
* DataGraph within the SDO specification.
*
* In order to obtain the rootObject contained within the specification
* the specification demonstrates reading in an XML file and obtaining a
* DataObject that represents the datagraph contained within the file.
* Note, that the specification does not obtain a DataGraph - there are
* not mechanisms within the specification for obtaining a DataGraph from
* xml. Obtaining the root DataObject from this datagraph representation
* is quite cumbersome and is demonstrated below.
*
* In order to address this current limitation within the specification
* Tuscany has added a utility method to SDOUtil that allows a user to
* obtain an actual DataGraph from xml.
*/
DataObject company = null;
/**
* Use specification mechanism for obtaining a DataObject that represents the datagraph
*/
System.out.println("Using specification methods to obtain DataObject represeenting a datagraph from xml");
// When the xml file represents a DataGraph the root Object
// of the XMLDocument is a DataGraph
DataObject dataObjectRepresentingDataGraph = XMLHelper.INSTANCE.load(
ClassLoader.getSystemResourceAsStream(SdoSampleConstants.COMPANY_DATAGRAPH_XML)).getRootObject();
// Obtain the company DataObject from the DataObject representing the datagraph
company = dataObjectRepresentingDataGraph.getDataObject("company");
System.out.println("Obtained DataObject representing datagraph");
System.out.println(dataObjectRepresentingDataGraph);
System.out.println("Obtained root DataObject from datagraph");
System.out.println(company);
System.out.println();
/**
* Use utility method to obtain an actual DataGraph from the xml
*/
DataGraph datagraph = SDOUtil.loadDataGraph(ClassLoader.getSystemResourceAsStream(SdoSampleConstants.COMPANY_DATAGRAPH_XML), null);
// Obtain the company DataObject from the actual DataGraph
company = datagraph.getRootObject();
System.out.println("Obtained actual DataGraph:");
System.out.println(datagraph);
System.out.println("Obtained root DataObject from DataGraph:");
System.out.println(company);
System.out.println();
} catch (Exception e) {
System.out.println("Sorry there was an error encountered " + e.toString());
e.printStackTrace();
}
System.out.println("GoodBye");
}
}
|
