org.imperiumlabs.geofirestore

Class GeoFirestore

java.lang.Object

org.imperiumlabs.geofirestore.GeoFirestore

public class GeoFirestore
extends java.lang.Object

A GeoFirestore instance is used to store geo location data in Firestore.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GeoFirestore.CompletionListener A listener that can be used to be notified about a successful write or an error on writing.
static interface	GeoFirestore.LocationCallback A callback that can be used to retrieve a location or an error in retrieving a location.

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.logging.Logger	LOGGER

Constructor Summary

Constructors

Constructor and Description
GeoFirestore(com.google.firebase.firestore.CollectionReference collectionReference) Creates a new GeoFirestore instance at the given Firestore collection reference.

Method Summary

Modifier and Type	Method and Description
com.google.firebase.firestore.CollectionReference	getCollectionReference()
void	getLocation(java.lang.String documentID, GeoFirestore.LocationCallback callback) Gets the current location for a document and calls the callback with the current value.
static com.google.firebase.firestore.GeoPoint	getLocationValue(com.google.firebase.firestore.DocumentSnapshot documentSnapshot)
GeoQuery	queryAtLocation(com.google.firebase.firestore.GeoPoint center, double radius) Returns a new Query object centered at the given location and with the given radius.
void	raiseEvent(java.lang.Runnable r)
void	removeLocation(java.lang.String documentID) Removes the location of a document from this GeoFirestore instance.
void	removeLocation(java.lang.String documentID, GeoFirestore.CompletionListener completionListener) Removes the location of a document from this GeoFirestore.
void	setLocation(java.lang.String documentID, com.google.firebase.firestore.GeoPoint location) Sets the location of a document.
void	setLocation(java.lang.String documentID, com.google.firebase.firestore.GeoPoint location, GeoFirestore.CompletionListener completionListener) Sets the location of a document.

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

public static java.util.logging.Logger LOGGER

Constructor Detail

GeoFirestore

public GeoFirestore(com.google.firebase.firestore.CollectionReference collectionReference)

Creates a new GeoFirestore instance at the given Firestore collection reference.

Parameters:

collectionReference - The Firestore collection reference this GeoFirestore instance uses

Method Detail

getLocationValue

public static com.google.firebase.firestore.GeoPoint getLocationValue(com.google.firebase.firestore.DocumentSnapshot documentSnapshot)

getCollectionReference

public com.google.firebase.firestore.CollectionReference getCollectionReference()

Returns:

The Firestore collection reference this GeoFirestore instance uses

setLocation

public void setLocation(java.lang.String documentID,
                        com.google.firebase.firestore.GeoPoint location)

Sets the location of a document.

Parameters:

documentID - The documentID of the document to save the location for

location - The location of this document

setLocation

public void setLocation(java.lang.String documentID,
                        com.google.firebase.firestore.GeoPoint location,
                        GeoFirestore.CompletionListener completionListener)

Sets the location of a document.

Parameters:

documentID - The documentID of the document to save the location for

location - The location of this document

completionListener - A listener that is called once the location was successfully saved on the server or an error occurred

removeLocation

public void removeLocation(java.lang.String documentID)

Removes the location of a document from this GeoFirestore instance.

Parameters:

documentID - The documentID of the document to remove from this GeoFirestore instance

removeLocation

public void removeLocation(java.lang.String documentID,
                           GeoFirestore.CompletionListener completionListener)

Removes the location of a document from this GeoFirestore.

Parameters:

documentID - The documentID of the document to remove from this GeoFirestore

completionListener - A completion listener that is called once the location is successfully removed from the server or an error occurred

getLocation

public void getLocation(java.lang.String documentID,
                        GeoFirestore.LocationCallback callback)

Gets the current location for a document and calls the callback with the current value.

Parameters:

documentID - The documentID of the document whose location to get

callback - The callback that is called once the location is retrieved

queryAtLocation

public GeoQuery queryAtLocation(com.google.firebase.firestore.GeoPoint center,
                                double radius)

Returns a new Query object centered at the given location and with the given radius.

Parameters:

center - The center of the query

radius - The radius of the query, in kilometers. The maximum radius that is supported is about 8587km. If a radius bigger than this is passed we'll cap it.

Returns:

The new GeoQuery object

raiseEvent

public void raiseEvent(java.lang.Runnable r)