Search

Autocomplete and Geocoding

IMPORTANT!!! The version below is valid for SDK < 17 only, the tutorial for version 17 can be found even more below.

Applications developed with the Sygic SDK can use geocoding to transform textual query into geographical information. With the SearchManager you can perform three basic actions : Geocoding, ReverseGeocoding and Autocomplete. Please note that if you use the online services, you might want to define to send a request once every 300ms or so, otherwise some requests might end up with an error TOO_MANY_REQUESTS. The autocomplete engine works with few simple steps:

1. Create a SearchRequest

   final GeoCoordinates geoCoordinates = new GeoCoordinates(42.673, 19.144);
   final SearchRequest request = new SearchRequest("text", geoCoordinates);

2. Get the SearchManager's instance and call autocomplete on the instance using the search request and an AutocompleteResultListener that can also be created beforehand.

   SearchManagerProvider.getInstance(new InitializationCallback<SearchManager>() {
       @Override
       public void onInstance(@NonNull SearchManager searchManager) {
           searchManager.autocomplete(request, new SearchManager.AutocompleteResultListener() {
               @Override
               public void onAutocomplete(@NotNull List<AutocompleteResult> list) {
                   //do something with the results
               }
               @Override
               public void onAutcompleteError(@NotNull SearchManager.ErrorCode errorCode) {
               }
           });
       }
   
       @Override
       public void onError(int i) {
       }
   });

Online vs. offline

Whether online or offline search is executed depends on active data connection and value set in OnlineManager's enableOnlineMapStreaming(true/false). For offline search, you need to have offline maps downloaded. There's no fallback from online to offline search, so you will need to change the online status depending on the device's connection.

OnlineManagerProvider.getInstance(new InitializationCallback<OnlineManager>() {
    @Override
    public void onInstance(@NonNull OnlineManager onlineManager) {
        onlineManager.enableOnlineMapStreaming(true);
        onlineManager.addOnlineStatusListener(new OnlineManager.OnlineStatusListener() {
            @Override
            public void onStatusChanged(int i) {
            }
        });
    }
  @Override
  public void onError(int i) {
  }
});

Geocoding

After finding the desired result in autocomplete, you can take its locationID and call Geocode with it to get more precise information about the location. If you do not need to use autocomplete and have the full string that you want to search for, just use Geocode straight away.

mSearchManager.geocode(request, new SearchManager.GeocodingResultsListener() {
    @Override
    public void onGeocodingResultsError(@NotNull SearchManager.ErrorCode errorCode) {
    }
    @Override
    public void onGeocodingResults(@NotNull List<? extends GeocodingResult> list) {
        // do something with the results
    }
});

SDK VERSION 17 and higher:

The search now has SESSIONS (offline, online and hybrid):

A session has a limited lifetime. The lifetime follows this call graph:
[0..N] autocomplete requests
then either of
[1] do nothing -> close session
[1] geocode with location ID -> close session
[1] geocode with query -> close session
[1] search places with query -> [0..N] search places with continuation token -> close session

Also, the searchRequest now has a new parameter: countryIsoFilter

Also, the searchPlaces() function can be called via the session.

Simple examples:

ArrayList<String> categories = new ArrayList<>();
categories.add("SYTouristInformationOffice");
categories.add("SYMuseum");

GeoCoordinates position = new GeoCoordinates(51.510175, -0.122445);
PlaceRequest placeRequest = new PlaceRequest(position, categories, /*radius*/ 1000);
SearchRequest searchRequest = new SearchRequest("London Eye", new GeoCoordinates(51.510175, -0.122445));
Session session = search.newHybridSession(); // search was received via the SearchManagerProvider

session.autocomplete(searchRequest, new AutocompleteResultListener() {
    @Override
    public void onAutocomplete(@NotNull List<AutocompleteResult> list) {
    }

    @Override
    public void onAutocompleteError(@NotNull ResultStatus resultStatus) {
    }
});
session.geocode(searchRequest, new GeocodingResultsListener() {
    @Override
    public void onGeocodingResults(@NotNull List<? extends GeocodingResult> list) {
    }

    @Override
    public void onGeocodingResultsError(@NotNull ResultStatus resultStatus) {
    }
});
session.searchPlaces(placeRequest, new PlacesListener() {
     @Override
     public void onPlacesLoaded(@NotNull List<Place> list, @Nullable String s) {     
     }

     @Override
     public void onPlacesError(@NotNull ResultStatus resultStatus) {   
     }
});

Places

For version < 17. Tutorial on how to search places in the version 17 can be found just above.

You can search Places (POI) near a location via the PlacesManager api. By defining a PlaceCategories, you can search places of certain type (eg. find restaurants around user). All places can be searched by passing PlaceCategories.Unknown.

PlacesManagerProvider.getInstance(new CoreInitCallback<PlacesManager>() {
    @Override
    public void onInstance(@NonNull PlacesManager placesManager) {
        GeoCoordinates position = new GeoCoordinates(42.673, 19.144);
        PlaceRequest request = new PlaceRequest(position, /*radius*/ 200, /*maxResultCount*/ 20, 
                                        /*prefLanguage*/ "en-us", PlaceCategories.Restaurant, PlaceRequestFilterType.CATEGORY);

        placesManager.searchPlaces(request, new PlacesManager.PlacesListener() {
            @Override
            public void onPlacesLoaded(@NotNull List<Place> list) {
                // process places
            }
            @Override
            public void onPlacesError(@NotNull PlacesManager.ErrorCode errorCode) {
            }
        });
    }
    @Override
    public void onError(@NonNull CoreInitException e) {
    }
});

Reverse geocoding

Reverse geocoding is the opposite process to geocoding, meaning you query by geographical location and receive textual address of the location. You can define a filter if you do not want to take walkways into account or pass it an emptySet.

ReverseGeocoderProvider.getInstance(new CoreInitCallback<ReverseGeocoder>() {
    @Override
    public void onInstance(@NonNull ReverseGeocoder reverseGeocoder) {
        reverseGeocoder.reverseGeocode(position, Collections.emptySet(), new ReverseGeocoder.ReverseGeocodingResultListener() { // do not forget to filter out the walkways if you do not want them
            @Override
            public void onReverseGeocodingResult(@NotNull List<? extends ReverseGeocodingResult> list) {
            }

            @Override
            public void onReverseGeocodingResultError(@NotNull ReverseGeocoder.ErrorCode errorCode) {
            }
        });
    }

    @Override
    public void onError(CoreInitException e) {
    }
});