Android Open Source - getback_gps Stored Location

From Project

Back to project page getback_gps.
License

The source code is released under:
GNU General Public License
If you think the Android project getback_gps listed in this page is inappropriate, such as containing malicious code/tools or violating the copyright, please email info at java2s dot com, thanks.
Java Source Code

/**
 * StoredLocation//from  w ww .  j av  a 2  s  .  c o  m
 *
 * Copyright (C) 2012-2015 Dieter Adriaenssens
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * @package com.github.ruleant.getback_gps.lib
 * @author  Dieter Adriaenssens <ruleant@users.sourceforge.net>
 */
package com.github.ruleant.getback_gps.lib;

import android.content.Context;
import android.content.SharedPreferences;
import android.location.Location;

import java.util.Locale;

/**
 * StoredLocation saves a location, it will store a location for future use,
 * and will the save the location when the application is stopped.
 *
 * @author Dieter Adriaenssens <ruleant@users.sourceforge.net>
 */
public class StoredLocation {
    /**
     * Selected Location.
     */
    private AriadneLocation mLocation;
    /**
     * If a location was set.
     */
    private boolean mHasLocation;
    /**
     * SharedPreference object.
     */
    private SharedPreferences mPrefs;
    /**
     * SharedPreferences location for LocationStore class.
     */
    public static final String DEFAULT_PREF_NAME = "stored_location";
    /**
     * Name of Saved object in SharedPreferences.
     */
    private static final String SAVED = "saved";
    /**
     * Name of Longitude object in SharedPreferences.
     */
    private static final String LONGITUDE = "longitude";
    /**
     * Name of Latitude object in SharedPreferences.
     */
    private static final String LATITUDE = "latitude";
    /**
     * Name of Altitude object in SharedPreferences.
     */
    private static final String ALTITUDE = "altitude";
    /**
     * Name of hasAltitude object in SharedPreferences.
     */
    private static final String HAS_ALTITUDE = "has_altitude";
    /**
     * Name of Bearing object in SharedPreferences.
     */
    private static final String BEARING = "bearing";
    /**
     * Name of hasBearing object in SharedPreferences.
     */
    private static final String HAS_BEARING = "has_bearing";
    /**
     * Name of Speed object in SharedPreferences.
     */
    private static final String SPEED = "speed";
    /**
     * Name of hasSpeed object in SharedPreferences.
     */
    private static final String HAS_SPEED = "has_speed";
    /**
     * Name of Accuracy object in SharedPreferences.
     */
    private static final String ACCURACY = "accuracy";
    /**
     * Name of hasAccuracy object in SharedPreferences.
     */
    private static final String HAS_ACCURACY = "has_accuracy";
    /**
     * Name of Timestamp object in SharedPreferences.
     */
    private static final String TIMESTAMP = "timestamp";
    /**
     * Name of Location provider object in SharedPreferences.
     */
    private static final String LOC_PROVIDER = "loc_provider";
    /**
     * Location Name object in SharedPreferences.
     */
    private static final String LOC_NAME = "loc_name";

    /**
     * Constructor.
     *
     * @param context        Context of the Android app
     * @param sharedPrefName Name of Shared Preferences file name
     * @throws IllegalArgumentException if context is not defined
     */
    public StoredLocation(final Context context, final String sharedPrefName) {
        if (context == null) {
            throw new IllegalArgumentException("context is not defined");
        }

        mLocation = new AriadneLocation("");
        mHasLocation = false;

        String prefName;

        if (sharedPrefName == null || sharedPrefName.length() == 0) {
            prefName = DEFAULT_PREF_NAME;
        } else {
            prefName = sharedPrefName;
        }

        mPrefs = context.getSharedPreferences(
                prefName, Context.MODE_PRIVATE
        );

        restore();
    }

    /**
     * Get Location.
     *
     * @return Location location
     */
    public final AriadneLocation getLocation() {
        if (mHasLocation) {
            return mLocation;
        }

        return null;
    }

    /**
     * Set Location.
     *
     * @param location New location
     */
    public void setLocation(final AriadneLocation location) {
        if (location != null) {
            mLocation = location;
            mHasLocation = true;
        }
    }

    /**
     * Save stored location in Shared Preferences.
     *
     * @param location New location
     */
    public final void save(final AriadneLocation location) {
        setLocation(location);
        save();
    }

