org.codice.ddf.spatial.geocoding.extract

Class GeoNamesFileExtractor

java.lang.Object

org.codice.ddf.spatial.geocoding.extract.GeoNamesFileExtractor

All Implemented Interfaces:

GeoEntryExtractor

public class GeoNamesFileExtractor
extends Object
implements GeoEntryExtractor

Nested Class Summary

Nested classes/interfaces inherited from interface org.codice.ddf.spatial.geocoding.GeoEntryExtractor

GeoEntryExtractor.ExtractionCallback

Constructor Summary

Constructors

Constructor and Description
GeoNamesFileExtractor()

Method Summary

Modifier and Type	Method and Description
void	closeConnection()
javax.ws.rs.core.Response	createConnection(String resource)
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.
InputStream	getUrlInputStreamFromWebClient()
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	setGeoEntryCreator(GeoEntryCreator geoEntryCreator)
void	setUrl(String url) Sets the url

Methods inherited from class java.lang.Object

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

Constructor Detail

GeoNamesFileExtractor

public GeoNamesFileExtractor()

Method Detail

setGeoEntryCreator

public void setGeoEntryCreator(GeoEntryCreator geoEntryCreator)

setUrl

public void setUrl(String url)

Description copied from interface: GeoEntryExtractor

Sets the url

Specified by:

setUrl in interface GeoEntryExtractor

getGeoEntries

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

Description copied from interface: GeoEntryExtractor

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

Specified by:

getGeoEntries in interface GeoEntryExtractor

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

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

Description copied from interface: GeoEntryExtractor

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 GeoEntryExtractor.getGeoEntries(String, ProgressCallback) if the resource contains a very large number of entries.

Specified by:

pushGeoEntriesToExtractionCallback in interface GeoEntryExtractor

Parameters:

resource - the resource containing GeoNames entries

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

Throws:

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

GeoNamesRemoteDownloadException - if an error occurs while downloading from the resource

createConnection

public javax.ws.rs.core.Response createConnection(String resource)

getUrlInputStreamFromWebClient

public InputStream getUrlInputStreamFromWebClient()
                                           throws GeoNamesRemoteDownloadException

Throws:

GeoNamesRemoteDownloadException

closeConnection

public void closeConnection()