se.walkercrou.places

Class GooglePlaces

java.lang.Object

se.walkercrou.places.GooglePlaces

All Implemented Interfaces:

GooglePlacesInterface, Statuses, Types

public class GooglePlaces
extends Object
implements GooglePlacesInterface

Field Summary

Fields inherited from interface se.walkercrou.places.GooglePlacesInterface

API_URL, ARRAY_ADDRESS_COMPONENTS, ARRAY_ALT_IDS, ARRAY_ASPECTS, ARRAY_MATCHED_SUBSTRINGS, ARRAY_PERIODS, ARRAY_PHOTOS, ARRAY_PREDICTIONS, ARRAY_RESULTS, ARRAY_REVIEWS, ARRAY_TERMS, ARRAY_TYPES, BOOLEAN_OPENED, DEFAULT_RESULTS, DOUBLE_LATITUDE, DOUBLE_LONGITUDE, DOUBLE_RATING, INTEGER_ACCURACY, INTEGER_DAY, INTEGER_HEIGHT, INTEGER_LENGTH, INTEGER_OFFSET, INTEGER_PRICE_LEVEL, INTEGER_RATING, INTEGER_UTC_OFFSET, INTEGER_WIDTH, LONG_TIME, MAX_PHOTO_SIZE, MAXIMUM_PAGE_RESULTS, MAXIMUM_RADIUS, MAXIMUM_RESULTS, METHOD_ADD, METHOD_AUTOCOMPLETE, METHOD_DELETE, METHOD_DETAILS, METHOD_NEARBY_SEARCH, METHOD_QUERY_AUTOCOMPLETE, METHOD_RADAR_SEARCH, METHOD_TEXT_SEARCH, OBJECT_CLOSE, OBJECT_GEOMETRY, OBJECT_HOURS, OBJECT_LOCATION, OBJECT_OPEN, OBJECT_RESULT, STRING_ADDRESS, STRING_AUTHOR_NAME, STRING_AUTHOR_URL, STRING_DESCRIPTION, STRING_ERROR_MESSAGE, STRING_ICON, STRING_INTERNATIONAL_PHONE_NUMBER, STRING_LANGUAGE, STRING_LONG_NAME, STRING_NAME, STRING_NEXT_PAGE_TOKEN, STRING_PHONE_NUMBER, STRING_PHOTO_REFERENCE, STRING_PLACE_ID, STRING_SCOPE, STRING_SHORT_NAME, STRING_STATUS, STRING_TEXT, STRING_TIME, STRING_TYPE, STRING_TYPES, STRING_URL, STRING_VALUE, STRING_VICINITY, STRING_WEBSITE

Fields inherited from interface se.walkercrou.places.Types

