prajna.geo

Class GeoLocator

java.lang.Object

prajna.geo.GeoLocator

Direct Known Subclasses:

EsriLocator, GeoNamesLocator, GoogleLocator

public abstract class GeoLocator
extends java.lang.Object

Abstract class representing a lookup service for geographic entities. This class should query a geographic source and return coordinates for a named geographic entity.

Author:

Edward Swing

Constructor Summary

Constructors

Constructor and Description
GeoLocator()

Method Summary

Methods

Modifier and Type	Method and Description
abstract GeoCoord	getCoordinate(java.lang.String locName) Look up the coordinate associated with the specified Location.
GeoFeatureType	getFeatureType(java.lang.String locName) Get the feature type for the location name.
abstract boolean	isEstimateFlag() Return whether the locator allows estimation
abstract GeoShape	lookup(Location loc) Look up the shape associated with the specified Location
abstract GeoShape	lookup(java.lang.String locName) Look up the shape associated with the specified Location by name
abstract GeoShape	lookup(java.lang.String locName, java.lang.String type) Look up the shape associated with the specified Location by name and type
abstract void	setEstimateFlag(boolean estimateFlag) Set the flag indicating whether to allow estimation within the locator.

Methods inherited from class java.lang.Object

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

Constructor Detail

GeoLocator

public GeoLocator()

Method Detail

getCoordinate

public abstract GeoCoord getCoordinate(java.lang.String locName)

Look up the coordinate associated with the specified Location. If the location is a region, the center point is returned.

Parameters:

locName - the specified location object

Returns:

The geographic coordinate for the specified location

getFeatureType

public GeoFeatureType getFeatureType(java.lang.String locName)

Get the feature type for the location name. The default implementation returns GeoFeatureType.OTHER

Parameters:

locName - the location name

Returns:

the GeoFeatureType for the geographic feature, or null if no location matches the specified name. The default implementation returns GeoFeatureType.OTHER.

isEstimateFlag

public abstract boolean isEstimateFlag()

Return whether the locator allows estimation

Returns:

whether the locator allows estimation

lookup

public abstract GeoShape lookup(Location loc)

Look up the shape associated with the specified Location

Parameters:

loc - the specified location object

Returns:

The geographic shape representing the specified location

lookup

public abstract GeoShape lookup(java.lang.String locName)

Look up the shape associated with the specified Location by name

Parameters:

locName - the specified location name

Returns:

The geographic shape representing the specified location

lookup

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

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

Parameters:

locName - the specified location name

type - the type of location the name represents

Returns:

The geographic shape representing the specified location

setEstimateFlag

public abstract void setEstimateFlag(boolean estimateFlag)

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

Parameters:

estimateFlag - whether the locator allows estimation