Starting with SMART 3.2 these instructions are no longer valid. See E4 Development Environment Setup for SMART 3.2 and later.

Prerequisites

The following items must be installed prior to setting up the SMART development environment.

Java

Java 1.6 must be installed
the %JAVA_HOME% variable setup

If installed as required java -version should report version 1.6

 >>java -version

java version "1.6.0_22"

Java(TM) SE Runtime Environment (build 1.6.0_22-b04)

Java HotSpot(TM) Client VM (build 17.1-b03, mixed mode, sharing)

Maven

Download and install maven from:

http://maven.apache.org/download.html
Version 3.0.4 as time of writing

If installed correctly mvn -version should report the version installed.

>>mvn -version
Apache Maven 3.0.4 (r1232337; 2012-01-17 00:44:56-0800)
Maven home: C:\Program Files\apache-maven-3.0.4\bin\..
Java version: 1.6.0_23, vendor: Sun Microsystems Inc.
Java home: C:\java\jre1.6.0_23
Default locale: en_US, platform encoding: Cp1252
OS name: "windows xp", version: "5.1", arch: "x86", family: "windows"

Subversion

Get your favorite subversion client. (TortoiseSVN, SubEclipse etc.)

Git

If you are going to be doing anything with uDig you also need Git.

Eclipse

Note: The following instructions were modelled after uDig instructions. See
http://udig.refractions.net/confluence/display/ADMIN/02+Development+Environment

Downloads - The following downloads are required for the Eclipse install

