A D E G H I L P S T W

A

AdminRegion - Class in winterwell.jgeoplanet

An administrative region such as: State, Country, County, Province, District, Ward.

appIdUrl - Static variable in class winterwell.jgeoplanet.GeoPlanet

D

defaultLanguage - Static variable in class winterwell.jgeoplanet.GeoPlanet

Default language for convenience constructors.

defaultServiceUri - Static variable in class winterwell.jgeoplanet.GeoPlanet

Default serviceURI (the Yahoo! implementation) for convenience constructors.

E

equals(Object) - Method in class winterwell.jgeoplanet.Place

equals(Object) - Method in class winterwell.jgeoplanet.PlaceType

NB PlaceTypes are considered equal if they have the same code.

G

GeoPlanet - Class in winterwell.jgeoplanet

Java client library for the Yahoo! GeoPlanet service as described at: http://developer.yahoo.com/geo/geoplanet/

GeoPlanet(String) - Constructor for class winterwell.jgeoplanet.GeoPlanet

Convenience constructor for English language GeoPlanet applications.

GeoPlanet(String, String) - Constructor for class winterwell.jgeoplanet.GeoPlanet

Create a client for the GeoPlanet service using the specified application ID and language.

GeoPlanet(String, String, String) - Constructor for class winterwell.jgeoplanet.GeoPlanet

Create a client for the GeoPlanet service using the specified application ID, language and service URI.

GeoPlanetException - Exception in winterwell.jgeoplanet

Superclass for other exceptions thrown by the library.

GeoPlanetResource - Class in winterwell.jgeoplanet

A GeoPlanetResource is a resource bound to a particular GeoPlanet instance.

get(int, int) - Method in class winterwell.jgeoplanet.PlaceCollection

Get a list of (some of) the places contained in this collection.

get() - Method in class winterwell.jgeoplanet.PlaceCollection

Get all places in this collection.

get(int) - Method in class winterwell.jgeoplanet.PlaceCollection

Get a specific place from this collection.

getAdmin1() - Method in class winterwell.jgeoplanet.Place

One of the primary administrative areas within a country.

getAdmin2() - Method in class winterwell.jgeoplanet.Place

One of the secondary administrative areas within a country.

getAdmin3() - Method in class winterwell.jgeoplanet.Place

One of the tertiary administrative areas within a country.

getAncestors() - Method in class winterwell.jgeoplanet.Place

Places in the chain of parents for a given place.

getApplicationId() - Method in class winterwell.jgeoplanet.GeoPlanet

Return the Yahoo! application ID used by this client.

getBelongTos() - Method in class winterwell.jgeoplanet.Place

Returns a collection of places that have a place as a child or descendant (child of a child, etc).

getCentroid() - Method in class winterwell.jgeoplanet.Place

getChildren() - Method in class winterwell.jgeoplanet.Place

The direct inferiors to a given place.

getClient() - Method in class winterwell.jgeoplanet.GeoPlanetResource

Returns the client that was used to retrieve this place.

getCode() - Method in class winterwell.jgeoplanet.AdminRegion

Returns a short code for the region e.g.

getCode() - Method in class winterwell.jgeoplanet.PlaceType

Returns the numerical code corresponding to the place type e.g.

getDescription() - Method in class winterwell.jgeoplanet.PlaceType

Returns a natural language description of this place type.

getInvalidAppId() - Method in exception winterwell.jgeoplanet.InvalidAppIdException

Returns the problematic application ID

getInvalidPlaceTypeName() - Method in exception winterwell.jgeoplanet.InvalidPlaceType

Returns the invalid place type name that caused this exception.

getLanguage() - Method in class winterwell.jgeoplanet.GeoPlanet

Returns the language used by this client such as "en-gb".

getLatitude() - Method in class winterwell.jgeoplanet.Location

Returns the latitude of this location.

getLocality1() - Method in class winterwell.jgeoplanet.Place

getLocality2() - Method in class winterwell.jgeoplanet.Place

getLongForm() - Method in class winterwell.jgeoplanet.Place

getLongitude() - Method in class winterwell.jgeoplanet.Location

Returns the longitude of this location.

getName() - Method in class winterwell.jgeoplanet.AdminRegion

Returns the name of this administrative region.

getName() - Method in class winterwell.jgeoplanet.Place

getName() - Method in class winterwell.jgeoplanet.PlaceType

Returns the (localised) name of this place type e.g.

