de.westnordost.osmapi.map

Class MapDataApi

java.lang.Object

de.westnordost.osmapi.map.MapDataApi

public class MapDataApi
extends java.lang.Object

Get and upload changes to map data

Constructor Summary

Constructors

Constructor and Description
MapDataApi(de.westnordost.osmapi.OsmConnection osm)
MapDataApi(de.westnordost.osmapi.OsmConnection osm, MapDataFactory factory)

Method Summary

Modifier and Type	Method and Description
void	closeChangeset(long changesetId) Closes the given changeset.
void	getMap(de.westnordost.osmapi.map.data.BoundingBox bounds, MapDataHandler handler) Feeds map data to the given MapDataHandler.
Node	getNode(long id) Note that if not logged in, the Changeset for each returned element will be null
java.util.List<Node>	getNodes(java.util.Collection<java.lang.Long> nodeIds) Note that if not logged in, the Changeset for each returned element will be null
Relation	getRelation(long id) Note that if not logged in, the Changeset for each returned element will be null
void	getRelationComplete(long id, MapDataHandler handler) Queries the relation with the given id plus all it's members and all nodes of ways that are members of the relation.
java.util.List<Relation>	getRelations(java.util.Collection<java.lang.Long> relationIds) Note that if not logged in, the Changeset for each returned element will be null
java.util.List<Relation>	getRelationsForNode(long id) Note that if not logged in, the Changeset for each returned element will be null
java.util.List<Relation>	getRelationsForRelation(long id) Note that if not logged in, the Changeset for each returned element will be null
java.util.List<Relation>	getRelationsForWay(long id) Note that if not logged in, the Changeset for each returned element will be null
Way	getWay(long id) Note that if not logged in, the Changeset for each returned element will be null
void	getWayComplete(long id, MapDataHandler handler) Queries the way with the given id plus all nodes that are in referenced by it.
java.util.List<Way>	getWays(java.util.Collection<java.lang.Long> wayIds) Note that if not logged in, the Changeset for each returned element will be null
java.util.List<Way>	getWaysForNode(long id) Note that if not logged in, the Changeset for each returned element will be null
long	openChangeset(java.util.Map<java.lang.String,java.lang.String> tags) Open a new changeset with the given tags
void	updateChangeset(long changesetId, java.util.Map<java.lang.String,java.lang.String> tags) Set new the tags of a changeset (the old set of tags is deleted)
long	updateMap(java.util.Map<java.lang.String,java.lang.String> tags, java.lang.Iterable<Element> elements, de.westnordost.osmapi.common.Handler<DiffElement> handler) Opens a changeset, uploads the data, closes the changeset and subscribes the user to it.
long	updateMap(java.lang.String comment, java.lang.String source, java.lang.Iterable<Element> elements, de.westnordost.osmapi.common.Handler<DiffElement> handler)
void	uploadChanges(long changesetId, java.lang.Iterable<Element> elements, de.westnordost.osmapi.common.Handler<DiffElement> handler) Upload changes into an opened changeset.

Methods inherited from class java.lang.Object

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

Constructor Detail

MapDataApi

public MapDataApi(de.westnordost.osmapi.OsmConnection osm,
                  MapDataFactory factory)

MapDataApi

public MapDataApi(de.westnordost.osmapi.OsmConnection osm)

Method Detail

updateMap

public long updateMap(java.lang.String comment,
                      java.lang.String source,
                      java.lang.Iterable<Element> elements,
                      de.westnordost.osmapi.common.Handler<DiffElement> handler)

See Also:

updateMap(Map, Iterable, Handler)

updateMap

public long updateMap(java.util.Map<java.lang.String,java.lang.String> tags,
                      java.lang.Iterable<Element> elements,
                      de.westnordost.osmapi.common.Handler<DiffElement> handler)

Opens a changeset, uploads the data, closes the changeset and subscribes the user to it.

Parameters:

tags - tags of this changeset. Usually it is comment and source. See updateMap(String, String, Iterable, Handler)

elements - elements to upload. No special order required

handler - handler that processes the server's diffResult response. Optional.

Returns:

id of the changeset that was created

Throws:

de.westnordost.osmapi.common.errors.OsmAuthorizationException - if the application does not have permission to edit the map (Permission.MODIFY_MAP)

de.westnordost.osmapi.common.errors.OsmPreconditionFailedException - if the deletion of an element was uploaded but that element is still referred to by another element

uploadChanges

public void uploadChanges(long changesetId,
                          java.lang.Iterable<Element> elements,
                          de.westnordost.osmapi.common.Handler<DiffElement> handler)

Upload changes into an opened changeset.

Parameters:

changesetId - id of the changeset to upload changes into

elements - elements to upload. No special order required

handler - handler that processes the server's diffResult response. Optional.

Throws:

de.westnordost.osmapi.common.errors.OsmNotFoundException - if the changeset does not exist (yet) or an element in the does not exist

de.westnordost.osmapi.common.errors.OsmConflictException - if the changeset has already been closed, there is a conflict for the elements being uploaded or the user who created the changeset is not the same as the one uploading the change

de.westnordost.osmapi.common.errors.OsmAuthorizationException - if the application does not have permission to edit the map (Permission.MODIFY_MAP)

de.westnordost.osmapi.common.errors.OsmPreconditionFailedException - if the deletion of an element was uploaded but that element is still referred to by another element

openChangeset

