GeoFire-Android

Current Production: NA
Current Pre-Production: 0.0.2

GeoFire-Android adds location based searching capability to the popular Google Firebase Firestore platform.

Usage

GeoFire works with your exiting Firebase Firestore setup. To use it add the following line to your gradle file.

implementation 'uk.co.mgbramwell.geofire:geofire-android:0.0.2'

You'll need to set up GeoFire to use your collection:

private FirebaseFirestore db = FirebaseFirestore.getInstance();
private CollectionReference myCollection = db.collection("myCollection");
private GeoFire geoFire = new GeoFire(myCollection);

When saving your documents, in the onComplete listener you'll need to get GeoFire to update the document with its calculated location (you obviously need to replace the document object with whatever object you're working with):

geoFire.setLocation(document.getId(), document.getLatitude(), document.getLongitude());

If you want to check if the insert is successful, make your class implement SetLocationListener, and look for exceptions in the onComplete method:

Map<String, Object> user = new HashMap<>();
user.put("first", "Ada");
user.put("last", "Lovelace");
user.put("born", 1815);
user.put("latitude", 123.456);
user.put("longitude", -1.23456);

// Add a new document with a generated ID
db.collection("users")
        .add(user)
        .addOnSuccessListener(new OnSuccessListener<DocumentReference>() {
            @Override
            public void onSuccess(DocumentReference documentReference) {
                Log.d(TAG, "DocumentSnapshot added with ID: " + documentReference.getId());
                geoFire.setLocation(documentReference.getId(), user.get("latitude"), user.get("longitude"), this);
            }
        })
        .addOnFailureListener(new OnFailureListener() {
            @Override
            public void onFailure(@NonNull Exception e) {
                Log.w(TAG, "Error adding document", e);
            }
        });

@Override
public void onComplete(Exception e){
 DO_STUFF_HERE
};

You can then use GeoFire as shown below. The line .whereNearTo is the important bit, but you can use any other standard Firestore query language as normal:

QueryLocation queryLocation = QueryLocation.fromDegrees(latitude, longitude);
Distance searchDistance = new Distance(1.0, DistanceUnit.KILOMETERS);
geoFire.query()
    .whereEqualTo("title", "The Title")
    .whereNearTo(queryLocation, distance)
    .orderBy("timestamp", Query.Direction.DESCENDING)
    .limit(10)
    .build()
    .get()
    .addOnCompleteListener(task -> {
      if (task.isSuccessful()) {
        Log.i("DB", "Got Documents.");
      } else {
        Log.w("DB", "Error getting documents.", task.getException());
      }
    });