winterwell.jtwitter

Class Place

java.lang.Object

winterwell.jtwitter.Place

All Implemented Interfaces:

com.winterwell.jgeoplanet.IPlace, java.io.Serializable

public class Place
extends java.lang.Object
implements com.winterwell.jgeoplanet.IPlace, java.io.Serializable

Support for Twitter's geo location features.

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.winterwell.jgeoplanet.IPlace

TYPE_CITY, TYPE_COUNTRY

Constructor Summary

Constructors

Constructor and Description
Place(com.winterwell.json.JSONObject _place, com.winterwell.jgeoplanet.IGeoCode geocoder)

Method Summary

Modifier and Type	Method and Description
com.winterwell.jgeoplanet.BoundingBox	getBoundingBox()
com.winterwell.jgeoplanet.Location	getCentroid()
java.lang.String	getCountryCode() ISO3166 2 letter code
java.lang.String	getCountryName()
java.lang.Class<? extends com.winterwell.jgeoplanet.IGeoCode>	getGeoCoder() Where did this come from? For debugging odd places.
java.util.List<com.winterwell.jgeoplanet.Location>	getGeometry()
java.lang.String	getId() Twitter ID for this place.
java.lang.String	getInfoUrl() Call this to get a JSON object with a lot of details.
java.lang.String	getName()
com.winterwell.jgeoplanet.IPlace	getParent()
java.lang.String	getType()
java.lang.String	getUID() An id which should be unique across services & stable across time & servers (i.e.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Place

public Place(com.winterwell.json.JSONObject _place,
             com.winterwell.jgeoplanet.IGeoCode geocoder)
      throws com.winterwell.json.JSONException

Throws:

com.winterwell.json.JSONException

Method Detail

getParent

public com.winterwell.jgeoplanet.IPlace getParent()

Specified by:

getParent in interface com.winterwell.jgeoplanet.IPlace

Returns:

the parent place, e.g. probably UK for London, if known, or null.

getGeoCoder

public java.lang.Class<? extends com.winterwell.jgeoplanet.IGeoCode> getGeoCoder()

Description copied from interface: com.winterwell.jgeoplanet.IPlace

Where did this come from? For debugging odd places.

Specified by:

getGeoCoder in interface com.winterwell.jgeoplanet.IPlace

Returns:

can be null

getBoundingBox

public com.winterwell.jgeoplanet.BoundingBox getBoundingBox()

Specified by:

getBoundingBox in interface com.winterwell.jgeoplanet.IPlace

Returns:

list of lat/long pairs. Can be null

getCountryCode

public java.lang.String getCountryCode()

Description copied from interface: com.winterwell.jgeoplanet.IPlace

ISO3166 2 letter code

Specified by:

getCountryCode in interface com.winterwell.jgeoplanet.IPlace

Returns:

getCountryName

public java.lang.String getCountryName()

getGeometry

public java.util.List<com.winterwell.jgeoplanet.Location> getGeometry()

Returns:

list of lat/long pairs. Usually null

getId

public java.lang.String getId()

Twitter ID for this place. Note: this is not a number.

getInfoUrl

public java.lang.String getInfoUrl()

Call this to get a JSON object with a lot of details. TODO wrap this in TwitterPlace

getName

public java.lang.String getName()

Specified by:

getName in interface com.winterwell.jgeoplanet.IPlace

getType

public java.lang.String getType()

Specified by:

getType in interface com.winterwell.jgeoplanet.IPlace

Returns:

e.g. "city", "admin" Often "admin" (which covers anything), so it's not clear how useful this is!

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getCentroid

public com.winterwell.jgeoplanet.Location getCentroid()

Specified by:

getCentroid in interface com.winterwell.jgeoplanet.IPlace

Returns:

the centroid (centre of mass) of this Place. Often approximate! Can be null.

getUID

public java.lang.String getUID()

Description copied from interface: com.winterwell.jgeoplanet.IPlace

An id which should be unique across services & stable across time & servers (i.e. the same place will give the same answer tomorrow or on a different computer).
In Winterwell projects, we usually call this an XId (eXternal-Id).

No hard guarantees are made for these properties! Implementations should make best reasonable efforts.

Specified by:

getUID in interface com.winterwell.jgeoplanet.IPlace

Returns:

service-specific-id@service-identifier, where service-identifier must not include "@". E.g. "54732176@twitter"