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
|
/**
*
* 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.util.List;
import org.apache.tuscany.samples.sdo.SdoSampleConstants;
import commonj.sdo.DataObject;
import commonj.sdo.Property;
import commonj.sdo.Type;
import commonj.sdo.helper.XMLHelper;
import commonj.sdo.helper.XSDHelper;
/**
* Demonstrates iterating through, and inspecting properites of a DataObject. This
* sample shows listing properties of a dataObject, determining if the properties are
* set, are simple properties or represent DataObjects <br>
* <br>
* This 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 code snippets 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>. This specific examples was based upon code
* snippets in the section titled 'Property Indexes'. <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.specCodeSnippets.PrintPropertiesOfDataObject</LI>
* </UL>
*
* @author Robbie Minshall
*/
public class PrintPropertiesOfDataObject {
/**
* Calls recursive method to inspect and print properties of a DataObject.
*
* @param DataObject.
* The DataObject to print the properties of
*/
public static void printDataObjectProperties(DataObject myDo) throws Exception {
System.out.println("Recursivly inspecting and printing properties of DataObject");
printAndInspectDataObject(" ", myDo);
}
/**
* Recursivly inspects and prints DataObject. This method will list all set
* properties
*
* @param buffer.
* Blank string to help with formating
* @param myDo.
* DataObject to recursivly inspect and print the properties of.
* @throws Exception
*/
private static void printAndInspectDataObject(String buffer, DataObject myDo) throws Exception {
for (int i = 0; i < myDo.getInstanceProperties().size(); i++) {
Property p = (Property) myDo.getInstanceProperties().get(i);
// just print out the name, type and string value of the property
Type type = p.getType();
System.out.print(buffer + " " + p.getName() + ",type=" + type.getName());
if (myDo.isSet(p)) {
// see if this represents a simple property or if the type is also a
// datatype
if (type.isDataType()) {
System.out.println(", simple type : " + myDo.get(i));
} else {
// check to see if the property has many values
if (p.isMany()) {
System.out.println(buffer + ", many valued with list of DataObjects : ");
List dataObjects = myDo.getList(p);
for (int x = 0; x < dataObjects.size(); x++) {
printAndInspectDataObject(buffer + " ", (DataObject) dataObjects.get(x));
System.out.println();
}
} else {
System.out.println(buffer + ", data object : ");
DataObject newDataObject = myDo.getDataObject(p);
printAndInspectDataObject(buffer + " ", newDataObject);
System.out.println("");
}
}
} else {
System.out.println(buffer + ", is not set");
}
}
}
/**
* @param args.
* none required.
*/
public static void main(String[] args) {
// information
System.out.println("***************************************");
System.out.println("SDO Sample InspectAndPrintPropertiesOfDataObject");
System.out.println("***************************************");
System.out.println("Demonstrates a common pattern of looping through and inspecting the META-DATA for all instance properties."
+ "This example uses recursion to iterate through properties which themselves are DataObjects.");
System.out.println("***************************************");
// create a DataObejct
DataObject purchaseOrder = null;
try {
XSDHelper.INSTANCE.define(ClassLoader.getSystemResourceAsStream(SdoSampleConstants.PO_XSD_RESOURCE), null);
purchaseOrder = XMLHelper.INSTANCE.load(ClassLoader.getSystemResourceAsStream(SdoSampleConstants.PO_XML_RESOURCE)).getRootObject();
System.out.println("DataObject created");
} catch (Exception e) {
System.out.println("Error creating DataObject " + e.toString());
e.printStackTrace();
return;
}
//print and inspect properties of the DataObject
try {
System.out.println("Will iterate and inspect the properties of the following data object " + purchaseOrder.toString());
printDataObjectProperties(purchaseOrder);
} catch (Exception e) {
System.out.println("Sorry, an error was encountered inspecting DataObject " + e.toString());
}
System.out.println("GoodBye");
}
}
|
