Station.java

package uk.co.traintrackapp.traintrack.model;

import android.support.annotation.NonNull;

import org.json.JSONArray;
import org.json.JSONException;
import org.json.JSONObject;

import java.io.Serializable;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Locale;

import uk.co.traintrackapp.traintrack.utils.Utils;

public class Station implements Comparable, Serializable {

    public static final String FILENAME = "stations.json";
    protected static final String DEFAULT_NAME = "Unknown";

    private int id;
    private String uuid;
    private String name;
    private String crs;
    private Double lat;
    private Double lng;
    private boolean isUnderground;
    private boolean isNationalRail;
    private String address;
    private String phone;
    private String twitter;
    private String undergroundZones;
    private HashMap<String, String> facilities;
    private int distance;

    public Station() {
        this.id = 0;
        this.uuid = "";
        this.name = DEFAULT_NAME;
        this.crs = "";
        this.lat = null;
        this.lng = null;
        this.isUnderground = false;
        this.isNationalRail = false;
        this.phone = "";
        this.twitter = "";
        this.undergroundZones = "";
        this.facilities = new HashMap<>();
        this.distance = 0;
    }

    public Station(JSONObject json) {
        this();
        try {
            this.id = json.getInt("id");
            this.uuid = json.getString("uuid");
            this.name = json.getString("name");
            this.crs = json.getString("crs");
            this.lat = json.getDouble("lat");
            this.lng = json.getDouble("lng");
            this.isUnderground = json.getBoolean("underground");
            this.isNationalRail = json.getBoolean("national_rail");
            if (!json.isNull("address")) {
                this.address = json.getString("address");
            }
            if (!json.isNull("phone")) {
                this.phone = json.getString("phone");
            }
            if (!json.isNull("twitter")) {
                this.twitter = json.getString("twitter");
            }
            if (!json.isNull("underground_zones")) {
                this.undergroundZones = json.getString("underground_zones");
            }
            JSONArray facilities = json.getJSONArray("facilities");
            for (int i = 0; i < facilities.length(); i++) {
                JSONObject facility = facilities.getJSONObject(i);
                Iterator<String> keys = facility.keys();
                while (keys.hasNext()) {
                    String key = keys.next();
                    this.facilities.put(key, facility.getString(key));
                }
            }
        } catch (JSONException e) {
            Utils.log(e.getMessage());
        }
    }

    /**
     *
     * @return the id
     */
    public int getId() {
        return id;
    }

    /**
     * @return the uuid
     */
    public String getUuid() {
        return uuid;
    }

    /**
     * @return the name
     */
    public String getName() {
        return name;
    }

    /*
     * @return the crsCode
     */
    public String getCrsCode() {
        return crs;
    }

    /**
     * @return the latitude
     */
    public Double getLatitude() {
        return lat;
    }

    /**
     * @return the longitude
     */
    public Double getLongitude() {
        return lng;
    }

    /**
     * @return true if underground station
     */
    public boolean isUnderground() {
        return isUnderground;
    }

    /**
     * @return the true if national rail station
     */
    public boolean isNationalRail() {
        return isNationalRail;
    }

    /**
     * @return address of the station
     */
    public String getAddress() {
        return address;
    }

    /**
      * @return phone number of the station
     */
    public String getPhone() {
        return phone;
    }

    /**
     * @return twitter handle of the station
     */
    public String getTwitter() {
        return twitter;
    }

    /**
     * @return underground zones if underground station
     */
    public String getUndergroundZones() {
        return undergroundZones;
    }

    /**
     * @return map of facilities
     */
    public HashMap<String, String> getFacilities() {
        return facilities;
    }

    /**
     * @param distance (in m)
     */
    public void setDistance(int distance) {
        this.distance = distance;
    }

    /**
     * @return distance (m)
     */
    public int getDistance() {
        return distance;
    }

    /**
     * @param unit km or mi
     * @return text representation of distance
     */
    public String getDistanceText(String unit) {
        int distance = getDistance();
        String format = "";
        if (unit.equals("mi")) {
            if (distance > 1609) {
                distance = distance / 1609;
                format = "%d mi";
            } else if (distance > 0) {
                    format = "%d m";
            }
        } else if (unit.equals("km")) {
            if (distance > 1000) {
                distance = distance / 1000;
                format = "%d km";
            } else if (distance > 0) {
                format = "%d m";
            }
        }
        return String.format(Locale.getDefault(), format, distance);
    }

    /**
     * @param string the string to look for in the name
     * @return true if string is within name
     */
    public boolean isNameSimilarTo(CharSequence string) {
        String query = string.toString().toLowerCase(Locale.UK);
        return getName().toLowerCase(Locale.UK).contains(query) ||
                getCrsCode().toLowerCase(Locale.UK).contains(query);
    }

    /**
     * @return the name of the station
     */
    public String toString() {
        return getName();
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }
        Station station = (Station) o;
        return uuid.equals(station.uuid);
    }

    @Override
    public int hashCode() {
        return uuid.hashCode();
    }

    @Override
    public int compareTo(@NonNull Object obj) {
        if (this.getDistance() == 0) {
            return -1;
        }
        if (!(obj instanceof Station)) {
            return -1;
        }
        Station comparison = (Station) obj;
        if (comparison.getDistance() == 0) {
            return -1;
        }
        int comparisonDistance = comparison.getDistance() * 1000;
        int distance = this.getDistance() * 1000;
        return distance - comparisonDistance;
    }

    /**
     *
     * @return JSON Object
     */
    public JSONObject toJson() {
        JSONObject json = new JSONObject();
        try {
            json.put("id", getId());
            json.put("uuid", getUuid());
            json.put("name", getName());
            json.put("crs", getCrsCode());
            json.put("lat", getLatitude());
            json.put("lng", getLongitude());
            json.put("underground", isUnderground());
            json.put("national_rail", isNationalRail());
            json.put("phone", getPhone());
            json.put("twitter", getTwitter());
            json.put("underground_zones", getUndergroundZones());
            JSONArray facilities = new JSONArray();
            for (String key : getFacilities().keySet()) {
                JSONObject facility = new JSONObject();
                facility.put(key, getFacilities().get(key));
                facilities.put(facility);
            }
            json.put("facilities", facilities);
        } catch (JSONException e) {
            Utils.log(e.getMessage());
        }
        return json;
    }

}