    /**
     * Save stored location in Shared Preferences.
     */
    public final void save() {
        /* Set Locale temporarily to US English to make sure that the data
         * is always stored with the same locale, to avoid data loss
         * when the default locale of the device is changed.
         */
        Locale originalLocale = Locale.getDefault();
        Locale.setDefault(Locale.US);

        // save location to a SharedPreferences file
        SharedPreferences.Editor editor = mPrefs.edit();

        // only save if Location is set
        if (mLocation != null && mHasLocation) {
            editor.putString(
                    LONGITUDE,
                    Location.convert(
                            mLocation.getLongitude(), Location.FORMAT_DEGREES
                    )
            );
            editor.putString(
                    LATITUDE,
                    Location.convert(
                            mLocation.getLatitude(), Location.FORMAT_DEGREES
                    )
            );

            // save altitude, if defined
            editor.putString(
                    HAS_ALTITUDE, Boolean.toString(mLocation.hasAltitude()));
            if (mLocation.hasAltitude()) {
                editor.putString(
                        ALTITUDE, Double.toString(mLocation.getAltitude()));
            }

            // save bearing, if defined
            editor.putString(
                    HAS_BEARING, Boolean.toString(mLocation.hasBearing()));
            if (mLocation.hasBearing()) {
                editor.putString(
                        BEARING, Float.toString(mLocation.getBearing()));
            }

            // save speed, if defined
            editor.putString(
                    HAS_SPEED, Boolean.toString(mLocation.hasSpeed()));
            if (mLocation.hasSpeed()) {
                editor.putString(
                        SPEED, Float.toString(mLocation.getSpeed()));
            }

            // save accuracy, if defined
            editor.putString(
                    HAS_ACCURACY, Boolean.toString(mLocation.hasAccuracy()));
            if (mLocation.hasAccuracy()) {
                editor.putString(
                        ACCURACY, Float.toString(mLocation.getAccuracy()));
            }

            editor.putLong(TIMESTAMP, mLocation.getTime());
            editor.putString(LOC_PROVIDER, mLocation.getProvider());
            editor.putString(LOC_NAME, mLocation.getName());
        }
        editor.putString(
                SAVED, Boolean.toString(mLocation != null && mHasLocation));
        // Commit the edits!
        editor.commit();

        // set default locale back to original
        Locale.setDefault(originalLocale);
    }

    /**
     * Restore stored location from Shared Preferences.
     */
    public final void restore() {
        AriadneLocation location = new AriadneLocation("");

        // Check if a location is stored.
        // The SAVED parameter is set to true when a location is saved,
        // so if it does not exist (its default value is false),
        // then its value is false and there is no saved location data.
        // return (exit method) when not set or exception is thrown
        try {
            mHasLocation
                    = Boolean.parseBoolean(mPrefs.getString(SAVED, "false"));
            if (!mHasLocation) {
                return;
            }
        } catch (Exception e) {
            e.printStackTrace();
            return;
        }

        // retrieve longitude and latitude,
        // return null when not set or exception is thrown
        try {
            location.setLongitude(
                    Location.convert(mPrefs.getString(LONGITUDE, "0.0"))
            );
            location.setLatitude(
                    Location.convert(mPrefs.getString(LATITUDE, "0.0"))
            );
        } catch (Exception e) {
            e.printStackTrace();
            return;
        }

        // retrieve altitude, if defined
        try {
            if (Boolean.parseBoolean(mPrefs.getString(HAS_ALTITUDE, "false"))) {
                location.setAltitude(
                        Double.parseDouble(mPrefs.getString(ALTITUDE, "0.0")));
            }
        } catch (Exception e) {
            e.printStackTrace();
        }

        // retrieve bearing, if defined
        try {
            if (Boolean.parseBoolean(mPrefs.getString(HAS_BEARING, "false"))) {
                location.setBearing(
                        Float.parseFloat(mPrefs.getString(BEARING, "0.0")));
            }
        } catch (Exception e) {
            e.printStackTrace();
        }

        // retrieve speed, if defined
        try {
            if (Boolean.parseBoolean(mPrefs.getString(HAS_SPEED, "false"))) {
                location.setSpeed(
                        Float.parseFloat(mPrefs.getString(SPEED, "0.0")));
            }
        } catch (Exception e) {
            e.printStackTrace();
        }

        // retrieve accuracy, if defined
        try {
            if (Boolean.parseBoolean(mPrefs.getString(HAS_ACCURACY, "false"))) {
                location.setAccuracy(
                        Float.parseFloat(mPrefs.getString(ACCURACY, "0.0"))
                );
            }
        } catch (Exception e) {
            e.printStackTrace();
        }

        // retrieve time stamp
        try {
            location.setTime(mPrefs.getLong(TIMESTAMP, 0));
        } catch (Exception e) {
            e.printStackTrace();
            location.setTime(0);
        }

        // retrieve location provider
        try {
            location.setProvider(mPrefs.getString(LOC_PROVIDER, ""));
        } catch (Exception e) {
            e.printStackTrace();
            location.setProvider("");
        }

        // retrieve location name
        try {
            location.setName(mPrefs.getString(LOC_NAME, null));
        } catch (Exception e) {
            e.printStackTrace();
        }

        // set retrieved location
        setLocation(location);
    }
}
Java Source Code List
