Skip to content

Commit

Permalink
KML: Export KML2.3 - KML2.2 and KML2.3 can be imported.
Browse files Browse the repository at this point in the history 
Fixes #339.
  • Loading branch information
@dennisguse
dennisguse committed Sep 13, 2022
1 parent f567b03 commit 82fe859
Show file tree
Hide file tree
Showing 3 changed files with 74 additions and 52 deletions.
6 changes: 3 additions & 3 deletions src/androidTest/java/de/dennisguse/opentracks/io/file/exporter/KmlTrackExporterTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,14 @@ public class KmlTrackExporterTest {
@Test
public void writeCloseSegment_only_write_sensordata_if_present() {
String expected = "<when>1970-01-01T00:00:00Z</when>\n" +
"<gx:coord/>\n" +
"<coord/>\n" +
"<when>1970-01-01T01:00:00+01:00</when>\n" +
"<gx:coord/>\n" +
"<coord/>\n" +
"<ExtendedData>\n" +
"<SchemaData schemaUrl=\"#schema\">\n" +
"</SchemaData>\n" +
"</ExtendedData>\n" +
"</gx:Track>\n";
"</Track>\n";

// given
TrackPoint trackPoint = new TrackPoint(TrackPoint.Type.SEGMENT_START_MANUAL, Instant.ofEpochSecond(0));
Expand Down
41 changes: 23 additions & 18 deletions src/main/java/de/dennisguse/opentracks/io/file/exporter/KMLTrackExporter.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,8 @@
import de.dennisguse.opentracks.util.StringUtils;

/**
* Convert {@link Track} incl. {@link Marker} and {@link TrackPoint} to KML.
* Convert {@link Track} incl. {@link Marker} and {@link TrackPoint} to KML version 2.3.
* https://docs.opengeospatial.org/is/12-007r2/12-007r2.html
*
* @author Sandor Dornbush
* @author Rodrigo Damazio
Expand All @@ -58,6 +59,8 @@ public class KMLTrackExporter implements TrackExporter {
private static final String TRACK_STYLE = "track";
private static final String SCHEMA_ID = "schema";

public static final String EXTENDED_DATA_TYPE_CATEGORY = "type";

public static final String EXTENDED_DATA_TYPE_SPEED = "speed";
public static final String EXTENDED_DATA_TYPE_DISTANCE = "distance";
public static final String EXTENDED_DATA_TYPE_CADENCE = "cadence";
Expand Down Expand Up @@ -224,11 +227,13 @@ void close() {
private void writeHeader(Track[] tracks) {
if (printWriter != null) {
printWriter.println("<?xml version=\"1.0\" encoding=\"UTF-8\"?>");
printWriter.println("<kml xmlns=\"http://www.opengis.net/kml/2.2\"");
printWriter.println("xmlns:gx=\"http://www.google.com/kml/ext/2.2\"");
printWriter.println("<kml xmlns=\"http://www.opengis.net/kml/2.3\"");
printWriter.println("xmlns:atom=\"http://www.w3.org/2005/Atom\"");
printWriter.println("xmlns:opentracks=\"http://opentracksapp.com/xmlschemas/v1\">");
//TODO ADD xsi:schemaLocation here!
//TODO ADD xsi:schemaLocation for atom
printWriter.println("xsi:schemaLocation=" +
"\"http://www.opengis.net/kml/2.3 http://schemas.opengis.net/kml/2.3/ogckml23.xsd"
+ " http://opentracksapp.com/xmlschemas/v1 http://opentracksapp.com/xmlschemas/OpenTracks_v1.xsd\">");

printWriter.println("<Document>");
printWriter.println("<open>1</open>");
Expand Down Expand Up @@ -309,24 +314,24 @@ private void writeBeginTrack(Track track) {

printWriter.println("<styleUrl>#" + TRACK_STYLE + "</styleUrl>");
writeCategory(track.getCategory());
printWriter.println("<gx:MultiTrack>");
printWriter.println("<MultiTrack>");
printWriter.println("<altitudeMode>absolute</altitudeMode>");
printWriter.println("<gx:interpolate>1</gx:interpolate>");
printWriter.println("<interpolate>1</interpolate>");
}
}


private void writeEndTrack() {
if (printWriter != null) {
printWriter.println("</gx:MultiTrack>");
printWriter.println("</MultiTrack>");
printWriter.println("</Placemark>");
}
}

@VisibleForTesting
void writeOpenSegment() {
if (printWriter != null) {
printWriter.println("<gx:Track>");
printWriter.println("<Track>");
speedList.clear();
distanceList.clear();
powerList.clear();
Expand Down Expand Up @@ -373,7 +378,7 @@ void writeCloseSegment() {
}
printWriter.println("</SchemaData>");
printWriter.println("</ExtendedData>");
printWriter.println("</gx:Track>");
printWriter.println("</Track>");
}
}

Expand All @@ -383,9 +388,9 @@ void writeTrackPoint(ZoneOffset zoneOffset, TrackPoint trackPoint) {
printWriter.println("<when>" + getTime(zoneOffset, trackPoint.getLocation()) + "</when>");

if (trackPoint.hasLocation()) {
printWriter.println("<gx:coord>" + getCoordinates(trackPoint.getLocation(), " ") + "</gx:coord>");
printWriter.println("<coord>" + getCoordinates(trackPoint.getLocation(), " ") + "</coord>");
} else {
printWriter.println("<gx:coord/>");
printWriter.println("<coord/>");
}
speedList.add(trackPoint.hasSpeed() ? (float) trackPoint.getSpeed().toMPS() : null);

Expand All @@ -408,16 +413,16 @@ void writeTrackPoint(ZoneOffset zoneOffset, TrackPoint trackPoint) {
* @param name the name of the simple array data
*/
private void writeSimpleArrayData(List<Float> list, String name) {
printWriter.println("<gx:SimpleArrayData name=\"" + name + "\">");
printWriter.println("<SimpleArrayData name=\"" + name + "\">");
for (int i = 0; i < list.size(); i++) {
Float value = list.get(i);
if (value == null) {
printWriter.println("<gx:value />");
printWriter.println("<value />");
} else {
printWriter.println("<gx:value>" + SENSOR_DATA_FORMAT.format(value) + "</gx:value>");
printWriter.println("<value>" + SENSOR_DATA_FORMAT.format(value) + "</value>");
}
}
printWriter.println("</gx:SimpleArrayData>");
printWriter.println("</SimpleArrayData>");
}

/**
Expand Down Expand Up @@ -521,7 +526,7 @@ private void writeCategory(String category) {
return;
}
printWriter.println("<ExtendedData>");
printWriter.println("<Data name=\"type\"><value>" + StringUtils.formatCData(category) + "</value></Data>");
printWriter.println("<Data name=\"" + EXTENDED_DATA_TYPE_CATEGORY + "\"><value>" + StringUtils.formatCData(category) + "</value></Data>");
printWriter.println("</ExtendedData>");
}

Expand Down Expand Up @@ -554,8 +559,8 @@ private void writePlacemarkerStyle() {
* @param extendedDataType the extended data display name
*/
private void writeSimpleArrayStyle(String name, String extendedDataType) {
printWriter.println("<gx:SimpleArrayField name=\"" + name + "\" type=\"float\">");
printWriter.println("<SimpleArrayField name=\"" + name + "\" type=\"float\">");
printWriter.println("<displayName>" + StringUtils.formatCData(extendedDataType) + "</displayName>");
printWriter.println("</gx:SimpleArrayField>");
printWriter.println("</SimpleArrayField>");
}
}
79 changes: 48 additions & 31 deletions src/main/java/de/dennisguse/opentracks/io/file/importer/KmlTrackImporter.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
import de.dennisguse.opentracks.util.StringUtils;

/**
* Imports a KML file.
* Imports a KML file; preferred version: KML2.3, but also supports KML2.2.
*
* @author Jimmy Shih
*/
Expand All @@ -54,18 +54,31 @@ public class KmlTrackImporter extends DefaultHandler implements XMLImporter.Trac
private static final String TAG_COORDINATES = "coordinates";
private static final String TAG_DESCRIPTION = "description";
private static final String TAG_ICON = "icon";
private static final String TAG_GX_COORD = "gx:coord";
private static final String TAG_GX_MULTI_TRACK = "gx:MultiTrack";
private static final String TAG_GX_SIMPLE_ARRAY_DATA = "gx:SimpleArrayData";
private static final String TAG_GX_TRACK = "gx:Track";
private static final String TAG_GX_VALUE = "gx:value";

private static final String TAG_COORD = "coord";
private static final String TAG_KML22_COORD = "gx:coord";

private static final String TAG_MULTI_TRACK = "MultiTrack";
private static final String TAG_KML22_MULTI_TRACK = "gx:MultiTrack";

private static final String TAG_DATA_CATEGORY = "Data"; //used for Track.category

private static final String TAG_SIMPLE_ARRAY_DATA = "SimpleArrayData";
private static final String TAG_KML22_SIMPLE_ARRAY_DATA = "gx:SimpleArrayData";

private static final String TAG_TRACK = "Track";
private static final String TAG_KML22_TRACK = "gx:Track";

private static final String TAG_VALUE = "value";
private static final String TAG_KML22_VALUE = "gx:value";

private static final String TAG_HREF = "href";
private static final String TAG_KML = "kml";
private static final String TAG_NAME = "name";
private static final String TAG_PHOTO_OVERLAY = "PhotoOverlay";
private static final String TAG_PLACEMARK = "Placemark";
private static final String TAG_STYLE_URL = "styleUrl";
private static final String TAG_VALUE = "value";
// private static final String TAG_VALUE = "value"; TODO
private static final String TAG_WHEN = "when";
private static final String TAG_UUID = "opentracks:trackid";

Expand All @@ -81,7 +94,7 @@ public class KmlTrackImporter extends DefaultHandler implements XMLImporter.Trac
private final ArrayList<Instant> whenList = new ArrayList<>();
private final ArrayList<Location> locationList = new ArrayList<>();

private String extendedDataType;
private String dataType;
private final ArrayList<Float> sensorSpeedList = new ArrayList<>();
private final ArrayList<Float> sensorDistanceList = new ArrayList<>();
private final ArrayList<Float> sensorCadenceList = new ArrayList<>();
Expand Down Expand Up @@ -128,17 +141,21 @@ public void startElement(String uri, String localName, String tag, Attributes at
// Note that a track is contained in a Placemark, calling onMarkerStart will clear various track variables like name, category, and description.
onMarkerStart();
break;
case TAG_GX_MULTI_TRACK:
case TAG_MULTI_TRACK:
case TAG_KML22_MULTI_TRACK:
trackImporter.newTrack();
break;
case TAG_GX_TRACK:
case TAG_TRACK:
case TAG_KML22_TRACK:
if (trackImporter == null) {
throw new SAXException("No " + TAG_GX_MULTI_TRACK);
throw new SAXException("Missing " + TAG_MULTI_TRACK);
}
onTrackSegmentStart();
break;
case TAG_GX_SIMPLE_ARRAY_DATA:
onExtendedDataStart(attributes);
case TAG_DATA_CATEGORY:
case TAG_SIMPLE_ARRAY_DATA:
case TAG_KML22_SIMPLE_ARRAY_DATA:
dataType = attributes.getValue(ATTRIBUTE_NAME);
break;
}
}
Expand All @@ -162,18 +179,28 @@ public void endElement(String uri, String localName, String tag) throws SAXExcep
case TAG_COORDINATES:
onMarkerLocationEnd();
break;
case TAG_GX_MULTI_TRACK:
case TAG_MULTI_TRACK:
case TAG_KML22_MULTI_TRACK:
trackImporter.setTrack(context, name, uuid, description, category, icon, zoneOffset);
zoneOffset = null;
break;
case TAG_GX_TRACK:
case TAG_TRACK:
case TAG_KML22_TRACK:
onTrackSegmentEnd();
break;
case TAG_GX_COORD:
case TAG_COORD:
case TAG_KML22_COORD:
onCoordEnded();
break;
case TAG_GX_VALUE:
onExtendedDataValueEnd();
case TAG_VALUE:
case TAG_KML22_VALUE:
if (KMLTrackExporter.EXTENDED_DATA_TYPE_CATEGORY.equals(dataType)) {
if (content != null) {
category = content.trim();
}
} else {
onExtendedDataValueEnd();
}
break;
case TAG_NAME:
if (content != null) {
Expand All @@ -195,11 +222,6 @@ public void endElement(String uri, String localName, String tag) throws SAXExcep
icon = content.trim();
}
break;
case TAG_VALUE:
if (content != null) {
category = content.trim();
}
break;
case TAG_WHEN:
if (content != null) {
try {
Expand Down Expand Up @@ -401,11 +423,6 @@ private Location createLocation(String longitude, String latitude, String altitu
return location;
}


private void onExtendedDataStart(Attributes attributes) {
extendedDataType = attributes.getValue(ATTRIBUTE_NAME);
}

private void onExtendedDataValueEnd() throws SAXException {
Float value = null;
if (content != null) {
Expand All @@ -414,11 +431,11 @@ private void onExtendedDataValueEnd() throws SAXException {
try {
value = Float.parseFloat(content);
} catch (NumberFormatException e) {
throw new SAXException(createErrorMessage("Unable to parse gx:value:" + content), e);
throw new SAXException(createErrorMessage("Unable to parse value:" + content), e);
}
}
}
switch (extendedDataType) {
switch (dataType) {
case KMLTrackExporter.EXTENDED_DATA_TYPE_SPEED:
sensorSpeedList.add(value);
break;
Expand Down Expand Up @@ -447,7 +464,7 @@ private void onExtendedDataValueEnd() throws SAXException {
accuracyVertical.add(value);
break;
default:
Log.w(TAG, "Data from extended data " + extendedDataType + " is not (yet) supported.");
Log.w(TAG, "Data from extended data " + dataType + " is not (yet) supported.");
}
}

Expand Down

0 comments on commit 82fe859

Please sign in to comment.