org.codice.ddf.spatial.geocoding

Interface GeoEntryIndexer

All Known Implementing Classes:

GeoNamesLuceneIndexer

public interface GeoEntryIndexer

A GeoEntryIndexer provides methods for adding GeoEntry objects to a new or existing local index.

Method Summary

Modifier and Type	Method and Description
void	updateIndex(List<GeoEntry> newEntries, boolean create, ProgressCallback progressCallback) Updates a GeoNames index with a List of GeoEntry objects.
void	updateIndex(String resource, GeoEntryExtractor geoEntryExtractor, boolean create, ProgressCallback progressCallback) Updates a GeoNames index with GeoEntry objects extracted by a GeoEntryExtractor.

Method Detail

updateIndex

void updateIndex(List<GeoEntry> newEntries,
                 boolean create,
                 ProgressCallback progressCallback)
          throws GeoEntryIndexingException

Updates a GeoNames index with a List of GeoEntry objects.

Parameters:

newEntries - the List of GeoEntry objects to add to the index

create - true will create a new index and false will add to the existing index

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

Throws:

GeoEntryIndexingException - if an error occurs while indexing the new entries

updateIndex

void updateIndex(String resource,
                 GeoEntryExtractor geoEntryExtractor,
                 boolean create,
                 ProgressCallback progressCallback)
          throws GeoEntryIndexingException,
                 GeoEntryExtractionException,
                 GeoNamesRemoteDownloadException

Updates a GeoNames index with GeoEntry objects extracted by a GeoEntryExtractor.

Parameters:

resource - the resource containing GeoNames entries

geoEntryExtractor - the GeoEntryExtractor that will extract GeoEntry objects from resource

create - true will create a new index and false will add to the existing index

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

Throws:

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

GeoEntryIndexingException - if an error occurs while indexing the new entries

GeoNamesRemoteDownloadException - if an error occurs while downloading from a remote source