org.openimaj.text.geo.WorldPlace Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of geocoder Show documentation
Geocoding and reverse geocoding utilities
There is a newer version: 1.3.10
/**
 * Copyright (c) 2011, The University of Southampton and the individual contributors.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 *   * 	Redistributions of source code must retain the above copyright notice,
 * 	this list of conditions and the following disclaimer.
 *
 *   *	Redistributions in binary form must reproduce the above copyright notice,
 * 	this list of conditions and the following disclaimer in the documentation
 * 	and/or other materials provided with the distribution.
 *
 *   *	Neither the name of the University of Southampton nor the names of its
 * 	contributors may be used to endorse or promote products derived from this
 * 	software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.openimaj.text.geo;

import java.util.List;

import org.openimaj.math.geometry.shape.Shape;

/**
 * @author Sina Samangooei ([email protected])
 *
 */
public class WorldPlace {

	private String countryCode;
	private String name;
	private List geoms;
	private float lat;
	private float lon;

	/**
	 * @param name
	 * @param countryCode
	 * @param lat
	 * @param lon
	 * @param shape
	 */
	public WorldPlace(String name, String countryCode, float lat, float lon, List shape) {
		this.name = name;
		this.countryCode = countryCode;
		this.lat = lat;
		this.lon = lon;
		this.geoms = shape;
	}

	@Override
	public String toString() {
		return String.format("{%s: (%2.2f,%2.2f), Area: %s}", name, lat, lon, calculateArea());
	}

	public double calculateArea() {
		double total = 0;
		for (final Shape geom : this.geoms) {
			total += geom.calculateArea();
		}
		return total;
	}

	/**
	 * @return the shapes of this place
	 */
	public List getShapes() {
		return this.geoms;
	}

	/**
	 * @return the ISOA2 country code
	 */
	public String getISOA2() {
		return this.countryCode;
	}

}