prajna.geo

Class GoogleLocator

java.lang.Object

prajna.geo.GeoLocator

prajna.geo.GoogleLocator

public class GoogleLocator
extends GeoLocator

Implementation of a GeoLocator which uses the Google lookup service. This class requires a key to be set before using it, and has a limited number of queries it will respond to in a day. See the Google Maps API for more information.

Author:

Edward Swing

Constructor Summary

Constructors

Constructor and Description
GoogleLocator() Create a GoogleLocator with the estimate flag set to false
GoogleLocator(boolean doEstimate) Create a GoogleLocator with the specified estimate flag

Method Summary

Methods

Modifier and Type	Method and Description
GeoCoord	getCoordinate(java.lang.String locName) Request the geographic coordinate from the Google Map server.
boolean	isEstimateFlag() Return whether the locator allows estimation
GeoShape	lookup(Location loc) Look up the shape associated with the specified Location
GeoShape	lookup(java.lang.String locName) Look up the shape associated with the specified Location by name
GeoShape	lookup(java.lang.String locName, java.lang.String type) Look up the shape associated with the specified Location by name and type
void	setEstimateFlag(boolean estimateFlag) Set the flag indicating whether to allow estimation within the locator.
static void	setKey(java.lang.String keyString) Set the Google Map API key

Methods inherited from class prajna.geo.GeoLocator

getFeatureType

Methods inherited from class java.lang.Object

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

Constructor Detail

GoogleLocator

public GoogleLocator()

Create a GoogleLocator with the estimate flag set to false

GoogleLocator

public GoogleLocator(boolean doEstimate)

Create a GoogleLocator with the specified estimate flag

Parameters:

doEstimate - the estimate flag

Method Detail

getCoordinate

public GeoCoord getCoordinate(java.lang.String locName)

Request the geographic coordinate from the Google Map server.

Specified by:

getCoordinate in class GeoLocator

Parameters:

locName - Location name.

Returns:

the coordinate for the given location

isEstimateFlag

public boolean isEstimateFlag()

Return whether the locator allows estimation

Specified by:

isEstimateFlag in class GeoLocator

Returns:

whether the locator allows estimation

lookup

public GeoShape lookup(Location loc)

Look up the shape associated with the specified Location

Specified by:

lookup in class GeoLocator

Parameters:

loc - the specified location object

Returns:

The geographic shape representing the specified location

lookup

public GeoShape lookup(java.lang.String locName)

Look up the shape associated with the specified Location by name

Specified by:

lookup in class GeoLocator

Parameters:

locName - the specified location name

Returns:

The geographic shape representing the specified location

lookup

public GeoShape lookup(java.lang.String locName,
              java.lang.String type)

Look up the shape associated with the specified Location by name and type

Specified by:

lookup in class GeoLocator

Parameters:

locName - the specified location name

type - the type of location the name represents

Returns:

The geographic shape representing the specified location

setEstimateFlag

public void setEstimateFlag(boolean estimateFlag)

Set the flag indicating whether to allow estimation within the locator.

Specified by:

setEstimateFlag in class GeoLocator

Parameters:

estimateFlag - whether the locator allows estimation

setKey

public static void setKey(java.lang.String keyString)

Set the Google Map API key

Parameters:

keyString - the Google Map API key