com.firebase.geofire

Class GeoFire

java.lang.Object

com.firebase.geofire.GeoFire

public class GeoFire
extends Object

A GeoFire instance is used to store geo location data in Firebase.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GeoFire.CompletionListener A listener that can be used to be notified about a successful write or an error on writing.

Constructor Summary

Constructors

Constructor and Description
GeoFire(com.firebase.client.Firebase firebase) Creates a new GeoFire instance at the given Firebase reference.

Method Summary

Methods

Modifier and Type	Method and Description
com.firebase.client.Firebase	getFirebase()
void	getLocation(String key, LocationCallback callback) Gets the current location for a key and calls the callback with the current value.
GeoQuery	queryAtLocation(GeoLocation center, double radius) Returns a new Query object centered at the given location and with the given radius.
void	removeLocation(String key) Removes the location for a key from this GeoFire.
void	removeLocation(String key, GeoFire.CompletionListener completionListener) Removes the location for a key from this GeoFire.
void	setLocation(String key, GeoLocation location) Sets the location for a given key.
void	setLocation(String key, GeoLocation location, GeoFire.CompletionListener completionListener) Sets the location for a given key.

Methods inherited from class java.lang.Object

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

Constructor Detail

GeoFire

public GeoFire(com.firebase.client.Firebase firebase)

Creates a new GeoFire instance at the given Firebase reference.

Parameters:

firebase - The Firebase reference this GeoFire instance uses

Method Detail

getFirebase

public com.firebase.client.Firebase getFirebase()

Returns:

The Firebase reference this GeoFire instance uses

setLocation

public void setLocation(String key,
               GeoLocation location)

Sets the location for a given key.

Parameters:

key - The key to save the location for

location - The location of this key

setLocation

public void setLocation(String key,
               GeoLocation location,
               GeoFire.CompletionListener completionListener)

Sets the location for a given key.

Parameters:

key - The key to save the location for

location - The location of this key

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

removeLocation

public void removeLocation(String key)

Removes the location for a key from this GeoFire.

Parameters:

key - The key to remove from this GeoFire

removeLocation

public void removeLocation(String key,
                  GeoFire.CompletionListener completionListener)

Removes the location for a key from this GeoFire.

Parameters:

key - The key to remove from this GeoFire

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

getLocation

public void getLocation(String key,
               LocationCallback callback)

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

Parameters:

key - The key whose location to get

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

queryAtLocation

public GeoQuery queryAtLocation(GeoLocation 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

Returns:

The new GeoQuery object