org.locationtech.geowave.format.geotools.raster

Class GeoToolsRasterDataStoreIngestPlugin

java.lang.Object

org.locationtech.geowave.format.geotools.raster.GeoToolsRasterDataStoreIngestPlugin

All Implemented Interfaces:

DataAdapterProvider<org.opengis.coverage.grid.GridCoverage>, IndexProvider, IngestPluginBase<URL,org.opengis.coverage.grid.GridCoverage>, LocalFileIngestPlugin<org.opengis.coverage.grid.GridCoverage>, LocalPluginBase

public class GeoToolsRasterDataStoreIngestPlugin
extends Object
implements LocalFileIngestPlugin<org.opengis.coverage.grid.GridCoverage>

This plugin is used for ingesting any GeoTools supported file data store from a local file system directly into GeoWave as GeoTools' SimpleFeatures. It supports the default configuration of spatial and spatial-temporal indices and does NOT currently support the capability to stage intermediate data to HDFS to be ingested using a map-reduce job.

Constructor Summary

Constructors

Constructor and Description
GeoToolsRasterDataStoreIngestPlugin()
GeoToolsRasterDataStoreIngestPlugin(RasterOptionProvider optionProvider)

Method Summary

Modifier and Type	Method and Description
DataTypeAdapter<org.opengis.coverage.grid.GridCoverage>[]	getDataAdapters(String globalVisibility) Get all writable adapters used by this plugin
String[]	getFileExtensionFilters() Gets a list of file extensions that this plugin supports.
Index[]	getRequiredIndices() Get an array of indices that are required by this ingest implementation.
Class<? extends CommonIndexValue>[]	getSupportedIndexableTypes() return a set of classes that can be indexed by this data adapter provider, used for compatibility checking with an index provider
void	init(URL baseDirectory) Initialize the plugin and give it the base directory that is provided by the user.
boolean	supportsFile(URL file) This method will be called for every file that matches the given extensions.
CloseableIterator<GeoWaveData<org.opengis.coverage.grid.GridCoverage>>	toGeoWaveData(URL input, String[] indexNames, String globalVisibility) Convert from an expected input format to a data format that can be directly ingested into GeoWave

Methods inherited from class java.lang.Object

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

Constructor Detail

GeoToolsRasterDataStoreIngestPlugin

public GeoToolsRasterDataStoreIngestPlugin()

GeoToolsRasterDataStoreIngestPlugin

public GeoToolsRasterDataStoreIngestPlugin(RasterOptionProvider optionProvider)

Method Detail

getFileExtensionFilters

public String[] getFileExtensionFilters()

Description copied from interface: LocalPluginBase

Gets a list of file extensions that this plugin supports. If not provided, this plugin will accept all file extensions.

Specified by:

getFileExtensionFilters in interface LocalPluginBase

Returns:

The array of file extensions supported ('.' is unnecessary)

init

public void init(URL baseDirectory)

Description copied from interface: LocalPluginBase

Initialize the plugin and give it the base directory that is provided by the user.

Specified by:

init in interface LocalPluginBase

Parameters:

baseDirectory - The base directory provided as a command-line argument (if the argument is a file, the base directory given will be its parent directory).

supportsFile

public boolean supportsFile(URL file)

Description copied from interface: LocalPluginBase

This method will be called for every file that matches the given extensions. It is an opportunity for the plugin to perform arbitrarily complex acceptance filtering on a per file basis, but it is important to understand performance implications if the acceptance test is too intensive and the directory of files to recurse is large.

Specified by:

supportsFile in interface LocalPluginBase

Parameters:

file - The file to determine if this plugin supports for ingestion

Returns:

Whether the file is supported or not

toGeoWaveData

public CloseableIterator<GeoWaveData<org.opengis.coverage.grid.GridCoverage>> toGeoWaveData(URL input,
                                                                                            String[] indexNames,
                                                                                            String globalVisibility)

Description copied from interface: IngestPluginBase

Convert from an expected input format to a data format that can be directly ingested into GeoWave

Specified by:

toGeoWaveData in interface IngestPluginBase<URL,org.opengis.coverage.grid.GridCoverage>

Parameters:

input - The expected input.

indexNames - The set of index IDs specified via a commandline argument (this is typically either the default spatial index or default spatial-temporal index)

globalVisibility - If on the command-line the user specifies a global visibility to write to the visibility column in GeoWave, it is passed along here. It is assumed that this is the same visibility string that will be passed to DataAdapterProvider.getDataAdapters()

Returns:

The objects that can be directly ingested into GeoWave

getDataAdapters

public DataTypeAdapter<org.opengis.coverage.grid.GridCoverage>[] getDataAdapters(String globalVisibility)

Description copied from interface: DataAdapterProvider

Get all writable adapters used by this plugin

Specified by:

getDataAdapters in interface DataAdapterProvider<org.opengis.coverage.grid.GridCoverage>

Parameters:

globalVisibility - If on the command-line the user specifies a global visibility to write to the visibility column in GeoWave, it is passed along here. It is assumed that this is the same visibility string that will be passed to IngestPluginBase.toGeoWaveData()

Returns:

An array of adapters that may be used by this plugin

getRequiredIndices

public Index[] getRequiredIndices()

Description copied from interface: IndexProvider

Get an array of indices that are required by this ingest implementation. This should be a subset of supported indices. All of these indices will automatically be persisted with GeoWave's metadata store (and in the job configuration if run as a job), whereas indices that are just "supported" will not automatically be persisted (only if they are the primary index). This is primarily useful if there is a supplemental index required by the ingest process that is not the primary index.

Specified by:

getRequiredIndices in interface IndexProvider

Returns:

the array of indices that are supported by this ingest implementation

getSupportedIndexableTypes

public Class<? extends CommonIndexValue>[] getSupportedIndexableTypes()

Description copied from interface: DataAdapterProvider

return a set of classes that can be indexed by this data adapter provider, used for compatibility checking with an index provider

Specified by:

getSupportedIndexableTypes in interface DataAdapterProvider<org.opengis.coverage.grid.GridCoverage>

Returns:

the classes that are indexable by this adapter provider