TYPE_ACCOUNTING, TYPE_AIRPORT, TYPE_AMUSEMENT_PARK, TYPE_AQUARIUM, TYPE_ART_GALLERY, TYPE_ATM, TYPE_BAKERY, TYPE_BANK, TYPE_BAR, TYPE_BEAUTY_SALON, TYPE_BICYCLE_STORE, TYPE_BOOK_STORE, TYPE_BOWLING_ALLEY, TYPE_BUS_STATION, TYPE_CAFE, TYPE_CAMPGROUND, TYPE_CAR_DEALER, TYPE_CAR_RENTAL, TYPE_CAR_REPAIR, TYPE_CAR_WASH, TYPE_CASINO, TYPE_CEMETERY, TYPE_CHURCH, TYPE_CITY_HALL, TYPE_CLOTHING_STORE, TYPE_CONVENIENCE_STORE, TYPE_COURTHOUSE, TYPE_DENTIST, TYPE_DEPARTMENT_STORE, TYPE_DOCTOR, TYPE_ELECTRICIAN, TYPE_ELECTRONICS_STORE, TYPE_EMBASSY, TYPE_ESTABLISHMENT, TYPE_FINANCE, TYPE_FIRE_STATION, TYPE_FLORIST, TYPE_FOOD, TYPE_FUNERAL_HOME, TYPE_FURNITURE_STORE, TYPE_GAS_STATION, TYPE_GENERAL_CONTRACTOR, TYPE_GROCERY_OR_SUPERMARKET, TYPE_GYM, TYPE_HAIR_CARE, TYPE_HARDWARE_STORE, TYPE_HEALTH, TYPE_HINDU_TEMPLE, TYPE_HOME_GOODS_STORE, TYPE_HOSPITAL, TYPE_INSURANCE_AGENCY, TYPE_JEWELRY_STORE, TYPE_LAUNDRY, TYPE_LAWYER, TYPE_LIBRARY, TYPE_LIQUOR_STORE, TYPE_LOCAL_GOVERNMENT_OFFICE, TYPE_LOCKSMITH, TYPE_LODGING, TYPE_MEAL_DELIVERY, TYPE_MEAL_TAKEAWAY, TYPE_MOSQUE, TYPE_MOVIE_RENTAL, TYPE_MOVIE_THEATER, TYPE_MOVING_COMPANY, TYPE_MUSEUM, TYPE_NIGHT_CLUB, TYPE_PAINTER, TYPE_PARK, TYPE_PARKING, TYPE_PET_STORE, TYPE_PHARMACY, TYPE_PHYSIOTHERAPIST, TYPE_PLACE_OF_WORSHIP, TYPE_PLUMBER, TYPE_POLICE, TYPE_POST_OFFICE, TYPE_REAL_ESTATE_AGENCY, TYPE_RESTAURANT, TYPE_ROOFING_CONTRACTOR, TYPE_RV_PARK, TYPE_SCHOOL, TYPE_SHOE_STORE, TYPE_SHOPPING_MALL, TYPE_SPA, TYPE_STADIUM, TYPE_STORAGE, TYPE_STORE, TYPE_SUBWAY_STATION, TYPE_SYNAGOGUE, TYPE_TAXI_STAND, TYPE_TRAIN_STATION, TYPE_TRAVEL_AGENCY, TYPE_UNIVERSITY, TYPE_VETERINARY_CARE, TYPE_ZOO

Fields inherited from interface se.walkercrou.places.Statuses

STATUS_INVALID_REQUEST, STATUS_NOT_FOUND, STATUS_OK, STATUS_OVER_QUERY_LIMIT, STATUS_REQUEST_DENIED, STATUS_UNKNOWN_ERROR, STATUS_ZERO_RESULTS

Constructor Summary

Constructors

Constructor and Description
GooglePlaces(String apiKey) Creates a new GooglePlaces object using the specified API key.
GooglePlaces(String apiKey, RequestHandler requestHandler) Creates a new GooglePlaces object using the specified API key and the specified RequestHandler.
GooglePlaces(String apiKey, String characterEncoding) Creates a new GooglePlaces object using the specified API key and character encoding.

Method Summary

