Class GeoservePlacesService


  • public class GeoservePlacesService
    extends java.lang.Object
    Access places from the Geoserve Places service.
    • Field Detail

      • DEFAULT_ENDPOINT_URL

        public static final java.lang.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 Detail

      • GeoservePlacesService

        public GeoservePlacesService()
        Default constructor
      • GeoservePlacesService

        public GeoservePlacesService​(java.lang.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​(java.lang.String endpointUrl,
                                     int connectTimeout,
                                     int readTimeout)
        Custom constructor
        Parameters:
        endpointUrl - for Places service
        connectTimeout - in ms
        readTimeout - in ms
    • Method Detail

      • getConnectTimeout

        public int getConnectTimeout()
        Returns:
        connectTimemout
      • getEndpointURL

        public java.lang.String getEndpointURL()
        Returns:
        endpointURL
      • getEventPlaces

        public javax.json.JsonObject getEventPlaces​(java.math.BigDecimal latitude,
                                                    java.math.BigDecimal longitude)
                                             throws java.io.IOException,
                                                    java.net.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:
        java.io.IOException - on IO error
        java.net.MalformedURLException - or URL error
      • getNearestPlace

        public javax.json.JsonObject getNearestPlace​(java.math.BigDecimal latitude,
                                                     java.math.BigDecimal longitude)
                                              throws java.lang.IndexOutOfBoundsException,
                                                     java.io.IOException,
                                                     java.net.MalformedURLException
        Deprecated.
        Get nearest place to a latitude and longitude
        Parameters:
        latitude - of place
        longitude - of place
        Returns:
        JSONObject of place
        Throws:
        java.lang.IndexOutOfBoundsException - on no places returned
        java.io.IOException - on IO error
        java.net.MalformedURLException - on URL error
      • getNearestPlace

        public javax.json.JsonObject getNearestPlace​(java.math.BigDecimal latitude,
                                                     java.math.BigDecimal longitude,
                                                     int maxradiuskm)
                                              throws java.io.IOException,
                                                     java.net.MalformedURLException
        Get nearest place to a latitude and longitude
        Parameters:
        latitude - of place
        longitude - of place
        maxradiuskm - around place
        Returns:
        JSONObject of place
        Throws:
        java.io.IOException - on IO error
        java.net.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​(java.lang.String endpointUrl)
        Parameters:
        endpointUrl - string to set
      • setReadTimeout

        public void setReadTimeout​(int readTimeout)
        Parameters:
        readTimeout - int to set