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
|
/**
*
* 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.specExampleSection;
import java.io.InputStream;
import java.util.List;
import org.apache.tuscany.samples.sdo.SdoSampleConstants;
import commonj.sdo.helper.XMLHelper;
import commonj.sdo.helper.XSDHelper;
import commonj.sdo.DataObject;
/**
* Demonstrates accessing the properties of a DataObject using property indices.
*
* 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 experiement with SDO. It is based upon example code contained
* within, and is meant for use with, and reference to the <a
* href="http://www.osoa.org/download/attachments/791/SDO_Specification_Java_V2.01.pdf?version=1"
* target="_bank">SDO Specification</a>. In general this sample attempts to use the
* code and comments contained within the specification, exceptions to this are noted
* in comments.<br>
* <br>
* The following sample is based upon the 'Accessing DataObjects via Property Index'
* example from the Examples section of the SDO specification. It shows the use of
* DataObjects and the XMLHelper amd demonstrates accessing the properties of a
* DataObject using property indices. <br>
* <br>
* The following example has the same effect as
* {@link org.apache.tuscany.samples.sdo.specExampleSection.AccessDataObjectsUsingXPath}.
* The indexes for the properties are defined as constants in this class. <br>
* <br>
* This sample reads an xml file representing a DataObject of a company. In order to
* create a DataObject or DataGraph this sample relies upon XMLHelper class which is
* essentially example of a XML DAS implementation. The code shown here would work
* just as well against an equivalent DataObject that was provided by any DAS. <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 <br>
* The xml file
* {@link org.apache.tuscany.samples.sdo.SdoSampleConstants#COMPANY_DATAOBJECT_XML}
* used to load the DataObject is also located in this resources directory. To help
* ensure consistancy with the xsd the xml was generated by
* {@link org.apache.tuscany.samples.sdo.otherSources.CreateCompany} which is a good
* resource for populating DataObjects, or creating DataGraphs dynamically.
* <br><br>
* <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 from directly from Tuscany and EMF projects or from <a
* href="http://wiki.apache.org/ws-data/attachments/Tuscany(2f)TuscanyJava(2f)SDO_Java_Overview/attachments/SDO%20Execution%20Dependencies"
* target="_bank">SDO Execution Dependancies </a> </LI>
* <LI>Execute: <br>
* java org.apache.tuscany.samples.sdo.specExampleSection.AccessingDataObjectsViaPropertyIndex </LI>
* </UL>
*
* @author Robbie Minshall
*/
public class AccessingDataObjectsViaPropertyIndex {
/**
* Predefine the property indexes.
*
* Please note that these indices differ from those in the Examples section of
* the SDO 2.0 specification.
*
* Properties from Type.getDeclaredProperties() and therefore the properties
* obtained from a data object are in alphanumerical ordering of the xml schema
* complex type.
*
*/
private static final int COMPANY_DEPARTMENT = 0;
private static final int COMPANY_EMPLOYEE_OF_MONTH = 1;
private static final int COMPANY_NAME = 2;
private static final int DEPARTMENT_EMPLOYEES = 0;
private static final int EMPLOYEE_MANAGER = 0;
private static final int EMPLOYEE_NAME = 1;
private static final int EMPLOYEE_SN = 2;
/**
* 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 AccessingDataObjectsViaPropertyIndex");
System.out.println("***************************************");
System.out.println("Demonstrates accessing the properties of a DataObject using property indices.");
System.out.println("***************************************");
// TODO: what happens if not type is defined
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 {
/**
* In this example simply use a company DataObject read in from xml
*/
// For DataObjects
// Obtain the RootObject from the XMLDocument obtained from the XMLHelper
// instance.
// In this case the root object is a DataObject representing a company
DataObject company = XMLHelper.INSTANCE.load(ClassLoader.getSystemResourceAsStream(SdoSampleConstants.COMPANY_DATAOBJECT_XML))
.getRootObject();
// print out some information to show the user what the objects look like
System.out.println("Company DataObject:");
System.out.println(company);
String generatedXml = XMLHelper.INSTANCE.save(company, SdoSampleConstants.COMPANY_NAMESPACE, "company");
System.out.println("Company data object xml representation: ");
System.out.println(generatedXml);
System.out.println("Setting name of company to MegaCorp");
// Set the "name" property for the company
company.setString(COMPANY_NAME, "MegaCorp");
// Get the list of departments
List departments = company.getList(COMPANY_DEPARTMENT);
// Get the department at index 0 on the list
DataObject department = (DataObject) departments.get(0);
// Get the list of employees for the department
List employees = department.getList(DEPARTMENT_EMPLOYEES);
// Get the employee at index 1 on the list
DataObject employeeFromList = (DataObject) employees.get(2);
// remove the employee from the graph
System.out.println("Removing employee " + employeeFromList.getString("name") + " from list of employees");
employeeFromList.detach();
// create a new employee
System.out.println("Creating new employee (manager) Al Smith and adding to list");
DataObject newEmployee = department.createDataObject(DEPARTMENT_EMPLOYEES);
/**
* Properties from Type.getDeclaredProperties, or Type.getProperties
* should be in lexical (alphanumerical) ordering of the xml schema
* complex type.
*/
newEmployee.set(EMPLOYEE_NAME, "Al Smith");
newEmployee.set(EMPLOYEE_SN, "E0005");
newEmployee.setBoolean(EMPLOYEE_MANAGER, true);
System.out.println("setting employee of the month to new employee");
company.set(COMPANY_EMPLOYEE_OF_MONTH, newEmployee.get(EMPLOYEE_SN));
// print out some information to show the user what the objects look like
System.out.println("The modified company DataObject :");
System.out.println(company);
generatedXml = XMLHelper.INSTANCE.save(company, SdoSampleConstants.COMPANY_NAMESPACE, "company");
System.out.println("Company data object xml representation: ");
System.out.println(generatedXml);
} catch (Exception e) {
System.out.println("Sorry there was an error encountered " + e.toString());
e.printStackTrace();
}
System.out.println("GoodBye");
}
}
|