Modifier and Type	Method and Description
Place	addPlace(PlaceBuilder builder, boolean returnPlace, Param... extraParams) Adds a new place to the Places API and gets the newly created place if returnPlace is set to true.
protected static void	checkStatus(String statusCode, String errorMessage)
void	deletePlace(Place place, Param... extraParams) Deletes the specified place.
void	deletePlaceById(String placeId, Param... extraParams) Deletes the place of the specified placeId.
protected InputStream	download(String uri)
protected InputStream	downloadPhoto(Photo photo, int maxWidth, int maxHeight, Param... extraParams)
String	getApiKey() Returns the API key associated with this GooglePlaces object.
List<Place>	getNearbyPlaces(double lat, double lng, double radius, int limit, Param... extraParams) Returns the places at the specified latitude and longitude within the specified radius.
List<Place>	getNearbyPlaces(double lat, double lng, double radius, Param... extraParams) Returns the places at the specified latitude and longitude within the specified radius.
List<Place>	getNearbyPlacesRankedByDistance(double lat, double lng, int limit, Param... params) Returns the places at the specified latitude and longitude in order of proximity to the specified location.
List<Place>	getNearbyPlacesRankedByDistance(double lat, double lng, Param... params) Returns the places at the specified latitude and longitude in order of proximity to the specified location.
Place	getPlaceById(String placeId, Param... extraParams) Returns the place specified by the 'placeid'.
List<Prediction>	getPlacePredictions(String input, int offset, int lat, int lng, int radius, Param... extraParams) Returns a list of auto-complete predictions for searching for a specific place.
List<Prediction>	getPlacePredictions(String input, int offset, Param... extraParams) Returns a list of auto-complete predictions for searching for a specific place.
List<Prediction>	getPlacePredictions(String input, Param... extraParams) Returns a list of auto-complete predictions for searching for a specific place.
List<Place>	getPlacesByQuery(String query, int limit, Param... extraParams) Returns the places that match the specified search query.
List<Place>	getPlacesByQuery(String query, Param... extraParams) Returns the places that match the specified search query.
List<Place>	getPlacesByRadar(double lat, double lng, double radius, int limit, Param... extraParams) Returns the places at the specified latitude and longitude according to the "radar" method specified by Google Places API.
List<Place>	getPlacesByRadar(double lat, double lng, double radius, Param... extraParams) Returns the places at the specified latitude and longitude according to the "radar" method specified by Google Places API.
List<Prediction>	getQueryPredictions(String input, int offset, int lat, int lng, int radius, Param... extraParams) Returns a list of auto-complete predictions for searching for a place by a query.
List<Prediction>	getQueryPredictions(String input, int offset, Param... extraParams) Returns a list of auto-complete predictions for searching for a place by a query.
List<Prediction>	getQueryPredictions(String input, Param... extraParams) Returns a list of auto-complete predictions for searching for a place by a query.
RequestHandler	getRequestHandler() Returns the interface that handles HTTP requests to Google's server.
boolean	isDebugModeEnabled() Returns true if the client is running in debug mode.
static String	parse(GooglePlaces client, List<Place> places, String str, int limit) Parses the specified raw json String into a list of places.
void	setApiKey(String apiKey) Sets the API key associated with this GooglePlaces object.
void	setDebugModeEnabled(boolean debugModeEnabled) Sets if the client should run in debug mode.
void	setRequestHandler(RequestHandler requestHandler) Sets the request handler to delegate HTTP traffic.

Methods inherited from class java.lang.Object

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

Constructor Detail

GooglePlaces

public GooglePlaces(String apiKey,
                    RequestHandler requestHandler)

Creates a new GooglePlaces object using the specified API key and the specified RequestHandler.

Parameters:

apiKey - that has been registered on the Google Developer Console

requestHandler - to handle HTTP traffic

GooglePlaces

public GooglePlaces(String apiKey)

Creates a new GooglePlaces object using the specified API key.

Parameters:

apiKey - that has been registered on the Google Developer Console

GooglePlaces

public GooglePlaces(String apiKey,
                    String characterEncoding)

Creates a new GooglePlaces object using the specified API key and character encoding. Using a character encoding other than UTF-8 is not advised.

Parameters:

apiKey - that has been registered on the Google Developer Console

characterEncoding - to parse data with

Method Detail

checkStatus

protected static void checkStatus(String statusCode,
                                  String errorMessage)

parse

public static String parse(GooglePlaces client,
                           List<Place> places,
                           String str,
                           int limit)

Parses the specified raw json String into a list of places.

Parameters:

places - to parse into

str - raw json

limit - the maximum amount of places to return

Returns:

list of parsed places

isDebugModeEnabled

public boolean isDebugModeEnabled()

Description copied from interface: GooglePlacesInterface

Returns true if the client is running in debug mode.

Specified by:

isDebugModeEnabled in interface GooglePlacesInterface

Returns:

true if debug mode

setDebugModeEnabled

public void setDebugModeEnabled(boolean debugModeEnabled)

Description copied from interface: GooglePlacesInterface

Sets if the client should run in debug mode.

Specified by:

setDebugModeEnabled in interface GooglePlacesInterface

Parameters:

debugModeEnabled - true if in debug mode

getApiKey

public String getApiKey()

