Package gov.usgs.earthquake.geoserve

Class GeoservePlacesService

java.lang.Object

gov.usgs.earthquake.geoserve.GeoservePlacesService

public class GeoservePlacesService
extends Object

Access places from the Geoserve Places service.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_CONNECT_TIMEOUT	Default connection timeout
static final String	DEFAULT_ENDPOINT_URL	Default URL for GeoServe Places service.
static final int	DEFAULT_READ_TIMEOUT	Default read timeout

Constructor Summary

Constructors

Constructor	Description
GeoservePlacesService()	Default constructor
GeoservePlacesService(int connectTimeout, int readTimeout)	Constructor taking in timeouts and using default endpoint URL
GeoservePlacesService(String endpointUrl)	Constructor taking in endpointURL
GeoservePlacesService(String endpointUrl, int connectTimeout, int readTimeout)	Custom constructor

Method Summary

Modifier and Type	Method	Description
int	getConnectTimeout()
String	getEndpointURL()
javax.json.JsonObject	getEventPlaces(BigDecimal latitude, BigDecimal longitude)	Find an event in the Places service via a latitude and longitude
javax.json.JsonObject	getNearestPlace(BigDecimal latitude, BigDecimal longitude)	Deprecated.
javax.json.JsonObject	getNearestPlace(BigDecimal latitude, BigDecimal longitude, int maxradiuskm)	Get nearest place to a latitude and longitude
int	getReadTimeout()
void	setConnectTimeout(int connectTimeout)
void	setEndpointURL(String endpointUrl)
void	setReadTimeout(int readTimeout)

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_ENDPOINT_URL

public static final String DEFAULT_ENDPOINT_URL

Default URL for GeoServe Places service.

See Also:

• Constant Field Values

DEFAULT_CONNECT_TIMEOUT

public static final int DEFAULT_CONNECT_TIMEOUT

Default connection timeout

See Also:

• Constant Field Values

DEFAULT_READ_TIMEOUT

public static final int DEFAULT_READ_TIMEOUT

Default read timeout

See Also:

• Constant Field Values

Constructor Details

GeoservePlacesService

public GeoservePlacesService()

Default constructor

GeoservePlacesService

public GeoservePlacesService(String endpointUrl)

Constructor taking in endpointURL

Parameters:

endpointUrl - for places service

GeoservePlacesService

public GeoservePlacesService(int connectTimeout,
 int readTimeout)

Constructor taking in timeouts and using default endpoint URL

Parameters:

connectTimeout - in ms

readTimeout - in ms

GeoservePlacesService

public GeoservePlacesService(String endpointUrl,
 int connectTimeout,
 int readTimeout)

Custom constructor

Parameters:

endpointUrl - for Places service

connectTimeout - in ms

readTimeout - in ms

Method Details

getConnectTimeout

public int getConnectTimeout()

Returns:

connectTimemout

getEndpointURL

public String getEndpointURL()

Returns:

endpointURL

getEventPlaces

public javax.json.JsonObject getEventPlaces(BigDecimal latitude,
 BigDecimal longitude)
                                     throws IOException,
MalformedURLException

Find an event in the Places service via a latitude and longitude

Parameters:

latitude - of event

longitude - of event

Returns:

JSONObject of event

Throws:

IOException - on IO error

MalformedURLException - or URL error

getNearestPlace

@Deprecated
public javax.json.JsonObject getNearestPlace(BigDecimal latitude,
 BigDecimal longitude)
                                      throws IndexOutOfBoundsException,
IOException,
MalformedURLException

Deprecated.

Get nearest place to a latitude and longitude

Parameters:

latitude - of place

longitude - of place

Returns:

JSONObject of place

Throws:

IndexOutOfBoundsException - on no places returned

IOException - on IO error

MalformedURLException - on URL error

getNearestPlace

public javax.json.JsonObject getNearestPlace(BigDecimal latitude,
 BigDecimal longitude,
 int maxradiuskm)
                                      throws IOException,
MalformedURLException

Get nearest place to a latitude and longitude

Parameters:

latitude - of place

longitude - of place

maxradiuskm - around place

Returns:

JSONObject of place

Throws:

IOException - on IO error

MalformedURLException - on URL error

getReadTimeout

public int getReadTimeout()

Returns:

readTimeout

setConnectTimeout

public void setConnectTimeout(int connectTimeout)

Parameters:

connectTimeout - int to set

setEndpointURL

public void setEndpointURL(String endpointUrl)

Parameters:

endpointUrl - string to set

setReadTimeout

public void setReadTimeout(int readTimeout)

Parameters:

readTimeout - int to set