prajna.geo

Class EsriLocator

java.lang.Object

prajna.geo.GeoLocator

prajna.geo.EsriLocator

public class EsriLocator
extends GeoLocator

Implementation of a GeoLocator using ESRI shape files. This locator maintains a set of EsriReaders to access the contents of different shape files. The locator can locate any named geographic shape within the available shape files.

Author:

Edward Swing

Constructor Summary

Constructors

Constructor and Description
EsriLocator(java.net.URL esriBase) Create a new EsriLocator using the specified URL as a base for locating shape files.

Method Summary

Methods

Modifier and Type	Method and Description
GeoReader	addFile(java.lang.String fileName) Add a specific shape file to the locator.
java.util.Set<java.lang.String>	getAllNames() Get the set of all geographic names known to this locator
GeoCoord	getCoordinate(java.lang.String locName) Discover the geographic coordinate for the requested location.
GeoReader	getReader(java.lang.String type) Get the particular reader associated with a type.
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.

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

EsriLocator

public EsriLocator(java.net.URL esriBase)

Create a new EsriLocator using the specified URL as a base for locating shape files. This URL can reference either a local file system directory or a publicly-accessible web directory

Parameters:

esriBase - the base URL for locating shape files

Method Detail

addFile

public GeoReader addFile(java.lang.String fileName)

Add a specific shape file to the locator. This method attempts to access a shape file at the url base with the specified file base name. If the file exists and is readable, the shapes for the file are loaded. If the file has already been added, the reader used to access the file is returned.

Parameters:

fileName - ESRI shape file name.

Returns:

the EsriReader used to read that shape file

getAllNames

public java.util.Set<java.lang.String> getAllNames()

Get the set of all geographic names known to this locator

Returns:

the set of all geographic names

getCoordinate

public GeoCoord getCoordinate(java.lang.String locName)

Discover the geographic coordinate for the requested location. If the location is a region, the center point is returned.

Specified by:

getCoordinate in class GeoLocator

Parameters:

locName - location name

Returns:

the coordinate for the given location

getReader

public GeoReader getReader(java.lang.String type)

Get the particular reader associated with a type. This method will return the reader which was used to read the shape file with the type argument as a base name

Parameters:

type - Type of reader, corresponding to the shape file name

Returns:

the EsriReader used to read that shapefile

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. This method returns the shape retrieved from the shape file matching 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. This method returns the shape retrieved from the shape file matching the specified 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. The type corresponds to the base file name for the ESRI readers used by this locator. This method returns the shape retrieved from the shape file matching the specified 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. The estimate flag is ignored for this locator.

Specified by:

setEstimateFlag in class GeoLocator

Parameters:

estimateFlag - whether the locator allows estimation