getNeighbors() - Method in class winterwell.jgeoplanet.Place

Places adjacent to a given place.

getNorthEast() - Method in class winterwell.jgeoplanet.Place

getParent() - Method in class winterwell.jgeoplanet.Place

Get the parent of this place: its direct superior in the hierarchy.

getPlace(long) - Method in class winterwell.jgeoplanet.GeoPlanet

getPlace(String) - Method in class winterwell.jgeoplanet.GeoPlanet

Returns the first Place whose name matches the query to some extent.

getPlaceName() - Method in exception winterwell.jgeoplanet.PlaceNotFoundException

Return the name (or WOE ID) that could not be found.

getPlaces(String) - Method in class winterwell.jgeoplanet.GeoPlanet

Returns a PlaceCollection of places whose names match the query to some extent.

getPlaceType(String) - Method in class winterwell.jgeoplanet.GeoPlanet

Look up a PlaceType by name.

getPlaceType(int) - Method in class winterwell.jgeoplanet.GeoPlanet

Look up a PlaceType by code.

getPlaceType() - Method in class winterwell.jgeoplanet.Place

getPlaceTypeNameVariant() - Method in class winterwell.jgeoplanet.Place

Retrieve a variant name for the place type.

getPlaceTypes() - Method in class winterwell.jgeoplanet.GeoPlanet

getPostal() - Method in class winterwell.jgeoplanet.Place

getServiceUri() - Method in class winterwell.jgeoplanet.GeoPlanet

Returns the base URI used by the client e.g.

getSiblings() - Method in class winterwell.jgeoplanet.Place

Places that share the same parent and have the same place type.

getSouthWest() - Method in class winterwell.jgeoplanet.Place

getType() - Method in class winterwell.jgeoplanet.AdminRegion

Returns the type of place this administrative region is.

getType() - Method in class winterwell.jgeoplanet.PlaceCollection

If this collection is filtered by place type, return that type otherwise return null.

getUri() - Method in class winterwell.jgeoplanet.PlaceType

Return a URI corresponding to this placeType

getWoeId() - Method in class winterwell.jgeoplanet.Place

H

hashCode() - Method in class winterwell.jgeoplanet.Place

hashCode() - Method in class winterwell.jgeoplanet.PlaceType

I

InvalidAppIdException - Exception in winterwell.jgeoplanet

Thrown if the GeoPlanet application ID was invalid.

InvalidAppIdException(String) - Constructor for exception winterwell.jgeoplanet.InvalidAppIdException

InvalidPlaceType - Exception in winterwell.jgeoplanet

Thrown if an invalid place type is cited.

InvalidPlaceType(String) - Constructor for exception winterwell.jgeoplanet.InvalidPlaceType

isLongForm() - Method in class winterwell.jgeoplanet.Place

Places may contain more or less detail depending on how they were arrived at.

isShortForm() - Method in class winterwell.jgeoplanet.PlaceCollection

L

Location - Class in winterwell.jgeoplanet

A geographical location expressed as a latitude and longitude

P

Place - Class in winterwell.jgeoplanet

A Place is a spatial entity associated with a Yahoo! GeoPlanet WOE ID.

PlaceCollection - Class in winterwell.jgeoplanet

A collection of Place objects.

PlaceNotFoundException - Exception in winterwell.jgeoplanet

Thrown when a place, specified by a WOE ID or search term could not be found.

PlaceType - Class in winterwell.jgeoplanet

A type of place such as: Country, Ocean, Town.

S

shortForm(boolean) - Method in class winterwell.jgeoplanet.PlaceCollection

Return short form places from this query.

size() - Method in class winterwell.jgeoplanet.PlaceCollection

Returns the total number of places in this collection if a get() has occurred, or -1 to indicate that no get has occurred.

T

toString() - Method in class winterwell.jgeoplanet.AdminRegion

toString() - Method in class winterwell.jgeoplanet.GeoPlanet

toString() - Method in class winterwell.jgeoplanet.Place

toString() - Method in class winterwell.jgeoplanet.PlaceType

type(PlaceType) - Method in class winterwell.jgeoplanet.PlaceCollection

Set the type filter.

type(String) - Method in class winterwell.jgeoplanet.PlaceCollection

Convenience wrapper for PlaceCollection.type(PlaceType).

W

winterwell.jgeoplanet - package winterwell.jgeoplanet

jGeoPlanet is an LGPL client library for the Yahoo! GeoPlanet service.

A D E G H I L P S T W