twitter4j

Class GeoQuery

java.lang.Object

twitter4j.GeoQuery

All Implemented Interfaces:

java.io.Serializable

public final class GeoQuery
extends java.lang.Object
implements java.io.Serializable

Since:

Twitter4J 2.1.1

Author:

Yusuke Yamamoto - yusuke at mac.com

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	accuracy
private java.lang.String	granularity
private java.lang.String	ip
private GeoLocation	location
private int	maxResults
private java.lang.String	query
private static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
GeoQuery(GeoLocation location) Creates a GeoQuery with the specified location
GeoQuery(java.lang.String ip) Creates a GeoQuery with the specified IP address
GeoQuery(java.lang.String query, java.lang.String ip, GeoLocation location) Creates a GeoQuery with the specified query, ip and location

Method Summary

Modifier and Type	Method and Description
GeoQuery	accuracy(java.lang.String accuracy)
private void	appendParameter(java.lang.String name, double value, java.util.List<HttpParameter> params)
private void	appendParameter(java.lang.String name, int value, java.util.List<HttpParameter> params)
private void	appendParameter(java.lang.String name, java.lang.String value, java.util.List<HttpParameter> params)
(package private) HttpParameter[]	asHttpParameterArray()
boolean	equals(java.lang.Object o)
java.lang.String	getAccuracy()
java.lang.String	getGranularity()
java.lang.String	getIp()
GeoLocation	getLocation()
int	getMaxResults()
java.lang.String	getQuery() Gets the query to filter Place results from geo/search
GeoQuery	granularity(java.lang.String granularity)
int	hashCode()
GeoQuery	maxResults(int maxResults)
void	setAccuracy(java.lang.String accuracy) Sets a hint on the "region" in which to search.
void	setGranularity(java.lang.String granularity) Sets the minimal granularity of data to return.
void	setMaxResults(int maxResults) Sets a hint as to the number of results to return.
void	setQuery(java.lang.String query)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

location

private GeoLocation location

query

private java.lang.String query

ip

private java.lang.String ip

accuracy

private java.lang.String accuracy

granularity

private java.lang.String granularity

maxResults

private int maxResults

Constructor Detail

GeoQuery

public GeoQuery(GeoLocation location)

Creates a GeoQuery with the specified location

Parameters:

location - geo location

GeoQuery

public GeoQuery(java.lang.String ip)

Creates a GeoQuery with the specified IP address

Parameters:

ip - IP address

GeoQuery

public GeoQuery(java.lang.String query,
                java.lang.String ip,
                GeoLocation location)

Creates a GeoQuery with the specified query, ip and location

Parameters:

query - free-form text to match

ip - IP address

location - geo location

Method Detail

getLocation

public GeoLocation getLocation()

getQuery

public java.lang.String getQuery()

Gets the query to filter Place results from geo/search

Returns:

the query

setQuery

public void setQuery(java.lang.String query)

getIp

public java.lang.String getIp()

getAccuracy

public java.lang.String getAccuracy()

setAccuracy

public void setAccuracy(java.lang.String accuracy)

Sets a hint on the "region" in which to search. If a number, then this is a radius in meters, but it can also take a string that is suffixed with ft to specify feet. If this is not passed in, then it is assumed to be 0m. If coming from a device, in practice, this value is whatever accuracy the device has measuring its location (whether it be coming from a GPS, WiFi triangulation, etc.).

Parameters:

accuracy - a hint on the "region" in which to search.

accuracy

public GeoQuery accuracy(java.lang.String accuracy)

getGranularity

public java.lang.String getGranularity()

setGranularity

public void setGranularity(java.lang.String granularity)

Sets the minimal granularity of data to return. If this is not passed in, then neighborhood is assumed. city can also be passed.

Parameters:

granularity - the minimal granularity of data to return

granularity

public GeoQuery granularity(java.lang.String granularity)

getMaxResults

public int getMaxResults()

setMaxResults

public void setMaxResults(int maxResults)

Sets a hint as to the number of results to return. This does not guarantee that the number of results returned will equal max_results, but instead informs how many "nearby" results to return. Ideally, only pass in the number of places you intend to display to the user here.

Parameters:

maxResults - A hint as to the number of results to return.

maxResults

public GeoQuery maxResults(int maxResults)

asHttpParameterArray

HttpParameter[] asHttpParameterArray()

appendParameter

private void appendParameter(java.lang.String name,
                             java.lang.String value,
                             java.util.List<HttpParameter> params)

appendParameter

private void appendParameter(java.lang.String name,
                             int value,
                             java.util.List<HttpParameter> params)

appendParameter

private void appendParameter(java.lang.String name,
                             double value,
                             java.util.List<HttpParameter> params)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object