com.firebase.geofire

Class GeoQuery

java.lang.Object

com.firebase.geofire.GeoQuery

public class GeoQuery
extends Object

A GeoQuery object can be used for geo queries in a given circle. The GeoQuery class is thread safe.

Method Summary

Modifier and Type	Method and Description
void	addGeoQueryDataEventListener(GeoQueryDataEventListener listener) Adds a new GeoQueryEventListener to this GeoQuery.
void	addGeoQueryEventListener(GeoQueryEventListener listener) Adds a new GeoQueryEventListener to this GeoQuery.
GeoLocation	getCenter() Returns the current center of this query.
double	getRadius() Returns the radius of the query, in kilometers.
void	removeAllListeners() Removes all event listeners from this GeoQuery.
void	removeGeoQueryEventListener(GeoQueryDataEventListener listener) Removes an event listener.
void	removeGeoQueryEventListener(GeoQueryEventListener listener) Removes an event listener.
void	setCenter(GeoLocation center) Sets the new center of this query and triggers new events if necessary.
void	setLocation(GeoLocation center, double radius) Sets the center and radius (in kilometers) of this query, and triggers new events if necessary.
void	setRadius(double radius) Sets the radius of this query, in kilometers, and triggers new events if necessary.

Methods inherited from class java.lang.Object

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

Method Detail

addGeoQueryEventListener

public void addGeoQueryEventListener(GeoQueryEventListener listener)

Adds a new GeoQueryEventListener to this GeoQuery.

Parameters:

listener - The listener to add

Throws:

IllegalArgumentException - If this listener was already added

addGeoQueryDataEventListener

public void addGeoQueryDataEventListener(GeoQueryDataEventListener listener)

Adds a new GeoQueryEventListener to this GeoQuery.

Parameters:

listener - The listener to add

Throws:

IllegalArgumentException - If this listener was already added

removeGeoQueryEventListener

public void removeGeoQueryEventListener(GeoQueryEventListener listener)

Removes an event listener.

Parameters:

listener - The listener to remove

Throws:

IllegalArgumentException - If the listener was removed already or never added

removeGeoQueryEventListener

public void removeGeoQueryEventListener(GeoQueryDataEventListener listener)

Removes an event listener.

Parameters:

listener - The listener to remove

Throws:

IllegalArgumentException - If the listener was removed already or never added

removeAllListeners

public void removeAllListeners()

Removes all event listeners from this GeoQuery.

getCenter

public GeoLocation getCenter()

Returns the current center of this query.

Returns:

The current center

setCenter

public void setCenter(GeoLocation center)

Sets the new center of this query and triggers new events if necessary.

Parameters:

center - The new center

getRadius

public double getRadius()

Returns the radius of the query, in kilometers.

Returns:

The radius of this query, in kilometers

setRadius

public void setRadius(double radius)

Sets the radius of this query, in kilometers, and triggers new events if necessary.

Parameters:

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.

setLocation

public void setLocation(GeoLocation center,
                        double radius)

Sets the center and radius (in kilometers) of this query, and triggers new events if necessary.

Parameters:

center - The new center

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.