(see http://udig.refractions.net/confluence/display/DEV/How+To+Turn+Stuff+Of+2+-+Equinox+Transforms for why these two jars are used).

Install - The following instructions describe how to install Eclipse

Unzip Eclipse download (from Step 1 above) to the desired folder
- ...DevelopmentEnvrionment\Eclipse\
Unzip and add the DropIns download (from Step 2 above) to the dropins folder in the eclipse folder
- ...DevelopmentEnvrionment\Eclipse\dropins\
Unzip the uDig Delta-Pack download (from Step 3 above) and place this in a Target\eclipse folder next to the Eclipse folder
- ...DevelopmentEnvrionment\Target\eclipse <- not inside the DevelopmentEnvironment\Eclipse folder.
Put the downloaded JRE (from Step 4) in the Eclipse folder
- ...DevelopmentEnvrionment\Eclipse\jre\
Put the two downloaded equinox jars (from Step 5) into the eclipse plugin folder
- ...DevelopmentEnvrionment\Eclipse\plugins\

Start Eclipse and Create a new Workspace

Run Eclipse, when prompted create a "smart" workspace

Additional Eclipse Tools - These are additional eclipse tools you can install from within Eclipse. Many of these are optional, but not all.

Under 'Help -> Install New Software' you may choose to install.

REQUIRED: GMF Runtime SDK - required for uDig to build (provides batik libraries)

Provided under the Indigo Update Site (under modelling)

REQUIRED: BIRT - Business Intelligence, Reporting and Charting

Provided under the Indigo Update Site
Need "BIRT Framework"
Also need "Eclipse BIRT Documentation" (if building app)

OPTIONAL: JAXB

Dali Java Persistence Tools
Used for XML support

OPTIONAL: ER Master (used for database modelling)

only required if you are going to view or change the database model
http://ermaster.sourceforge.net/update-site/

OPTIONAL: Windows Builder
- I used this when starting to work with swt to figure out how be design layout, however now I find it easier just to code them

http://www.eclipse.org/windowbuilder/

http://download.eclipse.org/windowbuilder/WB/release/R201109201200/3.7/

OPTIONAL: Find Bugs
- not required for build; but good tool for finding bugs
- http://findbugs.cs.umd.edu/eclipse

OPTIONAL: JAVA CC Compiler tool

http://eclipse-javacc.sourceforge.net/
used for query compiling

Eclipse Properties - Once installed you will need to setup some Eclipse properties

M2_REPO variable
1. Under the "Windows -> Properties" menu
2. Find "Java -> Build Path -> Classpath Variables"
3. Add a new M2_REPO variable that points to your m2 repository. See Maven for more information on the m2 repository. Generally on windows it is found in the user folder.
  - For example: C:\Users\<YourUserName>\.m2
Target Platform
1. Under the "Windows -> Properties" menu
2. Find "Java -> Plug-in Development -> Target Platform"
3. Pick 'Add'
4. Pick 'Default: Default target for the running platform'
5. In the Target Content dialog under the locations tab click 'Add'
6. Pick "Directory"
7. Location: pick the "Target\eclipse\" directory you created above (...DevelopmentEnvrionment\Target\Eclipse ) - This is where you put the deltapack. If you did not download the deltapack you can skip this step.
8. Pick 'Finish'
9. Back in the Target Content dialog, set the Name to "SMART Target" and select the checkmark next to the New Target.
10. Hit finish and make sure the newly created platform is used

Setting Up Workspace

1. Check Out Required Source Code

(a) Check out SMART Source code from SVN (you will need assembla account that is not linked with google).

(b) Check out uDig Source code from GIT.

WARNING: uDig is currently relocating to locationtech.  As a result the uDig code base is in flux as they modify items to meet the new locationtech requirements.  For the purposes of SMART I have created a branch of uDig for the SMART development.  

The branch can be accessed here:
https://github.com/egouge/udig-platform/tree/smart
You need to checkout this source code for SMART to build correctly.

3.0 and previous builds were built against this tag: 
https://github.com/egouge/udig-platform/tree/SMART_1.1.0 
The smart branch contains some code improvements that are used in future builds but should not effect SMART builds (not api changes).


More information on setting up uDig can be found on this page.  However due to the relocation this information may not longer be accurate. http://udig.refractions.net/confluence/display/ADMIN/02+Development+Environment

2. Download additional required libraries - here we use maven to download additional uDig and SMART requirements.

(a) From the command line, navigate to the source/java folder in your SMART checkout and run mvn install

> cd C:\SMART\svn\trunk\source\java
> mvn install

(b) Do the same thing for uDig. Navigate to the plugins/net.refractions.udig.libs folder and run mvn install -f pom-libs.xml

> cd C:\SMART\uDig\udig-platform\plugins\net.refractions.udig.libs
> mvn install -f pom-libs.xml

3. Setup Eclipse

(a) Run eclipse and open your SMART workspace

(b) Turn off automatic builds 'Project -> Build Automatically' (we do this initially so eclipse isn't always building projects as we set it up; we should turn this back on when done setting up eclipse).

(c) In Eclipse create two new working sets: SMART and uDIG (in Package Explorer view click the down arrow in the upper right corner and pick 'Configure Working Sets'

(d) Import SMART source.

i) 'File -> Import',

ii) 'General -> Existing Projects into Workspace'

iii) Select the source/java folder from the SMART svn checkout and pick all projects in this directory. Under the 'Working Sets' option pick 'SMART'.

This will import all smart projects. It will is not necessary to import the translation projects (for i18n); or the extension projects (cybertracker etc). If you wish you can unselect those projects. Unless you are implementing translations/language packs I suggest you don't import the translations as they make eclipse slower.

(e) Import uDig source

i) 'File -> Import',

ii) 'General -> Existing Projects into Workspace'

iii) Select the uDig directory you have checked out from git and pick all projects in this directory. Under the 'Working Sets' option pick 'uDig'

(f). Build uDig

i) manually build the net.refractions.udig.libs project (Project -> Build Project)

(If you have build memory errors, you can edit the .../Eclipse/eclipse.ini file and increase the max and starting memory for eclipse, then restart eclipse)

(g) If net.refractions.udig.libs.project builts correctly, then turn back on automatic builds (Project -> Build Automatically).

This should build all plugins.

Note: The net.refractions.udig.project.ui.editor udig plugin will not build - this is not a problem for us. In addition you might see some other uDig plugin that don't build. Generally if the net.refractions.udig.libs project and *most* of the other udig projects build you will not have problems. If some of the core udig plugins don't build you might have problems building the SMART plugins.

ALL SMART plugins should build.

