Updates examples / docs for saving and restoring series data to the instance state. (halfhp#35)

halfhp · web-flow · commit d9a2f40e3449 · 2017-03-25T12:19:15.000-05:00
* uprevd to latest, gradle, build tools etc.

* Refactored examples and documentation to no longer use the SeriesRegistry to save/restore instance state.  Added a simple example of saving/restoring just the series array data into TimeSeriesActivty.

* fixed unit test location paths
diff --git a/androidplot-core/build.gradle b/androidplot-core/build.gradle
@@ -38,6 +38,7 @@ android {
     lintOptions {
         abortOnError false
     }
+    buildToolsVersion '25.0.0'
 }
 
 group = 'com.androidplot'
diff --git a/androidplot-core/src/main/java/com/androidplot/xy/XYGraphWidget.java b/androidplot-core/src/main/java/com/androidplot/xy/XYGraphWidget.java
@@ -135,7 +135,7 @@ public static class LineLabelRenderer {
         public void drawLabel(Canvas canvas, LineLabelStyle style, Number val, float x, float y, boolean isOrigin) {
             final int canvasState = canvas.save();
             try {
-                final String txt = style.format.format(val.doubleValue());
+                final String txt = style.format.format(val);
                 canvas.rotate(style.getRotation(), x, y);
                 drawLabel(canvas, txt, style.getPaint(), x, y, isOrigin);
             } finally {
diff --git a/build.gradle b/build.gradle
@@ -38,7 +38,7 @@ buildscript {
     }
 
     dependencies {
-        classpath 'com.android.tools.build:gradle:2.2.0'
+        classpath 'com.android.tools.build:gradle:2.3.0'
         classpath 'com.github.dcendents:android-maven-gradle-plugin:1.5'
         classpath 'com.jfrog.bintray.gradle:gradle-bintray-plugin:1.7'
         classpath 'com.vanniktech:gradle-android-junit-jacoco-plugin:0.5.0'
diff --git a/circle.yml b/circle.yml
@@ -32,12 +32,12 @@ test:
 
     # junit xml report:
     - mkdir -p $CIRCLE_TEST_REPORTS/junit-xml/
-    - find . -type f -regex ".*/build/test-results/.*xml" -exec cp {} $CIRCLE_TEST_REPORTS/junit-xml/ \;
+    - find . -type f -regex ".*/build/test-results/testReleaseUnitTest/.*xml" -exec cp {} $CIRCLE_TEST_REPORTS/junit-xml/ \;
 
     # junit html report:
     # TODO: recursively copy subdirs etc
     - mkdir -p $CIRCLE_TEST_REPORTS/junit-html/
-    - cp -r ${HOME}/${CIRCLE_PROJECT_REPONAME}/androidplot-core/build/reports/tests/release/* $CIRCLE_TEST_REPORTS/junit-html/
+    - cp -r ${HOME}/${CIRCLE_PROJECT_REPONAME}/androidplot-core/build/reports/tests/testReleaseUnitTest/* $CIRCLE_TEST_REPORTS/junit-html/
 
     # lint report:
     - mkdir -p $CIRCLE_TEST_REPORTS/lint/
diff --git a/demoapp-wearable/build.gradle b/demoapp-wearable/build.gradle
@@ -19,7 +19,7 @@ buildscript {
         jcenter()
     }
     dependencies {
-        classpath 'com.android.tools.build:gradle:1.2.3'
+        classpath 'com.android.tools.build:gradle:2.3.0'
     }
 }
 apply plugin: 'com.android.application'
diff --git a/demoapp/build.gradle b/demoapp/build.gradle
@@ -76,6 +76,7 @@ android {
     lintOptions {
         abortOnError false
     }
+    buildToolsVersion '25.0.0'
 }
 
 play {
diff --git a/demoapp/src/main/java/com/androidplot/demos/DemoApplication.java b/demoapp/src/main/java/com/androidplot/demos/DemoApplication.java
@@ -4,9 +4,6 @@
 
 import com.squareup.leakcanary.*;
 
-/**
- * Created by halfhp on 10/1/16.
- */
 public class DemoApplication extends Application {
 
     @Override public void onCreate() {
diff --git a/demoapp/src/main/java/com/androidplot/demos/SimpleXYPlotActivity.java b/demoapp/src/main/java/com/androidplot/demos/SimpleXYPlotActivity.java
@@ -72,7 +72,7 @@ public void onCreate(Bundle savedInstanceState)
                 PixelUtils.dpToPix(20),
                 PixelUtils.dpToPix(15)}, 0));
 
-        // just for fun, add some smoothing to the lines:
+        // (optional) add some smoothing to the lines:
         // see: http://androidplot.com/smooth-curves-and-androidplot/
         series1Format.setInterpolationParams(
                 new CatmullRomInterpolator.Params(10, CatmullRomInterpolator.Type.Centripetal));
diff --git a/demoapp/src/main/java/com/androidplot/demos/TimeSeriesActivity.java b/demoapp/src/main/java/com/androidplot/demos/TimeSeriesActivity.java
@@ -20,61 +20,60 @@
 import android.graphics.*;
 import android.os.Bundle;
 
+import com.androidplot.util.PixelUtils;
 import com.androidplot.xy.SimpleXYSeries;
 import com.androidplot.xy.XYSeries;
 import com.androidplot.xy.*;
 
 import java.text.*;
 import java.util.Arrays;
+import java.util.Calendar;
 import java.util.Date;
+import java.util.GregorianCalendar;
 
 public class TimeSeriesActivity extends Activity {
 
+    private static final String SERIES_TITLE = "Signthings in USA";
+
     private XYPlot plot1;
+    private SimpleXYSeries series;
 
     @Override
     public void onCreate(Bundle savedInstanceState) {
         super.onCreate(savedInstanceState);
         setContentView(R.layout.time_series_example);
 
         plot1 = (XYPlot) findViewById(R.id.plot1);
-        Number[] numSightings = {5, 8, 6, 9, 3, 8, 5};
-
-        // an array of years in milliseconds:
-        Number[] years = {
-                978307200,  // 2001
-                998309300,
-                1009843200, // 2002
-                1041379200, // 2003
-                1052012100,
-                1072915200, // 2004
-                1104537600  // 2005
+
+        // these will be our domain index labels:
+        final Date[] years = {
+                new GregorianCalendar(2001, Calendar.JANUARY, 1).getTime(),
+                new GregorianCalendar(2001, Calendar.JULY, 1).getTime(),
+                new GregorianCalendar(2002, Calendar.JANUARY, 1).getTime(),
+                new GregorianCalendar(2002, Calendar.JULY, 1).getTime(),
+                new GregorianCalendar(2003, Calendar.JANUARY, 1).getTime(),
+                new GregorianCalendar(2003, Calendar.JULY, 1).getTime(),
+                new GregorianCalendar(2004, Calendar.JANUARY, 1).getTime(),
+                new GregorianCalendar(2004, Calendar.JULY, 1).getTime(),
+                new GregorianCalendar(2005, Calendar.JANUARY, 1).getTime(),
+                new GregorianCalendar(2005, Calendar.JULY, 1).getTime()
         };
-        // create our series from our array of nums:
-        XYSeries series2 = new SimpleXYSeries(
-                Arrays.asList(years),
-                Arrays.asList(numSightings),
-                "Sightings in USA");
+
+        addSeries(savedInstanceState);
+
+        plot1.setRangeBoundaries(0, 10, BoundaryMode.FIXED);
 
         plot1.getGraph().getGridBackgroundPaint().setColor(Color.WHITE);
         plot1.getGraph().getDomainGridLinePaint().setColor(Color.BLACK);
         plot1.getGraph().getDomainGridLinePaint().
-                setPathEffect(new DashPathEffect(new float[] {1, 1}, 1));
+                setPathEffect(new DashPathEffect(new float[]{1, 1}, 1));
         plot1.getGraph().getRangeGridLinePaint().setColor(Color.BLACK);
         plot1.getGraph().getRangeGridLinePaint().
-                setPathEffect(new DashPathEffect(new float[] {1, 1}, 1));
+                setPathEffect(new DashPathEffect(new float[]{1, 1}, 1));
         plot1.getGraph().getDomainOriginLinePaint().setColor(Color.BLACK);
         plot1.getGraph().getRangeOriginLinePaint().setColor(Color.BLACK);
 
-        // setup our line fill paint to be a slightly transparent gradient:
-        Paint lineFill = new Paint();
-        lineFill.setAlpha(200);
-
-        LineAndPointFormatter formatter =
-                new LineAndPointFormatter(Color.rgb(0, 0, 0), Color.BLUE, Color.RED, null);
-        formatter.setFillPaint(lineFill);
         plot1.getGraph().setPaddingRight(2);
-        plot1.addSeries(series2, formatter);
 
         // draw a domain tick for each year:
         plot1.setDomainStep(StepMode.SUBDIVIDE, years.length);
@@ -93,17 +92,15 @@ public void onCreate(Bundle savedInstanceState) {
                     // create a simple date format that draws on the year portion of our timestamp.
                     // see http://download.oracle.com/javase/1.4.2/docs/api/java/text/SimpleDateFormat.html
                     // for a full description of SimpleDateFormat.
-                    private SimpleDateFormat dateFormat = new SimpleDateFormat("MM-yyyy");
+                    private final SimpleDateFormat dateFormat = new SimpleDateFormat("MMM yyyy");
 
                     @Override
-                    public StringBuffer format(Object obj, StringBuffer toAppendTo,
-                            FieldPosition pos) {
-
-                        // because our timestamps are in seconds and SimpleDateFormat expects milliseconds
-                        // we multiply our timestamp by 1000:
-                        long timestamp = ((Number) obj).longValue() * 1000;
-                        Date date = new Date(timestamp);
-                        return dateFormat.format(date, toAppendTo, pos);
+                    public StringBuffer format(Object obj, StringBuffer toAppendTo, FieldPosition pos) {
+
+                        // this rounding is necessary to avoid precision loss when converting from
+                        // double back to int:
+                        int yearIndex = (int) Math.round(((Number) obj).doubleValue());
+                        return dateFormat.format(years[yearIndex], toAppendTo, pos);
                     }
 
                     @Override
@@ -113,4 +110,44 @@ public Object parseObject(String source, ParsePosition pos) {
                     }
                 });
     }
+
+    /**
+     * Instantiates our XYSeries, checking the current savedInstanceState for existing series data
+     * to avoid having to regenerate on each resume.  If your series data is small and easy to
+     * regenerate (as it is here) then you can skip saving/restoring your series data to
+     * savedInstanceState.
+     * @param savedInstanceState Current saved instance state, if any; may be null.
+     */
+    private void addSeries(Bundle savedInstanceState) {
+        Number[] yVals;
+
+        if(savedInstanceState != null) {
+            yVals = (Number[]) savedInstanceState.getSerializable(SERIES_TITLE);
+        } else {
+            yVals = new Number[]{5, 8, 6, 9, 3, 8, 5, 4, 7, 4};
+        }
+
+        // create our series from our array of nums:
+        series = new SimpleXYSeries(Arrays.asList(yVals),
+                SimpleXYSeries.ArrayFormat.Y_VALS_ONLY, SERIES_TITLE);
+
+        LineAndPointFormatter formatter =
+                new LineAndPointFormatter(Color.rgb(0, 0, 0), Color.RED, Color.RED, null);
+        formatter.getVertexPaint().setStrokeWidth(PixelUtils.dpToPix(10));
+        formatter.getLinePaint().setStrokeWidth(PixelUtils.dpToPix(5));
+
+        // setup our line fill paint to be a slightly transparent gradient:
+        Paint lineFill = new Paint();
+        lineFill.setAlpha(200);
+
+        formatter.setFillPaint(lineFill);
+
+        plot1.addSeries(series, formatter);
+    }
+
+    @Override
+    public void onSaveInstanceState(Bundle bundle) {
+        // persist our series data so we don't have to regenerate each time:
+        bundle.putSerializable(SERIES_TITLE, series.getyVals().toArray(new Number[]{}));
+    }
 }
diff --git a/demoapp/src/main/java/com/androidplot/demos/TouchZoomExampleActivity.java b/demoapp/src/main/java/com/androidplot/demos/TouchZoomExampleActivity.java
@@ -85,20 +85,10 @@ public void onClick(View view) {
         // enable autoselect of sampling level based on visible boundaries:
         plot.getRegistry().setEstimator(new ZoomEstimator());
 
-        if(savedInstanceState != null && savedInstanceState.containsKey("seriesRegistry")) {
-            XYSeriesRegistry registry = (XYSeriesRegistry) savedInstanceState.getSerializable("seriesRegistry");
-            plot.setRegistry(registry);
-        } else {
-            generateSeriesData();
-        }
+        generateSeriesData();
         reset();
     }
 
-    @Override
-    public void onSaveInstanceState(Bundle bundle) {
-        bundle.putSerializable("seriesRegistry", plot.getRegistry());
-    }
-
     private void reset() {
         plot.setDomainBoundaries(0, 10000, BoundaryMode.FIXED);
         plot.setRangeBoundaries(0, 1000, BoundaryMode.FIXED);
diff --git a/demoapp/src/main/res/layout/time_series_example.xml b/demoapp/src/main/res/layout/time_series_example.xml
@@ -28,10 +28,16 @@
             android:layout_width="fill_parent"
             android:layout_height="fill_parent"
             ap:title="@string/ts_plot1_title"
+            ap:paddingTop="10dp"
+            ap:paddingBottom="10dp"
+            ap:paddingLeft="10dp"
+            ap:paddingRight="10dp"
+            ap:backgroundColor="@color/ap_white"
+            ap:graphBackgroundColor="@color/ap_white"
             ap:lineLabelRotationBottom="-45"
-            ap:gridInsetLeft="30dp"
-            ap:gridInsetBottom="25dp"
-            ap:gridInsetRight="20dp"
-            ap:lineLabelInsetBottom="15dp"
+            ap:gridInsetLeft="35dp"
+            ap:gridInsetBottom="40dp"
+            ap:lineLabelInsetLeft="25dp"
+            ap:lineLabelInsetBottom="25dp"
             renderMode="use_main_thread"/>
 </LinearLayout>
diff --git a/demoapp/src/main/res/values/strings.xml b/demoapp/src/main/res/values/strings.xml
@@ -19,5 +19,5 @@
     <string name="app_name">Androidplot Demos</string>
     <string name="sxy_title">A Simple XY Plot</string>
     <string name="ts_title">Time Series</string>
-    <string name="ts_plot1_title">Yearly UFO Sightings</string>
+    <string name="ts_plot1_title">UFO Sightings</string>
 </resources>
diff --git a/docs/advanced_xy_plot.md b/docs/advanced_xy_plot.md
@@ -139,32 +139,16 @@ new LTTBSampler().run(originalSeries, sampledSeries);
 Currently LTTBSampler is the only available implementation.
 
 # Storing series data in onSaveInstanceState
-If your series data requires a non trivial amount of preprocessing (subsampling etc.) or your data samples
-stream in periodically, you'll likely want to persist your series data.
-
-Androidplot provides a simplified mechanism for preserving any registered series and formatter data
-provided they are serializable implementations. (All implementations of XYSeries that ship 
-with Androidplot are serializable)  
-
-To persist series / formatter data:
-```java
-// persist plot series / formatter configuration:
-@Override
-public void onSaveInstanceState(Bundle bundle) {
-    bundle.putSerializable("seriesRegistry", plot.getRegistry());
-}
-```
-
-To restore series / formatter data:
-```java
-public void onCreate(Bundle savedInstanceState) {
-    ...
-    if(savedInstanceState != null && savedInstanceState.containsKey("seriesRegistry")) {
-        XYSeriesRegistry registry = (XYSeriesRegistry) savedInstanceState.getSerializable("seriesRegistry");
-        plot.setRegistry(registry);
-    } else {
-        // first-time setup as usual
-        ...
-    }
-}
-```
+If your series data requires a non trivial amount of preprocessing (subsampling etc.) or your data comes
+from a dynamic source, you'll likely want to persist your series data when your Activity saves its
+instance state.  There are a few caveats to be aware of:
+
+* You can only persist about 1mb worth of data at a time so if your series data is much larger than that
+you'll need to find a creative solution to the problem
+* Due to [quirks in the way Android persists data](http://stackoverflow.com/questions/12300886/linkedlist-put-into-intent-extra-gets-recast-to-arraylist-when-retrieving-in-nex)
+`XYSeries` implementations such as `SimpleXYSeries` that use `LinkedList` instances to store data cannot be serialized directly.
+* Formatters generally cannot be persisted as they typically contain instances of `Paint` that cannot be serialized directly..
+
+Due to these limitations we suggest storing `XYSeries` data into an array or `ArrayList` and using that to 
+instantiate your `XYSeries`.  The DemoApp's [Time Series Example](../demoapp/src/main/java/com/androidplot/demos/TimeSeriesActivity.java) 
+contains a full source example.
diff --git a/docs/xyplot.md b/docs/xyplot.md
@@ -368,12 +368,12 @@ particularly well suited for downsampling `XYSeries` data.
 LineAndPointFormatter format = new LineAndPointFormatter(...);
 format.getLinePaint().setAntiAlias(false);
 ```
-# Screen<->Series Conversion
+# Converting Values
 Because the coordinate system used by your `XYSeries` data is almost always different than the screen
 coordinate system upon which the data is rendered, you'll often need to convert from one system to
 the other.  `XYPlot` provides convenience methods for this purpose:
 
-To convert screen vals to series vals:
+## Screen to Series Conversion
 ```java
 // x
 float screenX = ...
@@ -388,7 +388,7 @@ PointF screenCoords = ...
 XYCoords xy = plot.screenToSeries(screenCoords)
 ```
 
-To convert series vals to screen vals:
+## Series to Screen Conversion
 ```java
 // x
 Number x = ...
diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties
@@ -1,22 +1,6 @@
-#
-# Copyright 2015 AndroidPlot.com
-#
-#    Licensed 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.
-#
-
-#Wed Dec 02 22:16:29 CST 2015
+#Thu Mar 23 07:48:11 CDT 2017
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-2.14.1-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-3.3-all.zip

Original file line number	Diff line number	Diff line change
`@@ -38,6 +38,7 @@ android {`
`38`	`38`	`lintOptions {`
`39`	`39`	`abortOnError false`
`40`	`40`	`}`
	`41`	`+ buildToolsVersion '25.0.0'`
`41`	`42`	`}`
`42`	`43`
`43`	`44`	`group = 'com.androidplot'`
Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ buildscript {`
`38`	`38`	`}`
`39`	`39`
`40`	`40`	`dependencies {`
`41`		`- classpath 'com.android.tools.build:gradle:2.2.0'`
	`41`	`+ classpath 'com.android.tools.build:gradle:2.3.0'`
`42`	`42`	`classpath 'com.github.dcendents:android-maven-gradle-plugin:1.5'`
`43`	`43`	`classpath 'com.jfrog.bintray.gradle:gradle-bintray-plugin:1.7'`
`44`	`44`	`classpath 'com.vanniktech:gradle-android-junit-jacoco-plugin:0.5.0'`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ buildscript {`
`19`	`19`	`jcenter()`
`20`	`20`	`}`
`21`	`21`	`dependencies {`
`22`		`- classpath 'com.android.tools.build:gradle:1.2.3'`
	`22`	`+ classpath 'com.android.tools.build:gradle:2.3.0'`
`23`	`23`	`}`
`24`	`24`	`}`
`25`	`25`	`apply plugin: 'com.android.application'`
Original file line number	Diff line number	Diff line change
`@@ -76,6 +76,7 @@ android {`
`76`	`76`	`lintOptions {`
`77`	`77`	`abortOnError false`
`78`	`78`	`}`
	`79`	`+ buildToolsVersion '25.0.0'`
`79`	`80`	`}`
`80`	`81`
`81`	`82`	`play {`