Description copied from interface: GooglePlacesInterface

Returns the API key associated with this GooglePlaces object.

Specified by:

getApiKey in interface GooglePlacesInterface

Returns:

api key

setApiKey

public void setApiKey(String apiKey)

Description copied from interface: GooglePlacesInterface

Sets the API key associated with this GooglePlaces object.

Specified by:

setApiKey in interface GooglePlacesInterface

Parameters:

apiKey - to set

getRequestHandler

public RequestHandler getRequestHandler()

Description copied from interface: GooglePlacesInterface

Returns the interface that handles HTTP requests to Google's server.

Specified by:

getRequestHandler in interface GooglePlacesInterface

Returns:

request handler for HTTP traffic

setRequestHandler

public void setRequestHandler(RequestHandler requestHandler)

Description copied from interface: GooglePlacesInterface

Sets the request handler to delegate HTTP traffic.

Specified by:

setRequestHandler in interface GooglePlacesInterface

Parameters:

requestHandler - to handle HTTP traffic

getNearbyPlaces

public List<Place> getNearbyPlaces(double lat,
                                   double lng,
                                   double radius,
                                   int limit,
                                   Param... extraParams)

Description copied from interface: GooglePlacesInterface

Returns the places at the specified latitude and longitude within the specified radius. If the specified limit is greater than GooglePlacesInterface.MAXIMUM_PAGE_RESULTS, multiple HTTP GET requests may be made if necessary.

Specified by:

getNearbyPlaces in interface GooglePlacesInterface

Parameters:

lat - latitude

lng - longitude

radius - radius

limit - the maximum amount of places to return

extraParams - any extra parameters to include in the request URL

Returns:

a list of places that were found

getNearbyPlaces

public List<Place> getNearbyPlaces(double lat,
                                   double lng,
                                   double radius,
                                   Param... extraParams)

Description copied from interface: GooglePlacesInterface

Returns the places at the specified latitude and longitude within the specified radius. No more than GooglePlacesInterface.DEFAULT_RESULTS will be returned and no more than one HTTP GET request will be sent.

Specified by:

getNearbyPlaces in interface GooglePlacesInterface

Parameters:

lat - latitude

lng - longitude

radius - radius

extraParams - any extra parameters to include in the request URL

Returns:

a list of places that were found

getNearbyPlacesRankedByDistance

public List<Place> getNearbyPlacesRankedByDistance(double lat,
                                                   double lng,
                                                   int limit,
                                                   Param... params)

Description copied from interface: GooglePlacesInterface

Returns the places at the specified latitude and longitude in order of proximity to the specified location. If the specified limit is greater than GooglePlacesInterface.MAXIMUM_PAGE_RESULTS, multiple HTTP GET requests may be made if necessary. One or more of the parameters 'keyword', 'name', or 'types' is required or else a GooglePlacesException will be thrown.

Specified by:

getNearbyPlacesRankedByDistance in interface GooglePlacesInterface

Parameters:

lat - latitude

lng - longitude

limit - the maximum amount of places to return

params - parameters to append to url, one or more being 'keyword', 'name', or 'types'

Returns:

list of places in order of proximity to the specified location

getNearbyPlacesRankedByDistance

public List<Place> getNearbyPlacesRankedByDistance(double lat,
                                                   double lng,
                                                   Param... params)

Description copied from interface: GooglePlacesInterface

Returns the places at the specified latitude and longitude in order of proximity to the specified location. No more than GooglePlacesInterface.DEFAULT_RESULTS will be returned and no more than one HTTP GET request will be sent. One or more of the parameters 'keyword', 'name', or 'types' is required or else a GooglePlacesException will be thrown.

Specified by:

getNearbyPlacesRankedByDistance in interface GooglePlacesInterface

Parameters:

lat - latitude

lng - longitude

params - parameters to append to url, one or more being 'keyword', 'name', or 'types'

Returns:

list of places in order of proximity to the specified location

getPlacesByQuery

public List<Place> getPlacesByQuery(String query,
                                    int limit,
                                    Param... extraParams)

