maps.osm

Class OSMMap

java.lang.Object

maps.osm.OSMMap

public class OSMMap
extends java.lang.Object

An OpenStreetMap map.

Constructor Summary

Constructors

Constructor and Description
OSMMap() Construct an empty map.
OSMMap(org.dom4j.Document doc) Construct a map from an XML document.
OSMMap(java.io.File file) Construct a map from an XML file.
OSMMap(OSMMap other, double minLat, double minLon, double maxLat, double maxLon) Construct a copy of an OSMMap over a bounded area.

Method Summary

Modifier and Type	Method and Description
java.util.Collection<OSMBuilding>	getBuildings() Get all buildings.
double	getCentreLatitude() Get the centre latitude in this map.
double	getCentreLongitude() Get the centre longitude in this map.
double	getMaxLatitude() Get the maximum latitude in this map.
double	getMaxLongitude() Get the maximum longitude in this map.
double	getMinLatitude() Get the minimum latitude in this map.
double	getMinLongitude() Get the minimum longitude in this map.
OSMNode	getNearestNode(double lat, double lon) Get the nearest node to a point.
OSMNode	getNode(java.lang.Long id) Get a node by ID.
java.util.Collection<OSMNode>	getNodes() Get all nodes in the map.
java.util.Collection<OSMRoad>	getRoads() Get all roads.
void	read(org.dom4j.Document doc) Read an XML document and populate this map.
void	removeBuilding(OSMBuilding building) Remove a building.
void	removeNode(OSMNode node) Remove a node.
void	removeRoad(OSMRoad road) Remove a road.
void	replaceNode(OSMNode old, OSMNode replacement) Replace a node and update all references.
org.dom4j.Document	toXML() Turn this map into XML.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OSMMap

public OSMMap()

Construct an empty map.

OSMMap

public OSMMap(org.dom4j.Document doc)
       throws OSMException

Construct a map from an XML document.

Parameters:

doc - The document to read.

Throws:

OSMException

OSMMap

public OSMMap(java.io.File file)
       throws OSMException,
              org.dom4j.DocumentException,
              java.io.IOException

Construct a map from an XML file.

Parameters:

file - The file to read.

Throws:

OSMException

org.dom4j.DocumentException

java.io.IOException

OSMMap

public OSMMap(OSMMap other,
              double minLat,
              double minLon,
              double maxLat,
              double maxLon)

Construct a copy of an OSMMap over a bounded area.

Parameters:

other - The map to copy.

minLat - The minimum latitude of the new map.

minLon - The minimum longitude of the new map.

maxLat - The maximum latitude of the new map.

maxLon - The maximum longitude of the new map.

Method Detail

read

public void read(org.dom4j.Document doc)
          throws OSMException

Read an XML document and populate this map.

Parameters:

doc - The document to read.

Throws:

OSMException

toXML

public org.dom4j.Document toXML()

Turn this map into XML.

Returns:

A new XML document.

getMinLongitude

public double getMinLongitude()

Get the minimum longitude in this map.

Returns:

The minimum longitude.

getMaxLongitude

public double getMaxLongitude()

Get the maximum longitude in this map.

Returns:

The maximum longitude.

getCentreLongitude

public double getCentreLongitude()

Get the centre longitude in this map.

Returns:

The centre longitude.

getMinLatitude

public double getMinLatitude()

Get the minimum latitude in this map.

Returns:

The minimum latitude.

getMaxLatitude

public double getMaxLatitude()

Get the maximum latitude in this map.

Returns:

The maximum latitude.

getCentreLatitude

public double getCentreLatitude()

Get the centre latitude in this map.

Returns:

The centre latitude.

getNodes

public java.util.Collection<OSMNode> getNodes()

Get all nodes in the map.

Returns:

All nodes.

removeNode

public void removeNode(OSMNode node)

Remove a node.

Parameters:

node - The node to remove.

getNode

public OSMNode getNode(java.lang.Long id)

Get a node by ID.

Parameters:

id - The ID of the node.

Returns:

The node with the given ID or null.

getNearestNode

public OSMNode getNearestNode(double lat,
                              double lon)

Get the nearest node to a point.

Parameters:

lat - The latitude of the point.

lon - The longitude of the point.

Returns:

The nearest node.

replaceNode

public void replaceNode(OSMNode old,
                        OSMNode replacement)

Replace a node and update all references.

Parameters:

old - The node to replace.

replacement - The replacement node.

getRoads

public java.util.Collection<OSMRoad> getRoads()

Get all roads.

Returns:

All roads.

removeRoad

public void removeRoad(OSMRoad road)

Remove a road.

Parameters:

road - The road to remove.

getBuildings

public java.util.Collection<OSMBuilding> getBuildings()

Get all buildings.

Returns:

All buildings.

removeBuilding

public void removeBuilding(OSMBuilding building)

Remove a building.

Parameters:

building - The building to remove.