Feature/improved search and results

geocoding/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 4.1.0
+
+* Added the ability to refine address search by geographic location
+* The search results' Location object now have new `title` and `description` fields
+
 ## 4.0.0
 
 * **BREAKING CHANGES** Please update to Flutter 3.29+ before updating to this version

geocoding/lib/geocoding.dart

@@ -11,10 +11,12 @@ export 'package:geocoding_platform_interface/geocoding_platform_interface.dart';
 /// resolved into a single [Location], multiple [Location] instances may be
 /// returned.
 Future<List<Location>> locationFromAddress(
-  String address,
-) =>
+  String address, {
+  Region? targetRegion,
+}) =>
     GeocodingPlatform.instance!.locationFromAddress(
       address,
+      targetRegion: targetRegion,
     );
 
 /// Returns a list of [Placemark] instances found for the supplied

geocoding/pubspec.yaml

@@ -1,6 +1,6 @@
 name: geocoding
 description: A Flutter Geocoding plugin which provides easy geocoding and reverse-geocoding features.
-version: 4.0.0
+version: 4.1.0
 repository: https://github.com/baseflow/flutter-geocoding/tree/main/geocoding
 issue_tracker: https://github.com/Baseflow/flutter-geocoding/issues
 
@@ -12,9 +12,9 @@ dependencies:
   flutter:
     sdk: flutter
 
-  geocoding_platform_interface: ^3.0.0
-  geocoding_android: ^4.0.0
-  geocoding_ios: ^3.0.0
+  geocoding_platform_interface: ^4.0.0
+  geocoding_android: ^4.1.0
+  geocoding_ios: ^3.1.0
 
 dev_dependencies:
   flutter_test:

geocoding/test/geocoding_test.dart

