PhotonDoc.java

package de.komoot.photon;

import com.neovisionaries.i18n.CountryCode;
import com.vividsolutions.jts.geom.Envelope;
import com.vividsolutions.jts.geom.Point;

import lombok.Getter;
import lombok.Setter;

import java.util.HashSet;
import java.util.Map;
import java.util.Set;

/**
 * denormalized doc with all information needed be dumped to elasticsearch
 *
 * @author christoph
 */
@Getter
@Setter
public class PhotonDoc {
	final private long placeId;
	final private String osmType;
	final private long osmId;
	final private String tagKey;
	final private String tagValue;
	final private Map<String, String> name;
	private String postcode;
	final private Map<String, String> extratags;
	final private Envelope bbox;
	final private long parentPlaceId; // 0 if unset
	final private double importance;
	final private CountryCode countryCode;
	final private long linkedPlaceId; // 0 if unset
	final private int rankSearch;

	private Map<String, String> street;
	private Map<String, String> city;
	private Set<Map<String, String>> context = new HashSet<Map<String, String>>();
	private Map<String, String> country;
	private Map<String, String> state;
	private String houseNumber;
	private Point centroid;

	public PhotonDoc(long placeId, String osmType, long osmId, String tagKey, String tagValue, Map<String, String> name, String houseNumber, Map<String, String> extratags, Envelope bbox, long parentPlaceId, double importance, CountryCode countryCode, Point centroid, long linkedPlaceId, int rankSearch) {
		String place = extratags != null ? extratags.get("place") : null;
		if(place != null) {
			// take more specific extra tag information
			tagKey = "place";
			tagValue = place;
		}

		this.placeId = placeId;
		this.osmType = osmType;
		this.osmId = osmId;
		this.tagKey = tagKey;
		this.tagValue = tagValue;
		this.name = name;
		this.houseNumber = houseNumber;
		this.extratags = extratags;
		this.bbox = bbox;
		this.parentPlaceId = parentPlaceId;
		this.importance = importance;
		this.countryCode = countryCode;
		this.centroid = centroid;
		this.linkedPlaceId = linkedPlaceId;
		this.rankSearch = rankSearch;
	}

	public PhotonDoc(PhotonDoc other) {
		this.placeId = other.placeId;
		this.osmType = other.osmType;
		this.osmId = other.osmId;
		this.tagKey = other.tagKey;
		this.tagValue = other.tagValue;
		this.name = other.name;
		this.houseNumber = other.houseNumber;
		this.postcode = other.postcode;
		this.extratags = other.extratags;
		this.bbox = other.bbox;
		this.parentPlaceId = other.parentPlaceId;
		this.importance = other.importance;
		this.countryCode = other.countryCode;
		this.centroid = other.centroid;
		this.linkedPlaceId = other.linkedPlaceId;
		this.rankSearch = other.rankSearch;
		this.street = other.street;
		this.city = other.city;
		this.context = other.context;
		this.country = other.country;
		this.state = other.state;
	}

	public String getUid()
	{
		if (houseNumber == null || houseNumber.isEmpty())
			return String.valueOf(placeId);
		else
			return String.valueOf(placeId) + "." + houseNumber;
	}

	/**
	 * Used for testing - really all variables required (final)?
	 */
	public static PhotonDoc create(long placeId, String osmType, long osmId, Map<String, String> nameMap) {
		return new PhotonDoc(placeId, osmType, osmId, "", "", nameMap,
				"", null, null, 0, 0, null, null, 0, 0);
	}

	public boolean isUsefulForIndex() {
		if("place".equals(tagKey) && "houses".equals(tagValue)) return false;

		if(houseNumber != null) return true;

		if(name.isEmpty()) return false;
                
                if(linkedPlaceId > 0) return false;

		return true;
	}
}