001/**
002 * Copyright (c) 2011, The University of Southampton and the individual contributors.
003 * All rights reserved.
004 *
005 * Redistribution and use in source and binary forms, with or without modification,
006 * are permitted provided that the following conditions are met:
007 *
008 *   *  Redistributions of source code must retain the above copyright notice,
009 *      this list of conditions and the following disclaimer.
010 *
011 *   *  Redistributions in binary form must reproduce the above copyright notice,
012 *      this list of conditions and the following disclaimer in the documentation
013 *      and/or other materials provided with the distribution.
014 *
015 *   *  Neither the name of the University of Southampton nor the names of its
016 *      contributors may be used to endorse or promote products derived from this
017 *      software without specific prior written permission.
018 *
019 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
020 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
021 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
022 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
023 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
024 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
025 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
026 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
027 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
028 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
029 */
030package org.openimaj.text.geo;
031
032import java.util.List;
033
034import org.openimaj.math.geometry.shape.Shape;
035
036/**
037 * @author Sina Samangooei (ss@ecs.soton.ac.uk)
038 *
039 */
040public class WorldPlace {
041
042        private String countryCode;
043        private String name;
044        private List<Shape> geoms;
045        private float lat;
046        private float lon;
047
048        /**
049         * @param name
050         * @param countryCode
051         * @param lat
052         * @param lon
053         * @param shape
054         */
055        public WorldPlace(String name, String countryCode, float lat, float lon, List<Shape> shape) {
056                this.name = name;
057                this.countryCode = countryCode;
058                this.lat = lat;
059                this.lon = lon;
060                this.geoms = shape;
061        }
062
063        @Override
064        public String toString() {
065                return String.format("{%s: (%2.2f,%2.2f), Area: %s}", name, lat, lon, calculateArea());
066        }
067
068        public double calculateArea() {
069                double total = 0;
070                for (final Shape geom : this.geoms) {
071                        total += geom.calculateArea();
072                }
073                return total;
074        }
075
076        /**
077         * @return the shapes of this place
078         */
079        public List<Shape> getShapes() {
080                return this.geoms;
081        }
082
083        /**
084         * @return the ISOA2 country code
085         */
086        public String getISOA2() {
087                return this.countryCode;
088        }
089
090}