@@ -4,6 +4,8 @@ import 'package:mockito/mockito.dart';
 import 'package:plugin_platform_interface/plugin_platform_interface.dart';
 
 final mockLocation = Location(
+  title: '',
+  description: '',
   latitude: 52.2165157,
   longitude: 6.9437819,
   timestamp: DateTime.fromMillisecondsSinceEpoch(0).toUtc(),
@@ -48,8 +50,9 @@ class MockGeocodingPlatform extends Mock
         GeocodingPlatform {
   @override
   Future<List<Location>> locationFromAddress(
-    String address,
-  ) async {
+    String address, {
+    Region? targetRegion,
+  }) async {
     return [mockLocation];
   }
 

geocoding_android/android/src/main/java/com/baseflow/geocoding/Geocoding.java

@@ -52,14 +52,37 @@ boolean isPresent() {
      * @param callback the GeocodeListenerAdapter that listens for success or error
      * @return a list of Address objects. Returns null or empty list if no matches were found or there is no backend service available.
      */
-    void placemarkFromAddress(String address, GeocodeListenerAdapter callback) {
+    void placemarkFromAddress(
+        String address,
+        Double lowerLeftLatitude,
+        Double lowerLeftLongitude,
+        Double upperRightLatitude,
+        Double upperRightLongitude,
+        GeocodeListenerAdapter callback
+    ) {
         final Geocoder geocoder = createGeocoder(androidContext, locale);
 
         if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU) {
-            getAddressesWithGeocodeListener(geocoder, address, 5, callback);
+            getAddressesWithGeocodeListener(
+                geocoder,
+                address,
+                5,
+                lowerLeftLatitude,
+                lowerLeftLongitude,
+                upperRightLatitude,
+                upperRightLongitude,
+                callback
+            );
         } else {
             try {
-                List<Address> addresses = deprecatedGetFromLocationName(geocoder, address);
+                List<Address> addresses = deprecatedGetFromLocationName(
+                    geocoder,
+                    address,
+                    lowerLeftLatitude,
+                    lowerLeftLongitude,
+                    upperRightLatitude,
+                    upperRightLongitude
+                );
                 callback.onGeocode(addresses);
             } catch (IOException ex) {
                 callback.onError(ex.getMessage());
@@ -68,13 +91,33 @@ void placemarkFromAddress(String address, GeocodeListenerAdapter callback) {
     }
 
     @SuppressWarnings("deprecation")
-    private List<Address> deprecatedGetFromLocationName(Geocoder geocoder, String address) throws IOException {
-        return geocoder.getFromLocationName(address, 5);
+    private List<Address> deprecatedGetFromLocationName(
+        Geocoder geocoder,
+        String address,
+        Double lowerLeftLatitude,
+        Double lowerLeftLongitude,
+        Double upperRightLatitude,
+        Double upperRightLongitude
+    ) throws IOException {
+        if (lowerLeftLatitude == null || lowerLeftLongitude == null || upperRightLatitude == null || upperRightLongitude == null) {
+            return geocoder.getFromLocationName(address, 5);
+        } else {
+            return geocoder.getFromLocationName(address, 5, lowerLeftLatitude, lowerLeftLongitude, upperRightLatitude, upperRightLongitude);
+        }
     }
 
     @RequiresApi(api = Build.VERSION_CODES.TIRAMISU)
-    private void getAddressesWithGeocodeListener(Geocoder geocoder, String address, int maxResults, GeocodeListenerAdapter callback) {
-        geocoder.getFromLocationName(address, maxResults, new Geocoder.GeocodeListener() {
+    private void getAddressesWithGeocodeListener(
+        Geocoder geocoder,
+        String address,
+        int maxResults,
+        Double lowerLeftLatitude,
+        Double lowerLeftLongitude,
+        Double upperRightLatitude,
+        Double upperRightLongitude,
+        GeocodeListenerAdapter callback
+    ) {
+        final Geocoder.GeocodeListener listener = new Geocoder.GeocodeListener() {
             @Override
             public void onGeocode(List<Address> geocodedAddresses) {
                 callback.onGeocode(geocodedAddresses);
@@ -84,7 +127,12 @@ public void onGeocode(List<Address> geocodedAddresses) {
             public void onError(@Nullable String errorMessage) {
                 callback.onError(errorMessage);
             }
-        });
+        };
+        if (lowerLeftLatitude == null || lowerLeftLongitude == null || upperRightLatitude == null || upperRightLongitude == null) {
+            geocoder.getFromLocationName(address, maxResults, listener);
+        } else {
+            geocoder.getFromLocationName(address, maxResults, lowerLeftLatitude, lowerLeftLongitude, upperRightLatitude, upperRightLongitude, listener);
+        }
     }
 
 

geocoding_android/android/src/main/java/com/baseflow/geocoding/MethodCallHandlerImpl.java

@@ -104,6 +104,16 @@ private void setLocaleIdentifier(MethodCall call, Result result) {
         result.success(true);
     }
 
+    // Parses a string as a double and returns the parsed value.
+    // If parsing is not possible or fails, returns null.
+    private static Double parseDoubleOrReturnNull(final String _string){
+        try{
+            return Double.parseDouble(_string);
+        }catch (Throwable t){
+            return null;
+        }
+    }
+
     private void onLocationFromAddress(MethodCall call, Result result) {
         final String address = call.argument("address");
 
@@ -114,8 +124,13 @@ private void onLocationFromAddress(MethodCall call, Result result) {
                     null);
         }
 
-        geocoding.placemarkFromAddress(address, new GeocodeListenerAdapter() {
-
+        geocoding.placemarkFromAddress(
+            address,
+            parseDoubleOrReturnNull(call.argument("targetRegionSLat")), // lowerLeftLatitude,
+            parseDoubleOrReturnNull(call.argument("targetRegionWLng")), // lowerLeftLongitude,
+            parseDoubleOrReturnNull(call.argument("targetRegionNLat")), // upperRightLatitude,
+            parseDoubleOrReturnNull(call.argument("targetRegionELng")), // upperRightLongitude
+        new GeocodeListenerAdapter() {
             @Override
             public void onGeocode(List<Address> addresses) {
                 if (addresses != null && addresses.size() > 0) {
@@ -148,8 +163,13 @@ private void onPlacemarkFromAddress(final MethodCall call, final Result result)
                     null);
         }
 
-        geocoding.placemarkFromAddress(address, new GeocodeListenerAdapter() {
-
+        geocoding.placemarkFromAddress(
+            address,
+            parseDoubleOrReturnNull(call.argument("targetRegionSLat")), // lowerLeftLatitude,
+            parseDoubleOrReturnNull(call.argument("targetRegionWLng")), // lowerLeftLongitude,
+            parseDoubleOrReturnNull(call.argument("targetRegionNLat")), // upperRightLatitude,
+            parseDoubleOrReturnNull(call.argument("targetRegionELng")), // upperRightLongitude
+        new GeocodeListenerAdapter() {
             @Override
             public void onGeocode(List<Address> addresses) {
                 if (addresses != null && addresses.size() > 0) {

geocoding_android/android/src/main/java/com/baseflow/geocoding/utils/AddressMapper.java

@@ -55,6 +55,18 @@ public static List<Map<String, Object>> toLocationHashMapList(List<Address> addr
     private static Map<String, Object> toLocationHashmap(Address address) {
         Map<String, Object> location = new HashMap<>();
 
+        location.put("title", address.getFeatureName());
+        {
+            final int maxAddressLineIndex = address.getMaxAddressLineIndex();
+            final StringBuilder descriptionString = new StringBuilder();
+            for (int i = 0; i <= maxAddressLineIndex; i++) {
+                if (i > 0) {
+                    descriptionString.append("\n");
+                }
+                descriptionString.append(address.getAddressLine(i));
+            }
+            location.put("description", descriptionString.toString());
+        }
         location.put("latitude", address.getLatitude());
         location.put("longitude", address.getLongitude());
         location.put("timestamp", Calendar.getInstance(TimeZone.getTimeZone("UTC")).getTimeInMillis());

geocoding_android/lib/geocoding_android.dart

@@ -25,8 +25,9 @@ class GeocodingAndroid extends GeocodingPlatform {
 
   @override
   Future<List<Location>> locationFromAddress(
-    String address,
-  ) async {
+    String address, {
+    Region? targetRegion,
+  }) async {
     final parameters = <String, String>{
       'address': address,
     };

geocoding_android/pubspec.yaml

@@ -1,6 +1,6 @@
 name: geocoding_android
 description: A Flutter Geocoding plugin which provides easy geocoding and reverse-geocoding features.
-version: 4.0.1
+version: 4.1.0
 repository: https://github.com/baseflow/flutter-geocoding/tree/main/geocoding_android
 issue_tracker: https://github.com/Baseflow/flutter-geocoding/issues
 
@@ -12,7 +12,7 @@ dependencies:
   flutter:
     sdk: flutter
 
-  geocoding_platform_interface: ^3.2.0
+  geocoding_platform_interface: ^4.0.0
 
 dev_dependencies:
   flutter_test:

geocoding_android/test/geocoding_test.dart

@@ -4,6 +4,8 @@ import 'package:geocoding_android/geocoding_android.dart';
 import 'package:geocoding_platform_interface/geocoding_platform_interface.dart';
 
 final mockLocation = Location(
+  title: '',
+  description: '',
   latitude: 52.2165157,
   longitude: 6.9437819,
   timestamp: DateTime.fromMillisecondsSinceEpoch(0).toUtc(),

geocoding_ios/ios/Classes/Extensions/CLPlacemarkExtensions.m

@@ -39,8 +39,12 @@ - (NSDictionary *)toLocationDictionary {
     if (self.location == nil) {
         return nil;
     }
+
+    NSArray *lines = self.addressDictionary[@"FormattedAddressLines"];
 
     NSMutableDictionary<NSString *, NSObject*> *dict = [[NSMutableDictionary alloc] initWithDictionary:@{
+        @"title": self.name,
+        @"description": [lines componentsJoinedByString:@", "] ?: [NSNull null],
         @"latitude": @(self.location.coordinate.latitude),
         @"longitude": @(self.location.coordinate.longitude),
         @"timestamp": @([CLPlacemark currentTimeInMilliSeconds: self.location.timestamp]),

geocoding_ios/ios/Classes/GeocodingHandler.h

@@ -17,6 +17,10 @@ typedef void (^GeocodingFailure)(NSString* errorCode, NSString* errorDescription
 
 - (void) geocodeFromAddress: (NSString *)address
                      locale: (NSLocale *)locale
+                       sLat: (CGFloat)sLat
+                       wLng: (CGFloat)sLng
+                       nLat: (CGFloat)nLat
+                       eLng: (CGFloat)nLng
                     success: (_Nonnull GeocodingSuccess)successHandler
                     failure: (_Nonnull GeocodingFailure)failureHandler;
 

geocoding_ios/ios/Classes/GeocodingHandler.m

@@ -23,16 +23,32 @@ - (id)init {
 
 - (void) geocodeFromAddress: (NSString *)address
                      locale: (NSLocale *)locale
+                       sLat: (CGFloat) sLat
+                       wLng: (CGFloat) sLng
+                       nLat: (CGFloat) nLat
+                       eLng: (CGFloat) nLng
                     success: (GeocodingSuccess)successHandler
                     failure: (GeocodingFailure)failureHandler {
 
     if (address == nil) {
         failureHandler(@"ARGUMENT_ERROR", @"Please supply a valid string containing the address to lookup");
         return;
     }
-
+
+    CLRegion* region;
+    if (sLat == 0 || sLng == 0 || nLat == 0 || nLng == 0){
+        region = nil;
+    }else{
+        CLLocationCoordinate2D center = CLLocationCoordinate2DMake(sLat + (nLat-sLat) / 2, sLng + (nLng-sLng) / 2);
+        //Computing the radius based on lat delta, since 1 lat = 111 km no matter the location
+        float latDelta = nLat - sLat;
+        float radiusLat = (latDelta/2);
+        float radius = radiusLat * 111000;
+        region = [[CLCircularRegion alloc] initWithCenter:center radius:radius identifier:@"Search Radius"];
+    }
+
     [_geocoder geocodeAddressString:address
-                           inRegion:nil
+                           inRegion:region
                     preferredLocale:locale
                   completionHandler:^(NSArray< CLPlacemark *> *__nullable placemarks, NSError *__nullable error)
      {

geocoding_ios/ios/Classes/GeocodingPlugin.m

@@ -18,13 +18,27 @@ + (void)registerWithRegistrar:(NSObject<FlutterPluginRegistrar>*)registrar {
     [registrar addMethodCallDelegate:instance channel:channel];
 }
 
++ (CGFloat) parseCGFloat:(NSString*)numberString {
+    NSNumberFormatter *formatter = [[NSNumberFormatter alloc] init];
+    formatter.numberStyle=NSNumberFormatterDecimalStyle;
+    return [[formatter numberFromString:numberString] doubleValue];
+}
+
 - (void)handleMethodCall:(FlutterMethodCall*)call result:(FlutterResult)result {
     if ([@"locationFromAddress" isEqualToString:call.method]) {
         NSString* address = call.arguments[@"address"];
+        NSString* targetRegionSLat = call.arguments[@"targetRegionSLat"];
+        NSString* targetRegionNLat = call.arguments[@"targetRegionNLat"];
+        NSString* targetRegionWLng = call.arguments[@"targetRegionWLng"];
+        NSString* targetRegionELng = call.arguments[@"targetRegionELng"];
 
         GeocodingHandler* handler = [[GeocodingHandler alloc] init];
         [handler geocodeFromAddress:address
                              locale:[GeocodingPlugin parseLocale: call.arguments]
+                               sLat:[GeocodingPlugin parseCGFloat: targetRegionSLat]
+                               wLng:[GeocodingPlugin parseCGFloat: targetRegionWLng]
+                               nLat:[GeocodingPlugin parseCGFloat: targetRegionNLat]
+                               eLng:[GeocodingPlugin parseCGFloat: targetRegionELng]
                             success:^(NSArray<CLPlacemark *> * placemarks) {
             result([GeocodingPlugin toLocationResult: placemarks]);
         }

geocoding_ios/lib/geocoding_ios.dart

@@ -22,7 +22,10 @@ class GeocodingIOS extends GeocodingPlatform {
   }
 
   @override
-  Future<List<Location>> locationFromAddress(String address) async {
+  Future<List<Location>> locationFromAddress(
+    String address, {
+    Region? targetRegion,
+  }) async {
     final parameters = <String, String>{
       'address': address,
     };

geocoding_ios/pubspec.yaml

@@ -1,6 +1,6 @@
 name: geocoding_ios
 description: A Flutter Geocoding plugin which provides easy geocoding and reverse-geocoding features.
-version: 3.0.2
+version: 3.1.0
 repository: https://github.com/baseflow/flutter-geocoding/tree/main/geocoding_ios
 issue_tracker: https://github.com/Baseflow/flutter-geocoding/issues
 
@@ -12,7 +12,7 @@ dependencies:
   flutter:
     sdk: flutter
 
-  geocoding_platform_interface: ^3.2.0
+  geocoding_platform_interface: ^4.0.0
 
 dev_dependencies:
   flutter_test:

geocoding_ios/test/geocoding_test.dart

@@ -4,6 +4,8 @@ import 'package:geocoding_ios/geocoding_ios.dart';
 import 'package:geocoding_platform_interface/geocoding_platform_interface.dart';
 
 final mockLocation = Location(
+  title: '',
+  description: '',
   latitude: 52.2165157,
   longitude: 6.9437819,
   timestamp: DateTime.fromMillisecondsSinceEpoch(0).toUtc(),