public-transport-enabler/enabler/src/de/schildbach/pte/dto/Location.java

/*
 * Copyright 2010-2015 the original author or authors.
 *
 * 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
 * (at your option) 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 de.schildbach.pte.dto;

import static com.google.common.base.Preconditions.checkArgument;
import static com.google.common.base.Preconditions.checkNotNull;

import java.io.Serializable;
import java.util.Arrays;
import java.util.Set;

import javax.annotation.Nullable;

import com.google.common.base.MoreObjects;
import com.google.common.base.MoreObjects.ToStringHelper;
import com.google.common.base.Objects;
import com.google.common.base.Strings;

/**
 * @author Andreas Schildbach
 */
public final class Location implements Serializable {
    private static final long serialVersionUID = -2124775933106309127L;

    public final LocationType type;
    public final @Nullable String id;
    public final int lat, lon;
    public final @Nullable String place;
    public final @Nullable String name;
    public final @Nullable Set<Product> products;

    public Location(final LocationType type, final String id, final int lat, final int lon, final String place,
            final String name, final Set<Product> products) {
        this.type = checkNotNull(type);
        this.id = id;
        this.lat = lat;
        this.lon = lon;
        this.place = place;
        this.name = name;
        this.products = products;

        checkArgument(id == null || id.length() > 0, "ID cannot be the empty string");
        checkArgument(place == null || name != null, "place '%s' without name cannot exist", place);
        if (type == LocationType.ANY) {
            checkArgument(id == null, "type ANY cannot have ID");
        } else if (type == LocationType.COORD) {
            checkArgument(hasLocation(), "coordinates missing");
            checkArgument(place == null && name == null, "coordinates cannot have place or name");
        }
    }

    public Location(final LocationType type, final String id, final int lat, final int lon, final String place,
            final String name) {
        this(type, id, lat, lon, place, name, null);
    }

    public Location(final LocationType type, final String id, final Point coord, final String place, final String name,
            final Set<Product> products) {
        this(type, id, coord != null ? coord.lat : 0, coord != null ? coord.lon : 0, place, name, products);
    }

    public Location(final LocationType type, final String id, final Point coord, final String place,
            final String name) {
        this(type, id, coord != null ? coord.lat : 0, coord != null ? coord.lon : 0, place, name);
    }

    public Location(final LocationType type, final String id, final String place, final String name) {
        this(type, id, 0, 0, place, name);
    }

    public Location(final LocationType type, final String id, final int lat, final int lon) {
        this(type, id, lat, lon, null, null);
    }

    public Location(final LocationType type, final String id, final Point coord) {
        this(type, id, coord != null ? coord.lat : 0, coord != null ? coord.lon : 0);
    }

    public Location(final LocationType type, final String id) {
        this(type, id, null, null);
    }

    public static Location coord(final int lat, final int lon) {
        return new Location(LocationType.COORD, null, lat, lon);
    }

    public static Location coord(final Point coord) {
        return new Location(LocationType.COORD, null, coord.lat, coord.lon);
    }

    public final boolean hasId() {
        return !Strings.isNullOrEmpty(id);
    }

    public final boolean hasLocation() {
        return lat != 0 || lon != 0;
    }

    public double getLatAsDouble() {
        return lat / 1E6;
    }

    public double getLonAsDouble() {
        return lon / 1E6;
    }

    public final boolean hasName() {
        return name != null;
    }

    public final boolean isIdentified() {
        if (type == LocationType.STATION)
            return hasId();

        if (type == LocationType.POI)
            return true;

        if (type == LocationType.ADDRESS || type == LocationType.COORD)
            return hasLocation();

        return false;
    }

    private static final String[] NON_UNIQUE_NAMES = { "Hauptbahnhof", "Hbf", "Bahnhof", "Bf", "Busbahnhof", "ZOB",
            "Schiffstation", "Schiffst.", "Zentrum", "Markt", "Dorf", "Kirche", "Nord", "Ost", "Süd", "West" };

    static {
        Arrays.sort(NON_UNIQUE_NAMES);
    }

    public final String uniqueShortName() {
        if (place != null && name != null && Arrays.binarySearch(NON_UNIQUE_NAMES, name) >= 0)
            return place + ", " + name;
        else if (name != null)
            return name;
        else if (hasId())
            return id;
        else
            return null;
    }

    @Override
    public boolean equals(final Object o) {
        if (o == this)
            return true;
        if (!(o instanceof Location))
            return false;
        final Location other = (Location) o;
        if (!Objects.equal(this.type, other.type))
            return false;
        if (this.id != null)
            return Objects.equal(this.id, other.id);
        if (this.lat != 0 && this.lon != 0)
            return this.lat == other.lat && this.lon == other.lon;

        // only discriminate by name/place if no ids are given
        if (!Objects.equal(this.place, other.place))
            return false;
        if (!Objects.equal(this.name, other.name))
            return false;
        return true;
    }

    public boolean equalsAllFields(final Location other) {
        if (other == this)
            return true;
        if (other == null)
            return false;
        if (!Objects.equal(this.type, other.type))
            return false;
        if (!Objects.equal(this.id, other.id))
            return false;
        if (this.lat != other.lat && this.lon != other.lon)
            return false;
        if (!Objects.equal(this.place, other.place))
            return false;
        if (!Objects.equal(this.name, other.name))
            return false;
        if (!Objects.equal(this.products, other.products))
            return false;
        return true;
    }

    @Override
    public int hashCode() {
        if (id != null)
            return Objects.hashCode(type, id);
        else
            return Objects.hashCode(type, lat, lon);
    }

    @Override
    public String toString() {
        final ToStringHelper helper = MoreObjects.toStringHelper(this).addValue(type).addValue(id);
        if (hasLocation())
            helper.addValue(lat + "/" + lon);
        return helper.add("place", place).add("name", name).add("products", products).omitNullValues().toString();
    }
}