public long openChangeset(java.util.Map<java.lang.String,java.lang.String> tags)

Open a new changeset with the given tags

Parameters:

tags - tags of this changeset. Usually it is comment and source.

Returns:

the id of the changeset

Throws:

de.westnordost.osmapi.common.errors.OsmAuthorizationException - if the application does not have permission to edit the map (Permission.MODIFY_MAP)

updateChangeset

public void updateChangeset(long changesetId,
                            java.util.Map<java.lang.String,java.lang.String> tags)

Set new the tags of a changeset (the old set of tags is deleted)

Parameters:

changesetId - id of the changeset to update

tags - the new tags of this changeset

Throws:

de.westnordost.osmapi.common.errors.OsmConflictException - if the changeset has already been closed

de.westnordost.osmapi.common.errors.OsmNotFoundException - if the changeset does not exist (yet)

de.westnordost.osmapi.common.errors.OsmAuthorizationException - if the application does not have permission to edit the map (Permission.MODIFY_MAP)

closeChangeset

public void closeChangeset(long changesetId)

Closes the given changeset.

Parameters:

changesetId - id of the changeset to close

Throws:

de.westnordost.osmapi.common.errors.OsmConflictException - if the changeset has already been closed

de.westnordost.osmapi.common.errors.OsmNotFoundException - if the changeset does not exist (yet)

de.westnordost.osmapi.common.errors.OsmAuthorizationException - if the application does not have permission to edit the map (Permission.MODIFY_MAP)

getMap

public void getMap(de.westnordost.osmapi.map.data.BoundingBox bounds,
                   MapDataHandler handler)

Feeds map data to the given MapDataHandler.
If not logged in, the Changeset for each returned element will be null

Parameters:

bounds - rectangle in which to query map data. May not cross the 180th meridian. This is usually limited at 0.25 square degrees. Check the server capabilities.

handler - map data handler that is fed the map data

Throws:

de.westnordost.osmapi.common.errors.OsmQueryTooBigException - if the bounds are is too large

java.lang.IllegalArgumentException - if the bounds cross the 180th meridian.

getWayComplete

public void getWayComplete(long id,
                           MapDataHandler handler)

Queries the way with the given id plus all nodes that are in referenced by it.
If not logged in, the Changeset for each returned element will be null

Parameters:

id - the way's id

handler - map data handler that is fed the map data

Throws:

de.westnordost.osmapi.common.errors.OsmNotFoundException - if the way with the given id does not exist

getRelationComplete

public void getRelationComplete(long id,
                                MapDataHandler handler)

Queries the relation with the given id plus all it's members and all nodes of ways that are members of the relation.
If not logged in, the Changeset for each returned element will be null

Parameters:

id - the relation's id

handler - map data handler that is fed the map data

Throws:

de.westnordost.osmapi.common.errors.OsmNotFoundException - if the relation with the given id does not exist

getNode

public Node getNode(long id)

Note that if not logged in, the Changeset for each returned element will be null

Parameters:

id - the node's id

Returns:

the node with the given id or null if it does not exist

getWay

public Way getWay(long id)

Note that if not logged in, the Changeset for each returned element will be null

Parameters:

id - the way's id

Returns:

the way with the given id or null if it does not exist

getRelation

public Relation getRelation(long id)

Note that if not logged in, the Changeset for each returned element will be null

Parameters:

id - the relation's id

Returns:

the relation with the given id or null if it does not exist

getNodes

public java.util.List<Node> getNodes(java.util.Collection<java.lang.Long> nodeIds)

Note that if not logged in, the Changeset for each returned element will be null

Parameters:

nodeIds - a collection of node ids to return.

Returns:

a list of nodes.

Throws:

de.westnordost.osmapi.common.errors.OsmNotFoundException - if any one of the given nodes does not exist

getWays

public java.util.List<Way> getWays(java.util.Collection<java.lang.Long> wayIds)

Note that if not logged in, the Changeset for each returned element will be null

Parameters:

wayIds - a collection of way ids to return

Returns:

a list of ways.

Throws:

de.westnordost.osmapi.common.errors.OsmNotFoundException - if any one of the given ways does not exist

getRelations

public java.util.List<Relation> getRelations(java.util.Collection<java.lang.Long> relationIds)

Note that if not logged in, the Changeset for each returned element will be null

Parameters:

relationIds - a collection of relation ids to return

Returns:

a list of relations.

Throws:

de.westnordost.osmapi.common.errors.OsmNotFoundException - if any one of the given relations does not exist

getWaysForNode

public java.util.List<Way> getWaysForNode(long id)

Note that if not logged in, the Changeset for each returned element will be null

Parameters:

id - the node's id

Returns:

all ways that reference the node with the given id. Empty if none.

getRelationsForNode

public java.util.List<Relation> getRelationsForNode(long id)

Note that if not logged in, the Changeset for each returned element will be null

Parameters:

id - the node's id

Returns:

all relations that reference the node with the given id. Empty if none.

getRelationsForWay

public java.util.List<Relation> getRelationsForWay(long id)

Note that if not logged in, the Changeset for each returned element will be null

Parameters:

id - the way's id

Returns:

all relations that reference the way with the given id. Empty if none.

getRelationsForRelation

public java.util.List<Relation> getRelationsForRelation(long id)

Note that if not logged in, the Changeset for each returned element will be null

Parameters:

id - the relation's id

Returns:

all relations that reference the relation with the given id. Empty if none.