Skip to content

Latest commit

 

History

History
141 lines (111 loc) · 4.6 KB

README.md

File metadata and controls

141 lines (111 loc) · 4.6 KB
Raw

Android Arsenal

Android GPX Parser

NOTICE: I am no longer maintaning this project.

Almost ten years have passed since I started this, and I have no more time to stay up-to-date. I am looking for volounteers to take over this project.

Table of Contents:

  1. Description
  2. Module Structures
  3. Projects using this library
  4. Download
  5. Dependencies
  6. Usage
  7. License

Description

A library to parse GPX files, built for Android. The reference schema is the Topografix GPX 1.1.
In addition, it parses the speed extension, when provided as a double number.

GPX is an XML file format to represent GPS data: coordinates, routes, waypoints, and more.

Pull requests are welcome! Please check the issues and open a pull request when done: you will have made the world a better place.

Module Structure

  1. App: an example usage of the library.
  2. Parser: the library itself.

Projects using this library:

To have your project listed here, please send me an email or open a PR.

Download

Add the Jitpack repository to your root build file. The way you do this depends on the Gradle plugin you are using.

If using Gradle plugin 7.0.0. or newer (default for new apps since Android Studio Artic Fox)

// in settings.gradle
dependencyResolutionManagement {
    ...
    repositories {
        ...
        maven { url 'https://jitpack.io' }
    }
}

For older verions of Gradle:

// in project-level build.gradle
allprojects {
    repositories {
        maven { url 'https://jitpack.io' }
    }
}

Finally, in your dependencies list

dependencies {
    implementation 'com.github.ticofab:android-gpx-parser:2.3.1'
}

Dependencies

The following is an open github repo that has date and time handling. Keep in mind that the following dependency also has dependencies of its own.

Usage

In Java:

GPXParser parser = new GPXParser(); // consider injection
Gpx parsedGpx = null;
try {
    InputStream in = getAssets().open("test.gpx");
    parsedGpx = parser.parse(in); // consider using a background thread
} catch (IOException | XmlPullParserException e) {
    // do something with this exception
    e.printStackTrace();
}
if (parsedGpx == null) {
    // error parsing track
} else {
    // do something with the parsed track
    // see included example app and tests
}

In Kotlin:

val parser = GPXParser() // consider injection
try {
    val input: InputStream = getAssets().open("test.gpx")
    val parsedGpx: Gpx? = parser.parse(input) // consider using a background thread
    parsedGpx?.let {
        // do something with the parsed track
        // see included example app and tests
    } ?: {
        // error parsing track
    }
} catch (e: IOException) {
    // do something with this exception
    e.printStackTrace()
} catch (e: XmlPullParserException) {
    // do something with this exception
    e.printStackTrace()
}

License

Copyright 2015 - 2023 Fabio Tiriticco - Fabway

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.