Description copied from interface: GooglePlacesInterface

Returns the places that match the specified search query. If the specified limit is greater than GooglePlacesInterface.MAXIMUM_PAGE_RESULTS, multiple HTTP GET requests may be made if necessary.

Specified by:

getPlacesByQuery in interface GooglePlacesInterface

Parameters:

query - search query

limit - the maximum amount of places to return

extraParams - any extra parameters to include in the request URL

Returns:

a list of places that were found

getPlacesByQuery

public List<Place> getPlacesByQuery(String query,
                                    Param... extraParams)

Description copied from interface: GooglePlacesInterface

Returns the places that match the specified search query. No more than GooglePlacesInterface.DEFAULT_RESULTS will be returned and no more than one HTTP GET request will be sent. The 'sensor' parameter defaults to false.

Specified by:

getPlacesByQuery in interface GooglePlacesInterface

Parameters:

query - search query

extraParams - any extra parameters to include in the request URL

Returns:

a list of places that were found

getPlacesByRadar

public List<Place> getPlacesByRadar(double lat,
                                    double lng,
                                    double radius,
                                    int limit,
                                    Param... extraParams)

Description copied from interface: GooglePlacesInterface

Returns the places at the specified latitude and longitude according to the "radar" method specified by Google Places API. If the specified limit is greater than GooglePlacesInterface.MAXIMUM_PAGE_RESULTS, multiple HTTP GET requests may be made if necessary.

Specified by:

getPlacesByRadar in interface GooglePlacesInterface

Parameters:

lat - latitude

lng - longitude

radius - radius

limit - the maximum amount of places to return

extraParams - any extra parameters to include in the request URL

Returns:

a list of places that were found

getPlacesByRadar

public List<Place> getPlacesByRadar(double lat,
                                    double lng,
                                    double radius,
                                    Param... extraParams)

Description copied from interface: GooglePlacesInterface

Returns the places at the specified latitude and longitude according to the "radar" method specified by Google Places API. No more than GooglePlacesInterface.DEFAULT_RESULTS will be returned and no more than one HTTP GET request will be sent.

Specified by:

getPlacesByRadar in interface GooglePlacesInterface

Parameters:

lat - latitude

lng - longitude

radius - radius

extraParams - any extra parameters to include in the request URL

Returns:

a list of places that were found

getPlaceById

public Place getPlaceById(String placeId,
                          Param... extraParams)

Description copied from interface: GooglePlacesInterface

Returns the place specified by the 'placeid'.

Specified by:

getPlaceById in interface GooglePlacesInterface

Parameters:

placeId - to get

extraParams - params to append to url

Returns:

place

addPlace

public Place addPlace(PlaceBuilder builder,
                      boolean returnPlace,
                      Param... extraParams)

Description copied from interface: GooglePlacesInterface

Adds a new place to the Places API and gets the newly created place if returnPlace is set to true.

Specified by:

addPlace in interface GooglePlacesInterface

Parameters:

builder - to get place details from

returnPlace - true if the newly created place should be returned

extraParams - to append to request url

Returns:

newly created place

deletePlaceById

public void deletePlaceById(String placeId,
                            Param... extraParams)

Description copied from interface: GooglePlacesInterface

Deletes the place of the specified placeId.

Specified by:

deletePlaceById in interface GooglePlacesInterface

Parameters:

placeId - place id

extraParams - params to append to url

deletePlace

public void deletePlace(Place place,
                        Param... extraParams)

Description copied from interface: GooglePlacesInterface

Deletes the specified place.

Specified by:

deletePlace in interface GooglePlacesInterface

Parameters:

place - to delete

download

protected InputStream download(String uri)

downloadPhoto

protected InputStream downloadPhoto(Photo photo,
                                    int maxWidth,
                                    int maxHeight,
                                    Param... extraParams)

getPlacePredictions

public List<Prediction> getPlacePredictions(String input,
                                            int offset,
                                            int lat,
                                            int lng,
                                            int radius,
                                            Param... extraParams)

Description copied from interface: GooglePlacesInterface

