Package org.codice.ddf.spatial.geocoding

Interface GeoEntryExtractor

public interface GeoEntryExtractor

A GeoEntryExtractor provides methods for extracting GeoEntry objects from various GeoNames resources.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	GeoEntryExtractor.ExtractionCallback	An ExtractionCallback provides a method for receiving a GeoEntry object that has been extracted from a resource.

Method Summary

Modifier and Type	Method	Description
List<GeoEntry>	getGeoEntries(String resource, ProgressCallback progressCallback)	Extracts GeoNames entries from a resource as GeoEntry objects, all at once, providing updates about the extraction progress.
void	pushGeoEntriesToExtractionCallback(String resource, GeoEntryExtractor.ExtractionCallback extractionCallback)	Extracts GeoNames entries from a resource as GeoEntry objects and passes each GeoEntry object through the callback extractionCallback.
void	setUrl(String url)	Sets the url

Method Details

setUrl

void setUrl(String url)

Sets the url

Parameters:

url -

getGeoEntries

List<GeoEntry> getGeoEntries(String resource,
 ProgressCallback progressCallback)
                      throws GeoEntryExtractionException,
GeoNamesRemoteDownloadException

Extracts GeoNames entries from a resource as GeoEntry objects, all at once, providing updates about the extraction progress.

Parameters:

resource - the resource containing GeoNames entries

progressCallback - the callback to receive updates about the extraction progress, may be null if you don't want any updates

Returns:

the list of GeoEntry objects corresponding to the GeoNames entries in the resource

Throws:

GeoEntryExtractionException - if an error occurs while extracting GeoNames entries from the resource

GeoNamesRemoteDownloadException - if an error occurs while downloading from the resource

pushGeoEntriesToExtractionCallback

void pushGeoEntriesToExtractionCallback(String resource,
 GeoEntryExtractor.ExtractionCallback extractionCallback)
                                 throws GeoEntryExtractionException,
GeoNamesRemoteDownloadException

Extracts GeoNames entries from a resource as GeoEntry objects and passes each GeoEntry object through the callback extractionCallback. The callback is called exactly once for each GeoEntry object extracted from the resource.

This method should be used instead of getGeoEntries(String, ProgressCallback) if the resource contains a very large number of entries.

Parameters:

resource - the resource containing GeoNames entries

extractionCallback - the callback that receives each extracted GeoEntry object, must not be null

Throws:

IllegalArgumentException - if extractionCallback is null

GeoEntryExtractionException - if an error occurs while extracting GeoNames entries from the resource

GeoNamesRemoteDownloadException - if an error occurs while downloading from the resource