Skip to content

Commit 70e02ac

Browse files
authored
Tschie/preplanned map (#405) (#416)
* download preplanned map sample * refactoring * add ref to update parameters * method/enum name for update option * method/enum name for update option * update runtime version, imports * inner class to private * add auth manager to handle OAuth challenge * mark portal as requires authentication * update README.md * add screenshot alt text * update README.md * update README.md * update README.md for scheduled updates workflow * update link to guide * update README.md * update use case * improve 'how it works' * add preview of area of interest * improve drawing area of interest * update use case wording, references in additional information * fix deleting temp files, add button 'return to web map' * add numbering to list view * zoom to area on select, refactoring * update listener adding/removing * refactoring * disable/enable showWebMapButton approprately * add README.metadata.json * fix function naming * add confirmation popup when deleting * refactoring, use commons library to delete * fix commons-io dependency * 'show web map' button width * reorder imports * improve viewpoint change, button updates * smaller UI * refactoring and comments * javadoc comments and formatting * remove stray q file * address review corrections * review changes and refactoring * refactoring * whitespace * web map -> online map * further information -> additional information * mmpk to class member * change button text * selecting view online map pans to selected area * formatting * update README.md * copyright statements * remove commented code * try to simplify a bit * simplify sample * don't hide graphics overlay on download * add snippet * update How to use the sample section * Update DownloadPreplannedMap.png * Slim up the use case * remove fxml comments * remove redirect from for new sample
1 parent 3a3bcb2 commit 70e02ac

15 files changed

+898
-0
lines changed
511 KB
Loading
Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# Download a preplanned map area
2+
3+
Take a map offline using a preplanned map area.
4+
5+
![Download Preplanned Map Sample](DownloadPreplannedMap.png)
6+
7+
## Use case
8+
9+
Generating offline maps on demand for a specific area can be time consuming for users and a processing load on the server. If areas of interest are known ahead of time, a web map author can pre-create packages for these areas. This way, the generation only needs to happen once, making the workflow more efficient for users and servers.
10+
11+
An archaeology team could define preplanned map areas for dig sites which can be taken offline for field use.
12+
13+
## How to use the sample
14+
15+
Downloading Tiles for offline use requires authentication with the web map's server. An [ArcGIS Online](www.arcgis.com) account is required to use this sample.
16+
17+
Select a map area from the Preplanned Map Areas list. Click the Download button to download the selected area. The download progress will be shown in the Downloads list. When a download is complete, select it to display the offline map in the map view.
18+
19+
## How it works
20+
21+
1. Open the online `ArcGISMap` from a `PortalItem` and display it.
22+
2. Create an `OfflineMapTask` using the portal item.
23+
3. Get the `PreplannedMapArea`s from the task, and then load them.
24+
4. To download a selected map area, create the default `DownloadPreplannedOfflineMapParameters` from the task using the selected preplanned map area.
25+
5. Set the update mode of the preplanned map area.
26+
6. Use the parameters and a download path to create a `DownloadPreplannedOfflineMapJob` from the task.
27+
7. Start the job. Once it has completed, get the `DownloadPreplannedOfflineMapResult`.
28+
8. Get the `ArcGISMap` from the result and display it in the `MapView`.
29+
30+
## Relevant API
31+
32+
* DownloadPreplannedOfflineMapJob
33+
* DownloadPreplannedOfflineMapParameters
34+
* DownloadPreplannedOfflineMapResult
35+
* OfflineMapTask
36+
* PreplannedMapArea
37+
38+
## About the data
39+
40+
The [Naperville stormwater network map](https://arcgisruntime.maps.arcgis.com/home/item.html?id=acc027394bc84c2fb04d1ed317aac674) is based on ArcGIS Solutions for Stormwater and provides a realistic depiction of a theoretical stormwater network.
41+
42+
## Additional information
43+
44+
`PreplannedUpdateMode` can be used to set the way the preplanned map area receives updates in several ways:
45+
46+
* `NO_UPDATES` - No updates will be performed.
47+
* `SYNC_WITH_FEATURE_SERVICES` - Changes, including local edits, will be synced directly with the underlying feature services.
48+
* `DOWNLOAD_SCHEDULED_UPDATES` - Scheduled, read-only updates will be downloaded from the online map area and applied to the local mobile geodatabases.
49+
50+
See [Take a map offline - preplanned](https://developers.arcgis.com/java/latest/guide/take-map-offline-preplanned.htm) to learn about preplanned workflows, including how to define preplanned areas in ArcGIS Online. Alternatively, visit [Take a map offline - on demand](https://developers.arcgis.com/java/latest/guide/take-map-offline-ondemand.htm) or refer to the sample 'Generate Offline Map' to learn about the on-demand workflow and see how the workflows differ.
51+
52+
## Tags
53+
54+
map area, offline, preplanned, pre-planned
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
{
2+
"category": "Map",
3+
"description": "Take a map offline using a preplanned map area.",
4+
"ignore": false,
5+
"images": [
6+
"DownloadPreplannedMap.png"
7+
],
8+
"keywords": [
9+
"map area",
10+
"offline",
11+
"preplanned",
12+
"pre-planned"
13+
],
14+
"redirect_from": "",
15+
"relevant_apis": [
16+
"DownloadPreplannedOfflineMapJob",
17+
"DownloadPreplannedOfflineMapParameters",
18+
"DownloadPreplannedOfflineMapResult",
19+
"OfflineMapTask",
20+
"PreplannedMapArea"
21+
],
22+
"snippets": [
23+
"src/main/java/com/esri/samples/download_preplanned_map/DownloadPreplannedMapController.java",
24+
"src/main/java/com/esri/samples/download_preplanned_map/DownloadPreplannedMapSample.java",
25+
"src/main/java/com/esri/samples/download_preplanned_map/DownloadPreplannedOfflineMapJobListCell.java",
26+
"src/main/java/com/esri/samples/download_preplanned_map/PreplannedMapAreaListCell.java",
27+
"src/main/resources/download_preplanned_map.fxml"
28+
],
29+
"title": "Download a Preplanned Map Area"
30+
}
Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
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-2490'
10+
}
11+
12+
javafx {
13+
version = "11.0.1"
14+
modules = [ 'javafx.controls', 'javafx.fxml' ]
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.download_preplanned_map.DownloadPreplannedMapLauncher'
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 copyNatives
68+
from jar.destinationDir
69+
into (project.name)
70+
baseName = project.name
71+
}
72+
73+
wrapper {
74+
gradleVersion = '5.0'
75+
}
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
distributionBase=GRADLE_USER_HOME
2+
distributionPath=wrapper/dists
3+
distributionUrl=https\://services.gradle.org/distributions/gradle-5.0-bin.zip
4+
zipStoreBase=GRADLE_USER_HOME
5+
zipStorePath=wrapper/dists
Lines changed: 172 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,172 @@
1+
#!/usr/bin/env sh
2+
3+
##############################################################################
4+
##
5+
## Gradle start up script for UN*X
6+
##
7+
##############################################################################
8+
9+
# Attempt to set APP_HOME
10+
# Resolve links: $0 may be a link
11+
PRG="$0"
12+
# Need this for relative symlinks.
13+
while [ -h "$PRG" ] ; do
14+
ls=`ls -ld "$PRG"`
15+
link=`expr "$ls" : '.*-> \(.*\)$'`
16+
if expr "$link" : '/.*' > /dev/null; then
17+
PRG="$link"
18+
else
19+
PRG=`dirname "$PRG"`"/$link"
20+
fi
21+
done
22+
SAVED="`pwd`"
23+
cd "`dirname \"$PRG\"`/" >/dev/null
24+
APP_HOME="`pwd -P`"
25+
cd "$SAVED" >/dev/null
26+
27+
APP_NAME="Gradle"
28+
APP_BASE_NAME=`basename "$0"`
29+
30+
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
31+
DEFAULT_JVM_OPTS=""
32+
33+
# Use the maximum available, or set MAX_FD != -1 to use that value.
34+
MAX_FD="maximum"
35+
36+
warn () {
37+
echo "$*"
38+
}
39+
40+
die () {
41+
echo
42+
echo "$*"
43+
echo
44+
exit 1
45+
}
46+
47+
# OS specific support (must be 'true' or 'false').
48+
cygwin=false
49+
msys=false
50+
darwin=false
51+
nonstop=false
52+
case "`uname`" in
53+
CYGWIN* )
54+
cygwin=true
55+
;;
56+
Darwin* )
57+
darwin=true
58+
;;
59+
MINGW* )
60+
msys=true
61+
;;
62+
NONSTOP* )
63+
nonstop=true
64+
;;
65+
esac
66+
67+
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
68+
69+
# Determine the Java command to use to start the JVM.
70+
if [ -n "$JAVA_HOME" ] ; then
71+
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
72+
# IBM's JDK on AIX uses strange locations for the executables
73+
JAVACMD="$JAVA_HOME/jre/sh/java"
74+
else
75+
JAVACMD="$JAVA_HOME/bin/java"
76+
fi
77+
if [ ! -x "$JAVACMD" ] ; then
78+
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
79+
80+
Please set the JAVA_HOME variable in your environment to match the
81+
location of your Java installation."
82+
fi
83+
else
84+
JAVACMD="java"
85+
which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
86+
87+
Please set the JAVA_HOME variable in your environment to match the
88+
location of your Java installation."
89+
fi
90+
91+
# Increase the maximum file descriptors if we can.
92+
if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
93+
MAX_FD_LIMIT=`ulimit -H -n`
94+
if [ $? -eq 0 ] ; then
95+
if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
96+
MAX_FD="$MAX_FD_LIMIT"
97+
fi
98+
ulimit -n $MAX_FD
99+
if [ $? -ne 0 ] ; then
100+
warn "Could not set maximum file descriptor limit: $MAX_FD"
101+
fi
102+
else
103+
warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
104+
fi
105+
fi
106+
107+
# For Darwin, add options to specify how the application appears in the dock
108+
if $darwin; then
109+
GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
110+
fi
111+
112+
# For Cygwin, switch paths to Windows format before running java
113+
if $cygwin ; then
114+
APP_HOME=`cygpath --path --mixed "$APP_HOME"`
115+
CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
116+
JAVACMD=`cygpath --unix "$JAVACMD"`
117+
118+
# We build the pattern for arguments to be converted via cygpath
119+
ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
120+
SEP=""
121+
for dir in $ROOTDIRSRAW ; do
122+
ROOTDIRS="$ROOTDIRS$SEP$dir"
123+
SEP="|"
124+
done
125+
OURCYGPATTERN="(^($ROOTDIRS))"
126+
# Add a user-defined pattern to the cygpath arguments
127+
if [ "$GRADLE_CYGPATTERN" != "" ] ; then
128+
OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
129+
fi
130+
# Now convert the arguments - kludge to limit ourselves to /bin/sh
131+
i=0
132+
for arg in "$@" ; do
133+
CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
134+
CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
135+
136+
if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
137+
eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
138+
else
139+
eval `echo args$i`="\"$arg\""
140+
fi
141+
i=$((i+1))
142+
done
143+
case $i in
144+
(0) set -- ;;
145+
(1) set -- "$args0" ;;
146+
(2) set -- "$args0" "$args1" ;;
147+
(3) set -- "$args0" "$args1" "$args2" ;;
148+
(4) set -- "$args0" "$args1" "$args2" "$args3" ;;
149+
(5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
150+
(6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
151+
(7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
152+
(8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
153+
(9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
154+
esac
155+
fi
156+
157+
# Escape application args
158+
save () {
159+
for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
160+
echo " "
161+
}
162+
APP_ARGS=$(save "$@")
163+
164+
# Collect all arguments for the java command, following the shell quoting and substitution rules
165+
eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
166+
167+
# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
168+
if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
169+
cd "$(dirname "$0")"
170+
fi
171+
172+
exec "$JAVACMD" "$@"

0 commit comments

Comments
 (0)