Skip to content

Commit f9e744d

Browse files
authored
Apply scheduled updates to preplanned map area (#392)
* initial commit * fix launcher * add apache commons dependencies, fix runtime version * update runtime version * update gradle script * review changes * add README.metadata.json * remove gif * update screenshot * mmpk to class member * update README.metadata.json * add second check for updates after applying * refactor checking for update * title typo, widen UI * update runtime build * remove error message details, refactoring * remove unused imports * move downloading from build to settings.gradle * update README.metadata.json * remove unneeded sync direction code * remove unneeded imports * update runtime version * replace UI with alert * update screenshot and readme.md * fix alert typo * remove progress indicator, add javadocs * remove update checks and update automatically * update README.metadata.json * Revert "remove update checks and update automatically" This reverts commit b9ee5ec. * Revert "update README.metadata.json" This reverts commit 74e6859. * minor cleanup * Rewording
1 parent a0f2be8 commit f9e744d

File tree

12 files changed

+697
-0
lines changed

12 files changed

+697
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Apply scheduled updates to preplanned map area
2+
3+
Apply scheduled updates to a downloaded preplanned map area.
4+
5+
![Apply Scheduled Updates to Preplanned Map Area Sample](ApplyScheduledUpdatesToPreplannedMapArea.png)
6+
7+
## Use case
8+
9+
With scheduled updates, the author can update the features within the preplanned areas on the service once, and multiple end-users can request these updates to bring their local copies up to date with the most recent state. Importantly, any number of end-users can download the same set of cached updates which means that this workflow is extremely scalable for large operations where you need to minimize load on the server.
10+
11+
This workflow can be used by survey workers operating in remote areas where network connectivity is not available. The workers could download mobile map packages to their individual devices and perform their work normally. Once they regain internet connectivity, the mobile map packages can be updated to show any new features that have been added to the online service.
12+
13+
## How to use the sample
14+
15+
Start the app. It will display an offline map, check for available updates, and show an alert with update availability and size. Confirm to apply the updates to the local offline map and show the results.
16+
17+
## How it works
18+
19+
1. Create an `OfflineMapSyncTask` with an offline map.
20+
2. Use `offlineMapSyncTask.checkForUpdatesAsync()` to get a `OfflineMapUpdatesInfo` object.
21+
3. Check if the download availability on the info is `AVAILABLE`.
22+
4. To download the updates, create default sync parameters from the task.
23+
5. Set the `PreplannedScheduledUpdatesOption` and the rollback behavior on the parameters.
24+
6. Use `offlineMapSyncTask.syncOfflineMap(parameters)` to create an `OfflineMapSyncJob`.
25+
7. Start the job and get the `OfflineMapSyncResult`.
26+
8. Check if the mobile map package needs to be reopened, and do so if necessary. Display the offline map to see the
27+
changes.
28+
29+
## Relevant API
30+
31+
* MobileMapPackage
32+
* OfflineMapSyncJob
33+
* OfflineMapSyncParameters
34+
* OfflineMapSyncResult
35+
* OfflineMapSyncTask
36+
* OfflineMapUpdatesInfo
37+
38+
## About the data
39+
40+
The data in this sample shows the roads and trails in the Canyonlands National Park, Utah. Data by [U.S. National Parks Service](https://public-nps.opendata.arcgis.com/). No claim to original U.S. Government works.
41+
42+
## Additional information
43+
44+
**Note:** preplanned areas using the Scheduled Updates workflow are read-only. For preplanned areas that can be edited on the end-user device, see [Take a map offline - preplanned](https://developers.arcgis.com/java/latest/guide/take-map-offline-preplanned.htm).
45+
46+
## Tags
47+
48+
offline, preplanned, pre-planned, synchronize, update
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
{
2+
"category": "Map",
3+
"description": "Apply scheduled updates to a downloaded preplanned map area.",
4+
"ignore": false,
5+
"images": [
6+
"ApplyScheduledUpdatesToPreplannedMapArea.png"
7+
],
8+
"keywords": [
9+
"offline",
10+
"preplanned",
11+
"pre-planned",
12+
"synchronize",
13+
"update"
14+
],
15+
"redirect_from": "",
16+
"relevant_apis": [
17+
"MobileMapPackage",
18+
"OfflineMapSyncJob",
19+
"OfflineMapSyncParameters",
20+
"OfflineMapSyncResult",
21+
"OfflineMapSyncTask",
22+
"OfflineMapUpdatesInfo"
23+
],
24+
"snippets": [
25+
"src/main/java/com/esri/samples/apply_scheduled_updates_to_preplanned_map_area/ApplyScheduledUpdatesToPreplannedMapAreaSample.java"
26+
],
27+
"title": "Apply scheduled updates to preplanned map area"
28+
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
plugins {
2+
id 'application'
3+
id 'org.openjfx.javafxplugin' version '0.0.5'
4+
}
5+
6+
group = 'com.esri.samples'
7+
8+
ext {
9+
arcgisVersion = '100.6.0'
10+
}
11+
12+
javafx {
13+
version = "11.0.1"
14+
modules = [ 'javafx.controls' ]
15+
}
16+
17+
compileJava.options.encoding = 'UTF-8'
18+
19+
repositories {
20+
jcenter()
21+
maven {
22+
url 'https://esri.bintray.com/arcgis'
23+
}
24+
maven {
25+
url 'http://olympus.esri.com/artifactory/arcgisruntime-repo'
26+
}
27+
}
28+
29+
configurations {
30+
natives
31+
}
32+
33+
dependencies {
34+
compile "com.esri.arcgisruntime:arcgis-java:$arcgisVersion"
35+
natives "com.esri.arcgisruntime:arcgis-java-jnilibs:$arcgisVersion"
36+
natives "com.esri.arcgisruntime:arcgis-java-resources:$arcgisVersion"
37+
compile 'commons-io:commons-io:2.4'
38+
}
39+
40+
task copyNatives(type: Copy) {
41+
description = "Copies the arcgis native libraries into the project build directory for development."
42+
group = "build"
43+
configurations.natives.asFileTree.each {
44+
from(zipTree(it))
45+
}
46+
// store native libraries in a common location shared with other samples
47+
into "${System.properties.getProperty("user.home")}/.arcgis/$arcgisVersion"
48+
}
49+
50+
run {
51+
dependsOn copyNatives
52+
mainClassName = 'com.esri.samples.apply_scheduled_updates_to_preplanned_map_area.ApplyScheduledUpdatesToPreplannedMapAreaLauncher'
53+
}
54+
55+
jar {
56+
duplicatesStrategy = DuplicatesStrategy.EXCLUDE
57+
manifest {
58+
attributes("Main-Class": "$mainClassName")
59+
}
60+
from {
61+
configurations.compile.collect { it.isDirectory() ? it : zipTree(it) }
62+
}
63+
}
64+
65+
task productionZip(type: Zip) {
66+
group = 'distribution'
67+
from ("samples-data") {
68+
into "samples-data"
69+
}
70+
from copyNatives
71+
from jar.destinationDir
72+
into (project.name)
73+
baseName = project.name
74+
}
75+
76+
wrapper {
77+
gradleVersion = '5.0'
78+
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,188 @@
1+
#!/usr/bin/env sh
2+
3+
#
4+
# Copyright 2015 the original author or authors.
5+
#
6+
# Licensed under the Apache License, Version 2.0 (the "License");
7+
# you may not use this file except in compliance with the License.
8+
# You may obtain a copy of the License at
9+
#
10+
# https://www.apache.org/licenses/LICENSE-2.0
11+
#
12+
# Unless required by applicable law or agreed to in writing, software
13+
# distributed under the License is distributed on an "AS IS" BASIS,
14+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
# See the License for the specific language governing permissions and
16+
# limitations under the License.
17+
#
18+
19+
##############################################################################
20+
##
21+
## Gradle start up script for UN*X
22+
##
23+
##############################################################################
24+
25+
# Attempt to set APP_HOME
26+
# Resolve links: $0 may be a link
27+
PRG="$0"
28+
# Need this for relative symlinks.
29+
while [ -h "$PRG" ] ; do
30+
ls=`ls -ld "$PRG"`
31+
link=`expr "$ls" : '.*-> \(.*\)$'`
32+
if expr "$link" : '/.*' > /dev/null; then
33+
PRG="$link"
34+
else
35+
PRG=`dirname "$PRG"`"/$link"
36+
fi
37+
done
38+
SAVED="`pwd`"
39+
cd "`dirname \"$PRG\"`/" >/dev/null
40+
APP_HOME="`pwd -P`"
41+
cd "$SAVED" >/dev/null
42+
43+
APP_NAME="Gradle"
44+
APP_BASE_NAME=`basename "$0"`
45+
46+
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
47+
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
48+
49+
# Use the maximum available, or set MAX_FD != -1 to use that value.
50+
MAX_FD="maximum"
51+
52+
warn () {
53+
echo "$*"
54+
}
55+
56+
die () {
57+
echo
58+
echo "$*"
59+
echo
60+
exit 1
61+
}
62+
63+
# OS specific support (must be 'true' or 'false').
64+
cygwin=false
65+
msys=false
66+
darwin=false
67+
nonstop=false
68+
case "`uname`" in
69+
CYGWIN* )
70+
cygwin=true
71+
;;
72+
Darwin* )
73+
darwin=true
74+
;;
75+
MINGW* )
76+
msys=true
77+
;;
78+
NONSTOP* )
79+
nonstop=true
80+
;;
81+
esac
82+
83+
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
84+
85+
# Determine the Java command to use to start the JVM.
86+
if [ -n "$JAVA_HOME" ] ; then
87+
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
88+
# IBM's JDK on AIX uses strange locations for the executables
89+
JAVACMD="$JAVA_HOME/jre/sh/java"
90+
else
91+
JAVACMD="$JAVA_HOME/bin/java"
92+
fi
93+
if [ ! -x "$JAVACMD" ] ; then
94+
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
95+
96+
Please set the JAVA_HOME variable in your environment to match the
97+
location of your Java installation."
98+
fi
99+
else
100+
JAVACMD="java"
101+
which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
102+
103+
Please set the JAVA_HOME variable in your environment to match the
104+
location of your Java installation."
105+
fi
106+
107+
# Increase the maximum file descriptors if we can.
108+
if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
109+
MAX_FD_LIMIT=`ulimit -H -n`
110+
if [ $? -eq 0 ] ; then
111+
if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
112+
MAX_FD="$MAX_FD_LIMIT"
113+
fi
114+
ulimit -n $MAX_FD
115+
if [ $? -ne 0 ] ; then
116+
warn "Could not set maximum file descriptor limit: $MAX_FD"
117+
fi
118+
else
119+
warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
120+
fi
121+
fi
122+
123+
# For Darwin, add options to specify how the application appears in the dock
124+
if $darwin; then
125+
GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
126+
fi
127+
128+
# For Cygwin, switch paths to Windows format before running java
129+
if $cygwin ; then
130+
APP_HOME=`cygpath --path --mixed "$APP_HOME"`
131+
CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
132+
JAVACMD=`cygpath --unix "$JAVACMD"`
133+
134+
# We build the pattern for arguments to be converted via cygpath
135+
ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
136+
SEP=""
137+
for dir in $ROOTDIRSRAW ; do
138+
ROOTDIRS="$ROOTDIRS$SEP$dir"
139+
SEP="|"
140+
done
141+
OURCYGPATTERN="(^($ROOTDIRS))"
142+
# Add a user-defined pattern to the cygpath arguments
143+
if [ "$GRADLE_CYGPATTERN" != "" ] ; then
144+
OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
145+
fi
146+
# Now convert the arguments - kludge to limit ourselves to /bin/sh
147+
i=0
148+
for arg in "$@" ; do
149+
CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
150+
CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
151+
152+
if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
153+
eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
154+
else
155+
eval `echo args$i`="\"$arg\""
156+
fi
157+
i=$((i+1))
158+
done
159+
case $i in
160+
(0) set -- ;;
161+
(1) set -- "$args0" ;;
162+
(2) set -- "$args0" "$args1" ;;
163+
(3) set -- "$args0" "$args1" "$args2" ;;
164+
(4) set -- "$args0" "$args1" "$args2" "$args3" ;;
165+
(5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
166+
(6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
167+
(7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
168+
(8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
169+
(9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
170+
esac
171+
fi
172+
173+
# Escape application args
174+
save () {
175+
for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
176+
echo " "
177+
}
178+
APP_ARGS=$(save "$@")
179+
180+
# Collect all arguments for the java command, following the shell quoting and substitution rules
181+
eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
182+
183+
# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
184+
if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
185+
cd "$(dirname "$0")"
186+
fi
187+
188+
exec "$JAVACMD" "$@"

0 commit comments

Comments
 (0)