org.openimaj.vis.world.WorldPolygons Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of visualisations Show documentation
A library that contains classes for visualising various different features, such as audio and video.
There is a newer version: 1.3.5
/**
 * 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.vis.world;

import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;

import org.openimaj.math.geometry.point.Point2d;
import org.openimaj.math.geometry.point.Point2dImpl;
import org.openimaj.math.geometry.shape.Polygon;
import org.openimaj.math.geometry.shape.Rectangle;
import org.openimaj.math.geometry.shape.Shape;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;

/**
 * 	A class that encapsulates all the countries in the world, their shapes and
 * 	their codes. Allows mapping a country code to a specific geometry.
 *
 * 	@author Sina Samangooei ([email protected])
 * 	@author David Dupplaw ([email protected])
 */
public class WorldPolygons
{
	/** The XML document that contains the data */
	private static Document doc;

	/**
	 * 	Here we read in the country data from the XML document.
	 * 	Happens only once at the instantiation of the class.
	 * 	It doesn't instantiate the actual data because we may
	 * 	want multiple instances of this class containing different
	 * 	information.
	 */
	static
	{
		// Create a document building to read in the XML
		final DocumentBuilderFactory dbFactory = DocumentBuilderFactory.newInstance();

		try
		{
			// Read in the document from the countries XML file
			final DocumentBuilder dBuilder = dbFactory.newDocumentBuilder();
			WorldPolygons.doc = dBuilder.parse(
				WorldPolygons.class.getResourceAsStream( "countries_world.kml" ) );

		}
		catch( final Exception e )
		{
			throw new RuntimeException( e );
		}
	}

	/** The shapes of the countries keyed via the country code */
	private final Map countryShapes;

	private final Map countryCodeShapes;

	private final Rectangle bounds;

	/**
	 *	Default constructor
	 */
	public WorldPolygons()
	{
		this.countryShapes = new HashMap();
		this.countryCodeShapes = new HashMap();

		// Parse through the XML document and create the items.
		WorldPolygons.doc.getDocumentElement().normalize();
		final NodeList places = WorldPolygons.doc.getElementsByTagName( "Placemark" );
		float minx = Integer.MAX_VALUE, miny = Integer.MAX_VALUE,
				maxx = -Integer.MAX_VALUE, maxy = -Integer.MAX_VALUE;

		// For each place...
		for( int i = 0; i < places.getLength(); i++ )
		{
			final Node placeNode = places.item( i );

			/**
			 * [name: null] [description: null] [LookAt: null] [Style: null]
			 * [MultiGeometry: null]
			 */
			final String name = this.getNodeValue( placeNode, "name" );
			final String desc = this.getNodeValue( placeNode, "description" );
			final String countryCode = desc.split( ":" )[0].split( "=" )[1].trim().toLowerCase();
			final Node lookat = this.getFirstNode( placeNode, "LookAt" );
			final String latStr = this.getNodeValue( lookat, "latitude" );
			final String lonStr = this.getNodeValue( lookat, "longitude" );
			final Element multiGeom = (Element) this.getFirstNode( placeNode, "MultiGeometry" );
			final NodeList polygonNodes = multiGeom.getElementsByTagName( "Polygon" );
			final List polygons = new ArrayList();
			for( int j = 0; j < polygonNodes.getLength(); j++ )
			{
				final String[] coords = this.getNodeValue( polygonNodes.item( j ), "coordinates" ).split( " " );
				final List points = new ArrayList();
				for( final String coord : coords )
				{
					final String[] xy = coord.split( "," );
					final float fx = Float.parseFloat( xy[0] );
					final float fy = Float.parseFloat( xy[1] );
					minx = Math.min( minx, fx );
					miny = Math.min( miny, fy );
					maxx = Math.max( maxx, fx );
					maxy = Math.max( maxy, fy );
					points.add( new Point2dImpl( fx, fy ) );
				}
				polygons.add( new Polygon( points ) );
			}

			final WorldPlace place = new WorldPlace( name, countryCode, Float.parseFloat( latStr ), Float.parseFloat( lonStr ), polygons );
			this.countryShapes.put( name, place );
			this.countryCodeShapes.put( countryCode, place );
		}
		this.bounds = new Rectangle( minx, miny, maxx - minx, maxy - miny );
	}

	private String getNodeValue( final Node node, final String nodeName )
	{
		final Node firstNode = this.getFirstNode( node, nodeName );
		return firstNode.getFirstChild().getNodeValue();
	}

	private Node getFirstNode( final Node node, final String nodeName )
	{
		return ((Element) node).getElementsByTagName( nodeName ).item( 0 );
	}

	/**
	 * 	Get all the {@link WorldPlace}s.
	 * 	@return A collection of places.
	 */
	public Collection getShapes()
	{
		return this.countryShapes.values();
	}

	/**
	 *	Returns a {@link WorldPlace} given a country code.
	 *	@param countryCode the ISOA2 country code.
	 *	@return The {@link WorldPlace}
	 */
	public WorldPlace byCountryCode( final String countryCode )
	{
		return this.countryCodeShapes.get( countryCode.toLowerCase() );
	}

	/**
	 * 	Returns a {@link WorldPlace} given a country name.
	 *	@param country The country
	 *	@return The {@link WorldPlace}
	 */
	public WorldPlace byCountry( final String country )
	{
		return this.countryShapes.get( country );
	}

	/**
	 * 	Get the bounds of all the polygons
	 *	@return The bounds
	 */
	public Rectangle getBounds()
	{
		return this.bounds;
	}
}