Merge pull request #19 from RADAR-CNS/0.1_release

0.1 release request

README.md

@@ -2,11 +2,15 @@
 
 [![Build Status](https://travis-ci.org/RADAR-CNS/RADAR-Schemas.svg?branch=master)](https://travis-ci.org/RADAR-CNS/RADAR-Schemas)
 
-[Avro schemas](https://avro.apache.org/docs/1.8.1/spec.html) used in RADAR-CNS.
+[Avro schemas](https://avro.apache.org/docs/1.8.1/spec.html) used in RADAR-CNS. The schemas are divided into three parts: `commons` for the passive remote monitoring application and the backend, `restapi` for the REST API, and `questionnaire` for the active remote monitoring application.
+
+Java SDKs for each of the components are provided in the `java-sdk` folder, see installation instructions there. They are automatically generated from the Avro schemas using the Avro 1.8.1 specification.
 
 ## Contributing
 
-The Avro schemas in the `common` directory adhere to the [Google JSON style](https://google.github.io/styleguide/jsoncstyleguide.xml). In addition:
+The Avro schemas should follow the [Google JSON style guide](https://google.github.io/styleguide/jsoncstyleguide.xml).
+
+In addition, schemas in the `commons` directory should follow the following guidelines:
 
 - Try to avoid abbreviations in the field names and write out the field name instead.
 - There should be no need to add `value` at the end of a field name.

java-sdk/README.md

@@ -0,0 +1,43 @@
+# RADAR Schemas Java SDK
+
+The Java SDKs are published as JARs on bintray. To use them in Gradle, add the following code to your `build.gradle`:
+
+```gradle
+repositories {
+    maven { url  'http://dl.bintray.com/radar-cns/org.radarcns' }
+}
+
+dependencies {
+    // Commons schemas (backend, passive remote monitoring app)
+    compile 'org.radarcns:radar-schemas-commons:0.1'
+
+    // REST API schemas (REST API, testing)
+    compile 'org.radarcns:radar-schemas-restapi:0.1'
+
+    // Questionnaire schemas (active remote monitoring app)
+    compile 'org.radarcns:radar-schemas-questionnaire:0.1'
+}
+```
+Usually, you only need to include the schemas you actually need in your dependencies.
+
+The generated code each refers to a single schema. The classes of Avro records will extend `org.apache.avro.specific.SpecificRecord`. They each have a static `getClassSchema()` function that returns the `Schema` that it was generated from. To read JSON serialized data for example, use the following code:
+
+```java
+public class Deserialize {
+   public static void main(String args[]) throws Exception {
+      //Instantiating the Schema.Parser class.
+      DatumReader<PhoneBatteryLevel> datumReader = new SpecificDatumReader<>(PhoneBatteryLevel.class);
+      DataFileReader<PhoneBatteryLevel> dataFileReader = new DataFileReader<>(new File("/path/to/mydata.avro"), datumReader);
+
+      System.out.println("Reading phone battery levels");
+      PhoneBatteryLevel batteryLevel = null;
+      while (dataFileReader.hasNext()) {
+         batteryLevel = dataFileReader.next(batteryLevel);
+         System.out.println("Phone battery level: " + batteryLevel);
+      }
+      System.out.println("Done");
+   }
+}
+```
+
+Alternatively, use `org.radarcns.data.SpecificRecordEncoder` and `org.radarcns.data.SpecificRecordDecoder` from the `radar-commons` package.

java-sdk/build.gradle

@@ -14,7 +14,8 @@ subprojects {
     apply plugin: 'com.commercehub.gradle.plugin.avro-base'
     apply plugin: 'maven-publish'
 
-    version = '0.1-SNAPSHOT'
+    // Configuration
+    version = '0.1'
     group = 'org.radarcns'
     ext.githubRepo = 'RADAR-CNS/RADAR-Schemas'
 
@@ -27,15 +28,16 @@ subprojects {
     ext.issueUrl = 'https://github.com/' + githubRepo + '/issues'
     ext.website = 'http://radar-cns.org'
 
+    // dependencies
     repositories {
         jcenter()
-        maven { url 'http://dl.bintray.com/typesafe/maven-releases' }
     }
 
     dependencies {
         api group: 'org.apache.avro', name: 'avro', version: avroVersion
     }
 
+    // publishing
     ext.pomConfig = {
         licenses {
             license {
@@ -103,19 +105,14 @@ subprojects {
         archives sourcesJar, javadocJar
     }
 
+    // Generated avro files
     ext.avroOutputDir = file('src/main/java')
 
     clean {
         delete avroOutputDir
     }
 }
 
-//---------------------------------------------------------------------------//
-// Testing                                                                   //
-//---------------------------------------------------------------------------//
-
-
-
 task wrapper(type: Wrapper) {
     gradleVersion = '3.4.1'
     distributionUrl distributionUrl.replace("bin", "all")