[Development]
Information for Developers
Getting Started
This section describes the necessary system preparations for SDCF development, as well as the requirements for command-line builds with Ant or the development with Eclipse.
System Preparations
-
Java JDK 6 Installation
- You can either install the Java JDK 6 from Oracle or the OpenJDK 6 for Linux distributions (sudo apt-get install openjdk-6-jre).
-
Android-SDK Installation
- Install the Android-SDK by following the instruction on the Android Developer pages.
-
Platform Tools & Package Installation
- Use the Android SDK Manager to download Android 2.2 (API level 8) and the required platform tools.
-
System Path Updates for Ant Builds
- Add the ''<sdk-install-dir>/tools'' and the ''<sdk-install-dir>/platform-tools'' directories to the PATH environment variable of your System. Where <sdk-install-dir> refers to the installation directory of the Android-SDK. In case, check that the tools are included in the PATH, e.g., by "tr \0 \n < /proc/
pidof eclipse/environ | grep ^PATH".
- Add the ''<sdk-install-dir>/tools'' and the ''<sdk-install-dir>/platform-tools'' directories to the PATH environment variable of your System. Where <sdk-install-dir> refers to the installation directory of the Android-SDK. In case, check that the tools are included in the PATH, e.g., by "tr \0 \n < /proc/
-
Graphviz Installation for an Ant-Based Javadoc Creation (Optional)
- To be able to execute the ''ant/javadoc.xml'' script to build an HTML documentation with UML diagrams, you have to install Graphviz for the automatic post-processing of the UMLGraph dot files. (For further information check the README file in the SDCFrameworkLib project).
Command-Line Builds with Ant
To proper build the SDCF projects from command line, Ant 1.8 or higher must be installed.
Check-out the Projects from the SVN repositiory.
-
Setup the Projects for Ant Builds
-
Switch to each project directory (e.g. SDCFrameworkLib) and execute the related setup command:
- SDCFrameworkLib: ''android update lib-project --path . --target android-8'',
- SDCFramework, SDCFrameworkDemo: ''android update project --path . --target android-8'',
- SDCFrameworkTest: ''android update test-project --main ../SDCFramework --path .''.
-
-
Ant Usage Examples
-
Build and install a debug version of the the SDCFramework Application:
- Switch to the SDCFramework project directory and execute the command ''ant clean debug install''.
-
Build the Javadoc Dcumentation for the library:
- Switch to the SDCFrameworkLib project directory and execute the command ''ant javadoc''.
- The HTML-documentation is stored in a subdirectory of the library project: "SDCFrameworkLib/doc/javadoc".
-
Build and run the tests:
- Switch to the SDCFrameworkTest project directory and execute the command ''ant clean debug install test uninstall''.
-
For further information about Ant builds of Android projects check the Android developer page.
-
Eclipse Development
The framework projects are configured and maintained for Eclipse Galileo, Eclipse Helios and Eclipse Indigo with an installed ADT Plugin Versions 21.0 or lower (Success on building and running the projects has also been reported with the ADT Bundle).
-
ADT Installation
- Install the ADT Plugin for Eclipse by following the instruction on the Android Developer pages.
-
Import the projects
- To import the source from the SVN repositiory a Team-Plugin for SVN must be installed (e.g. Subclipse).
- Alternatively, you can checkout the source with "svn" via command line and choose the import from file system option in Eclipse.
Possible Pitfalls & Solutions
Java-7 / Compliance Level
-
If you use Java SDK 7 instead of 6, you may get the following error: ''Android requires compiler compliance level 5.0 or 6.0. Found '1.7' instead ...''.
-
To fix it do the following:
- right-click on the project and select "Android Tools->Fix Project Properties".
- right-click on the project and select "Properties->Java Compiler" and select 1.6 in the "Compiler compliance settings" select box.
