org.opentripplanner.updater.bike_park.KmlBikeParkDataSource Maven / Gradle / Ivy

package org.opentripplanner.updater.bike_park;

import java.util.List;
import java.util.Locale;

import org.opentripplanner.routing.bike_park.BikePark;
import org.opentripplanner.updater.UpdaterDataSourceParameters;
import org.opentripplanner.util.xml.XmlDataListDownloader;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Load bike park from a KML placemarks. Use name as bike park name and point coordinates. Rely on:
 * 1) bike park to be KML Placemarks, 2) geometry to be Point.
 * 
 * Bike park-and-ride and "OV-fiets mode" development has been funded by GoAbout
 * (https://goabout.com/).
 * 
 * @author laurent
 * @author GoAbout
 */
public class KmlBikeParkDataSource implements BikeParkDataSource {

    private static final Logger LOG = LoggerFactory.getLogger(KmlBikeParkDataSource.class);

    private String url;

    private String namePrefix = null;

    private final boolean zip;

    private final XmlDataListDownloader xmlDownloader;

    private List bikeParks;

    public KmlBikeParkDataSource(Parameters config) {
        xmlDownloader = new XmlDataListDownloader<>();
        xmlDownloader
                .setPath("//*[local-name()='kml']/*[local-name()='Document']/*[local-name()='Placemark']|//*[local-name()='kml']/*[local-name()='Document']/*[local-name()='Folder']/*[local-name()='Placemark']");
        xmlDownloader.setDataFactory(attributes -> {
            BikePark bikePark = new BikePark();
            if (!attributes.containsKey("name")) {
                LOG.warn("Missing name in KML Placemark, cannot create bike park.");
                return null;
            }
            if (!attributes.containsKey("Point")) {
                LOG.warn("Missing Point geometry in KML Placemark, cannot create bike park.");
                return null;
            }
            bikePark.name = attributes.get("name").trim();
            if (namePrefix != null)
                bikePark.name = namePrefix + bikePark.name;
            String[] coords = attributes.get("Point").trim().split(",");
            bikePark.x = Double.parseDouble(coords[0]);
            bikePark.y = Double.parseDouble(coords[1]);
            // There is no ID in KML, assume unique names and location.
            bikePark.id = String.format(Locale.US, "%s[%.3f-%.3f]",
                    bikePark.name.replace(" ", "_"), bikePark.x, bikePark.y);
            return bikePark;
        });
        url = config.getUrl();
        namePrefix = config.getNamePrefix();
        zip = config.zip();
    }

    /**
     * Update the data from the source;
     * 
     * @return true if there might have been changes
     */
    @Override
    public boolean update() {
        List newBikeParks = xmlDownloader.download(url, zip);
        if (newBikeParks != null) {
            synchronized (this) {
                // Update atomically
                bikeParks = newBikeParks;
            }
            return true;
        }
        return false;
    }

    @Override
    public synchronized List getBikeParks() {
        return bikeParks;
    }

    @Override
    public String toString() {
        return getClass().getName() + "(" + url + ")";
    }

    public void setUrl (String url) {this.url = url;}

    public interface Parameters extends UpdaterDataSourceParameters {
        String getNamePrefix();
        boolean zip();
    }
}