org.codice.ddf.spatial.geocoding.plugin

Class GeoCoderPlugin

java.lang.Object

org.codice.ddf.spatial.geocoding.plugin.GeoCoderPlugin

All Implemented Interfaces:

PreIngestPlugin

public class GeoCoderPlugin
extends Object
implements PreIngestPlugin

The GeoCoderPlugin is responsible for adding a Location.COUNTRY_CODE in ISO 3166-1 format to Metacards that have the Metacard.GEOGRAPHY attribute.

Field Summary

Fields

Modifier and Type	Field and Description
static String	RADIUS_IN_KM

Constructor Summary

Constructors

Constructor and Description
GeoCoderPlugin(ServiceSelector<GeoCoder> geoCoderFactory)

Method Summary

Modifier and Type	Method and Description
int	getRadius()
CreateRequest	process(CreateRequest input) Process a CreateRequest prior to CatalogProvider.create(CreateRequest).
DeleteRequest	process(DeleteRequest input) Processes the DeleteRequest prior to the execution of the update operation.
UpdateRequest	process(UpdateRequest input) Process a UpdateRequest prior to CatalogProvider.update(UpdateRequest).
void	setRadiusInKm(int radius)
void	updateConfiguration(Map<String,Object> properties)

Methods inherited from class java.lang.Object

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

Field Detail

RADIUS_IN_KM

public static final String RADIUS_IN_KM

See Also:

Constant Field Values

Constructor Detail

GeoCoderPlugin

public GeoCoderPlugin(ServiceSelector<GeoCoder> geoCoderFactory)

Method Detail

process

public CreateRequest process(CreateRequest input)
                      throws PluginExecutionException,
                             StopProcessingException

Description copied from interface: PreIngestPlugin

Process a CreateRequest prior to CatalogProvider.create(CreateRequest).

Specified by:

process in interface PreIngestPlugin

Parameters:

input - the CreateRequest to process

Returns:

the value of the processed CreateRequest to pass to the next PreIngestPlugin, or to the CatalogProvider if this is the last PreIngestPlugin to be called

Throws:

PluginExecutionException - if an error in processing occurs

StopProcessingException

process

public UpdateRequest process(UpdateRequest input)
                      throws PluginExecutionException,
                             StopProcessingException

Description copied from interface: PreIngestPlugin

Process a UpdateRequest prior to CatalogProvider.update(UpdateRequest).

Specified by:

process in interface PreIngestPlugin

Parameters:

input - the UpdateRequest to process

Returns:

the value of the processed UpdateRequest to pass to the next PreIngestPlugin, or to the CatalogProvider if this is the last PreIngestPlugin to be called

Throws:

PluginExecutionException - if an error in processing occurs

StopProcessingException

process

public DeleteRequest process(DeleteRequest input)
                      throws PluginExecutionException,
                             StopProcessingException

Description copied from interface: PreIngestPlugin

Processes the DeleteRequest prior to the execution of the update operation.

Specified by:

process in interface PreIngestPlugin

Parameters:

input - the DeleteRequest to process

Returns:

the value of the processed DeleteRequest to pass to the next PreIngestPlugin, or if this is the last PreIngestPlugin to be called

Throws:

PluginExecutionException - thrown when an error in processing occurs

StopProcessingException

updateConfiguration

public void updateConfiguration(Map<String,Object> properties)

setRadiusInKm

public void setRadiusInKm(int radius)

getRadius

public int getRadius()