Establishing a Development Environment

There are two well established development environments that the SDO community use, Maven and Eclipse. To use the Eclipse IDE you must first establish a maven environment.

Getting Setup for Development (prerequisites)

Download the following:

• JDK 5.0+ (J2SE 1.5.0+)
• Apache Maven (2.0.4+)
• Subversion (1.2+)

Setting up for Maven Development

• Get your source tree set up locally
• Ensure that maven (mvn) is on your execution path
• Ensure that you have network connectivity (Maven has the capacity to retrieve dependencies from the internet while executing a build instruction)
• In a shell or command prompt ensure that you are in the <sdo-source-root>/spec/sdo-api directory
• Issue the command "mvn", this will build the SDO API interface source code, run any tests, package the class files in a jar and install the jar in a repository on your computer where it will be available for other maven projects which depend on it
• Change directory to <sdo-source-root>/sdo
• execute the "mvn" command, this will build and test the SDO implementation, Tools and Plugin projects, and will install artefacts into you local maven repository
• You can now use the tools of your choice to explore, use and modify the SDO source code. If you have extracted your source tree using SVN you will be able to submit patches arising from your modifications to the SDO project by attaching patch files to JIRAs.

Setting up for Eclipse Development

Follow the instructions above for setting up a maven development environment
Having ensured you have network access to the internet, in each of the following directories

1. spec/sdo-api
2. sdo/impl
3. sdo/tools
   (Note: experienced eclipse users may want to select just a subset of these projects)

execute the command mvn -Peclipse eclipse:eclipse

Then

• Start up eclipse
• Switch to the Java perspective
• Execute "File => Import ... => General => Existing project into workspace
• Click "Browse ..." Navigate to the spec/sdo-api directory and click OK
• Select the sdo-api project and click OK
• After Eclipse has built the project you will see that there are compile errors. This is because Maven has created build dependencies for the project on the contents of your maven repository, but Eclipse doesn't yet know where that repository is. You must create and assign a value to the M2_REPO variable within eclipse to resolve these dependencies
  • Right click in the Package Explorer frame on the root of the newly created project and select Properties => Java Build Path
  • Click on the "Libraries" tab and select "Add Variable...", "Configure Variables ...", "New ..."
  • Set Name to M2_REPO and Click on "Folder..."
  • Navigate to the "repository" folder/directory (on Windows this is \Documents and Settings\<user>\.m2\repository, on Linux it is ~/.m2/repository) and click OK
  • Accept the request for doing a full rebuild
  • Cancel away from the "Configure Variables" dialog
  • Click "OK" on the Project Properties Window
  • When building is complete the project should now have no errors

Now repeat the same instructions for importing the sdo-impl and sdo-tools projects into the eclipse environment. You aklready have the M2_REPO variable defined now, so these projects should build OK.

At this point you have three separate projects each dependent on binary artifacts in your maven repository. Don't be tricked into thinking that
if you modify the sdo-impl project, that those changes will be picked up by the sdo-tools project. If you want this behaviour then follow these steps

• In the package exlporer pane of the Java perspective, Right Click on Properties and select the libraries tab
• Select the M2_REPO/commonj/sdo-api* library entry and click "remove"
• Select the Projects tab and click "Add..."
• Select the SDO API project and click OK
• If you plan to work in the tools project
  • Select the "Order and Export" tab and select the sdo-api project and click OK (this means that the sdo-impl project will expose the interfaces of the sdo-api project, so that you don't have to import them into projects which depend on the sdo-impl project)
  • Repeat the above instructions, removing the sdo-api and sdo-impl library dependencies from the tools project, and adding a project dependency for the sdo-tools project on the sdo-impl project

Digging into EMF

With EMF being such an integral part of SDO development, its often necessary to debug into the EMF code to understand what's going on. To do this you need to download an EMF SDK (runtimes, source, docs) for EMF, SDO and XSD (Don't be confused by the presence of SDO; the version 1 API used to be developed at Eclipse, and it is this that is being downloaded, you can safely ignore it). You'll need the corresponding EMF version to the Tuscany SDO source code (Currently EMF 2.2.2 as at March 2007). Take a look for the <emfVersion> tag in the sdo/pom.xml file to discover the current version dependency. Extract the downloaded archive to somewhere on your computer.

• When eclipse opens up a .class file and presents you with an "Attach Source..." button, click it and the click "Variable ...", "New..."
• Create a variable, e.g. EMF_SRC and set the value to a folder within your extracted EMF archive, e.g. C:/Development/downloads/emf-sdo-xsd-SDK-2.2.2/eclipse/plugins
• Click OK to close the "Variable Selection" dialog
• In the "Source Attachment Configuration" Dialog, click "Extension ..."
• Navigate to the src.zip file corresponding to the class you are interested in. This will take a little bit of thought. Look at the package name for the class you are interested in and navigate to a zip file that would seem to correspond to that class, e.g. org.eclipse.emf.source_2.2.2.v200702131851/src/org.eclipse.emf.ecore_2.2.2.v200702131851/src.zip
• You should now be able to set breakpoints and observe execution behaviour of the EMF code in the eclipse debugger