de.westnordost.osmapi.capabilities

Class Capabilities

java.lang.Object

de.westnordost.osmapi.capabilities.Capabilities

All Implemented Interfaces:

java.io.Serializable

public class Capabilities
extends java.lang.Object
implements java.io.Serializable

(Current) capabilities of the osm server.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Capabilities.ApiStatus

Field Summary

Fields

Modifier and Type	Field and Description
Capabilities.ApiStatus	databaseStatus
Capabilities.ApiStatus	gpsTracesStatus
java.util.List<java.lang.String>	imageryBlacklistRegExes list of regular expressions to match URLs from which the use of imagery is prohibited explicitly by the API.
Capabilities.ApiStatus	mapDataStatus
int	maxElementsPerChangeset
float	maxMapQueryAreaInSquareDegrees
int	maxNodesInWay
float	maxNotesQueryAreaInSquareDegrees
int	maxPointsInGpsTracePerPage See http://wiki.openstreetmap.org/wiki/API_v0.6#Retrieving_GPS_points
float	maxSupportedApiVersion
float	minSupportedApiVersion
int	timeoutInSeconds

Constructor Summary

Constructors

Constructor and Description
Capabilities()

Method Summary

Modifier and Type	Method and Description
boolean	isDatabaseReadable()
boolean	isDatabaseWritable()
boolean	isGpsTracesReadable()
boolean	isGpsTracesUploadable()
boolean	isMapDataModifiable()
boolean	isMapDataReadable()

Methods inherited from class java.lang.Object

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

Field Detail

minSupportedApiVersion

public float minSupportedApiVersion

maxSupportedApiVersion

public float maxSupportedApiVersion

maxMapQueryAreaInSquareDegrees

public float maxMapQueryAreaInSquareDegrees

maxNotesQueryAreaInSquareDegrees

public float maxNotesQueryAreaInSquareDegrees

maxNodesInWay

public int maxNodesInWay

maxPointsInGpsTracePerPage

public int maxPointsInGpsTracePerPage

See http://wiki.openstreetmap.org/wiki/API_v0.6#Retrieving_GPS_points

maxElementsPerChangeset

public int maxElementsPerChangeset

timeoutInSeconds

public int timeoutInSeconds

databaseStatus

public Capabilities.ApiStatus databaseStatus

mapDataStatus

public Capabilities.ApiStatus mapDataStatus

gpsTracesStatus

public Capabilities.ApiStatus gpsTracesStatus

imageryBlacklistRegExes

public java.util.List<java.lang.String> imageryBlacklistRegExes

list of regular expressions to match URLs from which the use of imagery is prohibited explicitly by the API. Naturally, this is not an exhaustive list, it is only to save users from attempting to use imagery from sources obviously not allowed for OSM. I.e. anything google. Note that if the server did not send this information, this method returns null.

Constructor Detail

Capabilities

public Capabilities()

Method Detail

isDatabaseWritable

public boolean isDatabaseWritable()

Returns:

whether the data in the database can be modified. Implies that it can also be read.

isDatabaseReadable

public boolean isDatabaseReadable()

isMapDataModifiable

public boolean isMapDataModifiable()

isMapDataReadable

public boolean isMapDataReadable()

isGpsTracesUploadable

public boolean isGpsTracesUploadable()

isGpsTracesReadable

public boolean isGpsTracesReadable()