Location.java

/*
 * Copyright 2010, 2011 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 java.io.Serializable;

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

	public final LocationType type;
	public final int id;
	public final int lat, lon;
	public final String place;
	public final String name;

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

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

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

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

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

	public final boolean hasId()
	{
		return id != 0;
	}

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

	public final String uniqueShortName()
	{
		if ("Bahnhof".equals(name) || "Dorf".equals(name) || "Kirche".equals(name))
			return place + ", " + name;
		else
			return name;
	}

	@Override
	public String toString()
	{
		return name; // invoked by AutoCompleteTextView in landscape orientation
	}

	public String toDebugString()
	{
		return "[" + type + " " + id + " " + lat + "/" + lon + " " + (place != null ? "'" + place + "'" : "null") + " '" + name + "']";
	}

	@Override
	public boolean equals(Object o)
	{
		if (o == this)
			return true;
		if (!(o instanceof Location))
			return false;
		final Location other = (Location) o;
		if (this.type != other.type)
			return false;
		if (this.id != 0 && this.id == other.id)
			return true;
		if (this.lat != 0 && this.lon != 0 && this.lat == other.lat && this.lon == other.lon)
			return true;
		if (!nullSafeEquals(this.name, other.name)) // only discriminate by name if no ids are given
			return false;
		return true;
	}

	@Override
	public int hashCode()
	{
		int hashCode = 0;
		hashCode += type.hashCode();
		hashCode *= 29;
		if (id != 0)
		{
			hashCode += id;
		}
		else if (lat != 0 || lon != 0)
		{
			hashCode += lat;
			hashCode *= 29;
			hashCode += lon;
		}
		return hashCode;
	}

	private boolean nullSafeEquals(final Object o1, final Object o2)
	{
		if (o1 == null && o2 == null)
			return true;
		if (o1 != null && o1.equals(o2))
			return true;
		return false;
	}

	private int nullSafeHashCode(final Object o)
	{
		if (o == null)
			return 0;
		return o.hashCode();
	}
}