Returns a list of auto-complete predictions for searching for a specific place. The 'offset' is the position, in the input term, of the last character that the service uses to match predictions. For example, if the input is 'Google' and the offset is 3, the service will match on 'Goo'. The string determined by the offset is matched against the first word in the input term only. For example, if the input term is 'Google abc' and the offset is 3, the service will attempt to match against 'Goo abc'. If no offset is supplied, the service will use the whole term. The offset should generally be set to the position of the text caret. The lat, lng, and radius parameter specify and area in which you would like to search.

Specified by:

getPlacePredictions in interface GooglePlacesInterface

Parameters:

input - user input

offset - offset of text caret

lat - latitude

lng - longitude

radius - radius

extraParams - to append to request url

Returns:

list of predictions

getPlacePredictions

public List<Prediction> getPlacePredictions(String input,
                                            int offset,
                                            Param... extraParams)

Description copied from interface: GooglePlacesInterface

Returns a list of auto-complete predictions for searching for a specific place. The 'offset' is the position, in the input term, of the last character that the service uses to match predictions. For example, if the input is 'Google' and the offset is 3, the service will match on 'Goo'. The string determined by the offset is matched against the first word in the input term only. For example, if the input term is 'Google abc' and the offset is 3, the service will attempt to match against 'Goo abc'. If no offset is supplied, the service will use the whole term. The offset should generally be set to the position of the text caret.

Specified by:

getPlacePredictions in interface GooglePlacesInterface

Parameters:

input - user input

offset - offset of text caret

Returns:

list of predictions

getPlacePredictions

public List<Prediction> getPlacePredictions(String input,
                                            Param... extraParams)

Description copied from interface: GooglePlacesInterface

Returns a list of auto-complete predictions for searching for a specific place.

Specified by:

getPlacePredictions in interface GooglePlacesInterface

Parameters:

input - user input

extraParams - extra params to include in url

Returns:

list of predictions

getQueryPredictions

public List<Prediction> getQueryPredictions(String input,
                                            int offset,
                                            int lat,
                                            int lng,
                                            int radius,
                                            Param... extraParams)

Description copied from interface: GooglePlacesInterface

Returns a list of auto-complete predictions for searching for a place by a query. The 'offset' is the position, in the input term, of the last character that the service uses to match predictions. For example, if the input is 'Google' and the offset is 3, the service will match on 'Goo'. The string determined by the offset is matched against the first word in the input term only. For example, if the input term is 'Google abc' and the offset is 3, the service will attempt to match against 'Goo abc'. If no offset is supplied, the service will use the whole term. The offset should generally be set to the position of the text caret. The lat, lng, and radius parameter specify and area in which you would like to search.

Specified by:

getQueryPredictions in interface GooglePlacesInterface

Parameters:

input - user input

extraParams - to append to request url

Returns:

list of predictions

getQueryPredictions

public List<Prediction> getQueryPredictions(String input,
                                            int offset,
                                            Param... extraParams)

Description copied from interface: GooglePlacesInterface

Returns a list of auto-complete predictions for searching for a place by a query. The 'offset' is the position, in the input term, of the last character that the service uses to match predictions. For example, if the input is 'Google' and the offset is 3, the service will match on 'Goo'. The string determined by the offset is matched against the first word in the input term only. For example, if the input term is 'Google abc' and the offset is 3, the service will attempt to match against 'Goo abc'. If no offset is supplied, the service will use the whole term. The offset should generally be set to the position of the text caret.

Specified by:

getQueryPredictions in interface GooglePlacesInterface

Parameters:

input - user input

offset - offset of text caret

extraParams - extra params to append to url

Returns:

list of predictions

getQueryPredictions

public List<Prediction> getQueryPredictions(String input,
                                            Param... extraParams)

Description copied from interface: GooglePlacesInterface

Returns a list of auto-complete predictions for searching for a place by a query.

Specified by:

getQueryPredictions in interface GooglePlacesInterface

Parameters:

input - user input

extraParams - extra parameters to append to url

Returns:

list of predictions