Getting everything to build correctly is by far the most difficult part of setting up your development environment. Errors need to be dealt with on an individual basis - look at the error and see if you can resolve it.

4. Create SMART Launch configuration

(h) Run SMART. In org.wcs.smart open smart.product file and select 'Run As -> Eclipse application'

The first time you run it you will get a "No SMART database exists. The application needs to be re-installed or the database restored manually error". To fix this you will need to configure the run configurations.

i) open the Run Configurations 'Run -> Run Configurations'

Databsae Configuration:

ii) In the arguments tab (at the bottom) for the 'Working directory' select 'Other', then 'Workspace', then and pick the 'org.wcs.smart' workspace. The value populated in the Other dialog should look similar to "${workspace_loc:org.wcs.smart}"

iii) you will need to place a SMART filestore in a data folder org.wcs.smart project. The filestore is a data directory that consists of database and filestore directories. The database folder needs to contain a smartdb subfolder.

So you will have the following folders:
org.wcs.smart/data 
org.wcs.smart/data/database
org.wcs.smart/data/database/smartdb
org.wcs.smart/data/filestore

You have a couple options for acquiring a SMART database: you can download the latest smart release and copy the data folder (this will contain everything you need) OR you can use the utility functions (described below - Building org.wcs.smart.util) to create a new empty database - this will only create the smartdb directory (you will need to create the data folder).

Additional Configuration:

iv) To make use of the equinox transforms to remove unneccesary uDig functionality in the 'Configuration' tab:

* click the 'Clear the configuration area before launching' option

* Under the 'Configuration File' section; select 'Use an existing config.ini file as a template' and place the following in the Location text box : "${workspace_loc:org.wcs.smart/configuration/config.ini}"

You can also run additional SMART-plugins in your development environment by selecting the plug-ins tab in teh run configuration and checking off whichever ones you want, 'org.wcs.smart.plan' for example.

Additional configurations for JAXB or potentially other developer tools

You will need to configure and use a JDK for the JAXB tools to work:

Go to "Window -> Preferences", "Java -> Installed JREs " => "Add.."
Then point it at a JDK directory of 1.6 or higher (download a standard Java JDK if you don't have one already).

For a particular plug-in project, ex: or.wcs.smart.er "Right Click in the package explorer-> Properties " => "Java Build Path->Libraries "

Remove the jre ("jre.1.0.win64)
Click "Add Library..." ,
Select "JRE System Library "
Select "alternate JRE" and then the JDK you added in the previous step.
Run the JaxB generation etc.

org.wcs.smart.util

The org.wcs.smart.util folder contains a traditional java project (not eclipse RCP plugin), that contains some utility functions to manage the SMART database, translations etc. These are not distributed in anyway and are only used by the developer.

The build this project and import into eclipse:

1) Since this is not an eclipse RCP plugin you need to use maven to build appropriate files:

To build the project and import into eclipse run:
org.wcs.smart.util>> mvn eclipse:eclipse

2) Used the eclipse 'File -> Import' option & the 'existing projects into workspace' you can now import this project into Eclipse.

SQL Scripts to create a database.

The sql required to create the SMART database is located in this project:

org.wcs.smart.util\src\main\resources\org\wcs\smart\db
org.wcs.smart.util\src\main\resources\org\wcs\smart\db\updates

The sql files in the main folder create the database structure for the SMART 1.0. Subsequent update sql scripts are in the updates folder.

To create a blank database based on the run the the CreateSmartDb java class (requires one argument; the output location). This script runs all the sql files and the update scripts to create a new SMART database.

In the Run -> Run Configurations create a new "JAVA Application" 
In the "Main" tab: 
    Name: CreateSmartDb
    Project: org.wcs.smart.util
    Main class: org.wcs.smart.db.CreateSmartDb
In the "Arguments" Tab:
    Program Arguments: <OUTPUTLOCATION>           

Note:  To automatically write to the org.wcs.smart plugin (for smart.product launch configuration) set the OUTPUTLOCATION to the 
	"<SMARTCHECKOUT>\trunk\source\java\org.wcs.smart\data\database\smartdb"