Search

Fulltext Search

Applications developed with the Sygic SDK can use geocoding to transform textual query into geographical information. Search engine works with few simple steps:

1. create search instance

2. register listener for search instance

   mListener = new Search.SearchResultsListener() {
       @Override
       public void onSearchResults(@NonNull String input, @SearchResult.ResultState int state,  @NonNull List<SearchResult> results) {
           // process results
       }
   };
   mSearch.addSearchResultsListener(mListener);

3. query any string to search for

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

4. get detail for results obtained via listener

   final DetailRequest request = new DetailRequest();
   mSearch.loadDetails(mapSearchResult, request, new Search.SearchDetailListener() {
       @Override
       public void onSearchDetail(@NonNull final MapSearchDetail mapSearchDetail, @SearchResult.ResultState int state) {
   
       }
   });

Online vs. offline

To use online or offline search, simply set searchService on the SearchRequest object. If there is no internet connection, offline search will be used as a fallback. For offline search, you need to have offline maps downloaded.

OnlineManager.getInstance().enableOnlineMapStreaming(online);
SearchRequest request = new SearchRequest(query);
mSearch.search(request);

Result types

There are different types of search results such as MapSearchResult - there is a place in map, that matches query, CoodrinateSearchResult - query was recognized as geographical coordinates. Other types are for data inserted to search via sdk, such as contacts or recent places. From MapSearchResult, you can retrieve its data type and various text fields such as getCity() and GetStreet(). From the fields you can also extract what part of it was matched by query, eg. to add highlighting. The MapSearchResult only has an approximate position that can be used to calculate coarse distance with SearchResult.distanceFrom(). To get exact position, you need to get details as shown below.

switch (mapSearchResult.getDataType()) {
    case MapSearchResult.DataType.Country:
    case MapSearchResult.DataType.Postal:
    case MapSearchResult.DataType.City:
    case MapSearchResult.DataType.Street:
    case MapSearchResult.DataType.AddressPoint:
    case MapSearchResult.DataType.PostalAddress:
    case MapSearchResult.DataType.PoiCategoryGroup:
    case MapSearchResult.DataType.PoiCategory:
    case MapSearchResult.DataType.Poi:
}

Details

To load details such as exact position of a result from sdk, you have to use MapSearchResult. Based on its type, MapSearchResult can be cast to its sybtypes such as DetailCity or DetailPoi to obtain relevant information for that type.

GeoCoordinates position = mapSearchDetail.getPosition();
GeoBoundingBox boundingBox = mapSearchDetail.getBoundingBox(); // eg. bounds of a city

switch (mapSearchDetail.getType()) {
    case MapSearchResult.DataType.City:
        boolean capital = ((DetailCity) mapSearchDetail).isCapital();
        //...
        break;
    case MapSearchResult.DataType.Poi:
        LocationInfo locationInfo = ((DetailPoi) mapSearchDetail).getLocationInfo();
        //...
        break;
    //...
}

When you don't need listen dor search result, you can unregister listener by calling

mSearch.removeSearchResultsListener(mListener);

Places

You can search Points Of Interest (POI) near a location via Places api. By defining PoiInfo.PoiCategory or PoiInfo.PoiGroup you can search places of certain type (eg. find restaurants around user). All places can be searched by passing PoiInfo.PoiGroup.Unknown.

Places places = new Places();
GeoCoordinates position = new GeoCoordinates(42.673, 19.144);
CategoryRequest request = new CategoryRequest(position, PoiInfo.PoiCategory.Restaurant, 200);
places.searchPlaces(request, new Places.PlacesListener() {
    @Override
    public void onPlacesLoaded(final List<Place> list) {
        // process places
    }
});

places.searchPlaces(new GroupRequest(position, PoiInfo.PoiGroup.Accommodation, 1000),
        new Places.PlacesListener() {
            @Override
            public void onPlacesLoaded(final List<Place> list) {
                // process places
            }
        });

Reverse geocoding

Reverse geocoding is opposite process to geocoding, meaning you query by geographical location and receive textual address of the location.

ReverseGeocoder reverseGeocoder = new ReverseGeocoder();
GeoCoordinates position = new GeoCoordinates(42.673, 19.144);
reverseGeocoder.search(position, new ReverseGeocoder.ReverseSearchResultsListener() {
    @Override
    public void onSearchResults(@NonNull final List<ReverseSearchResult> results, @NonNull final GeoCoordinates position) {
        for (final ReverseSearchResult result : results) {
            String country = result.getNames().getCountryIso();
            String city = result.getNames().getCity();
            String street = result.getNames().getStreet();
        }
    }
});