org.osmtools.api.OsmOperations Maven / Gradle / Ivy

Go to download
package org.osmtools.api;

import java.util.Collection;
import java.util.List;

import org.osm.schema.Osm;
import org.osm.schema.OsmNode;
import org.osm.schema.OsmRelation;
import org.osm.schema.OsmWay;
import org.osmtools.oauth.OauthTokens;

public interface OsmOperations {

	/**
	 * The following command returns:
	 * 
	 * All nodes that are inside a given bounding box and any relations that reference them.
	 * All ways that reference at least one node that is inside a given bounding box, any relations that reference
	 * them [the ways], and any nodes outside the bounding box that the ways may reference.
	 * All relations that reference one of the nodes, ways or relations included due to the above rules. (Does not
	 * apply recursively, see explanation below.)
	 * 
	 * 
	 * @see OSM
	 *      API Wiki
	 * 
	 * @param boundingBox
	 * @return
	 */
	Osm getBBox(BoundingBox boundingBox);

	OsmNode getForNode(long nodeId);

	OsmWay getForWay(long wayId);
	
	List getForRelation(long relationId);

	List getForManyWays(Collection wayIds);

	ChangesetOperations openChangeset(String comment, OauthTokens oauthTokens);

	UserOperations userOperations(OauthTokens oauthTokens);

}