summaryrefslogtreecommitdiffstats
path: root/sandbox/jboynes/sdo/sample/src/main/java/org/apache/tuscany/samples/sdo/specCodeSnippets/CreateDataObjectFromXsdAndXmlFiles.java
blob: 6f1d8c60db1a0a1110a21599af16dd90bdf62ab7 (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
/**
 *
 *  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 commonj.sdo.DataObject;
import commonj.sdo.helper.XMLDocument;
import commonj.sdo.helper.XMLHelper;
import commonj.sdo.helper.XSDHelper;


/**
 * Demonstrates defining Types by using a predefined xsd resource, and populating a DataObject by using a previously created xml file.
 * 
 * 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 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>. <br>
 * <br> 
 * <br>Uses {@link org.apache.tuscany.samples.sdo.SdoSampleConstants#PO_XSD_RESOURCE} and {@link org.apache.tuscany.samples.sdo.SdoSampleConstants#PO_XML_RESOURCE} in order to define purcahseOrder DataObjects
 * <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.specCodeSnippets.CreateDataObjectFromXsdAndXmlFiles</LI>
 * </UL>
 * 
 * @author Robbie Minshall
 */
public class CreateDataObjectFromXsdAndXmlFiles {

	public static boolean typesDefined = false;

    
  	/**
	 * Loads the {@link org.apache.tuscany.samples.sdo.SdoSampleConstants#PO_XSD_RESOURCE} resource in order to define PurchaseOrder
	 * Types 
	 */
	public static void definePurchaseOrderTypeUsingXsdResource()
			throws Exception {

		InputStream is = null;
		try {
			System.out.println("Attempting to define types using resource "
					+ SdoSampleConstants.PO_XSD_RESOURCE);
			is = ClassLoader.getSystemResourceAsStream(SdoSampleConstants.PO_XSD_RESOURCE);
			if (is == null) {
				System.out.println("InputStream is null, you may need to add the resources directory is on the classpath");
                throw new Exception("InputStream for " + SdoSampleConstants.PO_XSD_RESOURCE + " was null, ensure that it is located on the classpath");
			} else {
				System.out.println("Obtained Input Stream from resoruce");
			}
			XSDHelper.INSTANCE.define(is, null);

		} catch (Exception e) {
			System.out
					.println("Exception caught defining Types from resoruce stream to "
							+ SdoSampleConstants.PO_XSD_RESOURCE);
			throw e;
		} finally {
			// try to close the input stream
			if (is != null) {
				try {
					is.close();
					System.out.println("Closed input stream");
				} catch (Exception e) {	
					System.out.println("could not close input stream " + e.toString());
				}
			}
		}
	}

	/**
	 * Uses resource {@link org.apache.tuscany.samples.sdo.SdoSampleConstants#PO_XML_RESOURCE} to populate DataObject
	 * @return populated purchase order DataObject
	 */
	public static DataObject createPurchaseOrderDataObjectUsingXmlResource()
			throws Exception {

		if (! typesDefined){
			definePurchaseOrderTypeUsingXsdResource();
		}
		DataObject purchaseOrder = null;
		InputStream is = null;
		
		try {
			
			System.out
					.println("Using resource as stream to access xml to populate DataObjects");
			// FileInputStream fis = new FileInputStream(xmlFileName);
			is = ClassLoader.getSystemResourceAsStream(SdoSampleConstants.PO_XML_RESOURCE);
			if (is == null) {
				System.out.println("InputStream is null");
			} else {
				System.out
						.println("Successfully obtained InputStream from resource");
			}
			XMLDocument xmlDoc = XMLHelper.INSTANCE.load(is);
			purchaseOrder = xmlDoc.getRootObject();
			
		} catch (Exception e) {
			System.out.println("Could not use resourceAsStream "
					+ e.toString());
			e.printStackTrace();
			throw e;
		}finally {
			// try to close the input stream
			if (is != null) {
				try {
					is.close();
					System.out.println("Closed input stream");
				} catch (Exception e) {
					System.out.println("Could not close input stream " + e.toString());
				}
			}
		}

		return purchaseOrder;
	}

	/**
	 * @param args.  No arguments required
	 */
	public static void main(String[] args) {
		// information
		System.out.println("***************************************");
		System.out.println("SDO Sample CreateDataObjectFromXsdAndXmlFiles");
		System.out.println("***************************************");
		System.out.println("Demonstrates defining Types by using a predefined xsd resource, and populating a DataObject by using a previously created xml file");
		System.out.println("***************************************");
	

		try {
			// define the types
			definePurchaseOrderTypeUsingXsdResource();

			// create a dataObject
			DataObject purchaseOrder = createPurchaseOrderDataObjectUsingXmlResource();
			System.out.println("DataObject sucessfully created");
				
		} catch (Exception e) {
			System.out.println("Sorry there was an error encountered " + e.toString());			
		}
                System.out.println("GoodBye");
	}

}