org.locationtech.geowave.format.geotools.raster

Class GeoToolsRasterDataStoreIngestFormat

java.lang.Object

org.locationtech.geowave.format.geotools.raster.GeoToolsRasterDataStoreIngestFormat

All Implemented Interfaces:

IngestFormatPluginProviderSpi<Object,org.opengis.coverage.grid.GridCoverage>

public class GeoToolsRasterDataStoreIngestFormat
extends Object
implements IngestFormatPluginProviderSpi<Object,org.opengis.coverage.grid.GridCoverage>

This represents an ingest format plugin provider for GeoTools grid coverage (raster) formats. It currently only supports ingesting data directly from a local file system into GeoWave.

Constructor Summary

Constructors

Constructor and Description
GeoToolsRasterDataStoreIngestFormat()

Method Summary

Modifier and Type	Method and Description
GeoWaveAvroFormatPlugin<Object,org.opengis.coverage.grid.GridCoverage>	createAvroFormatPlugin(IngestFormatOptions options) This plugin will be used by the ingestion framework to stage intermediate data from a local filesystem (for example to HDFS for map reduce ingest or to kafka for kafka ingest).
IngestFromHdfsPlugin<Object,org.opengis.coverage.grid.GridCoverage>	createIngestFromHdfsPlugin(IngestFormatOptions options) This plugin will be used by the ingestion framework to read data from HDFS in the form of the intermediate data format, and translate the intermediate data into the data entries that will be written in GeoWave.
LocalFileIngestPlugin<org.opengis.coverage.grid.GridCoverage>	createLocalFileIngestPlugin(IngestFormatOptions options) This plugin will be used by the ingestion framework to read data from a local file system, and translate supported files into the data entries that will be written directly in GeoWave.
IngestFormatOptions	createOptionsInstances() This is a means for a plugin to provide custom command-line options.
String	getIngestFormatDescription() This is a user-friendly full description of the data format that this plugin provider supports.
String	getIngestFormatName() This will represent the name for the format that is registered with the ingest framework and presented as a data format option via the commandline.

Methods inherited from class java.lang.Object

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

Constructor Detail

GeoToolsRasterDataStoreIngestFormat

public GeoToolsRasterDataStoreIngestFormat()

Method Detail

createAvroFormatPlugin

public GeoWaveAvroFormatPlugin<Object,org.opengis.coverage.grid.GridCoverage> createAvroFormatPlugin(IngestFormatOptions options)
                                                                                              throws UnsupportedOperationException

Description copied from interface: IngestFormatPluginProviderSpi

This plugin will be used by the ingestion framework to stage intermediate data from a local filesystem (for example to HDFS for map reduce ingest or to kafka for kafka ingest).

Specified by:

createAvroFormatPlugin in interface IngestFormatPluginProviderSpi<Object,org.opengis.coverage.grid.GridCoverage>

Returns:

The plugin for staging to avro if it is supported

Throws:

UnsupportedOperationException - If staging data is not supported (generally this implies that ingesting using map-reduce or kafka will not be supported)

createIngestFromHdfsPlugin

public IngestFromHdfsPlugin<Object,org.opengis.coverage.grid.GridCoverage> createIngestFromHdfsPlugin(IngestFormatOptions options)
                                                                                               throws UnsupportedOperationException

Description copied from interface: IngestFormatPluginProviderSpi

This plugin will be used by the ingestion framework to read data from HDFS in the form of the intermediate data format, and translate the intermediate data into the data entries that will be written in GeoWave.

Specified by:

createIngestFromHdfsPlugin in interface IngestFormatPluginProviderSpi<Object,org.opengis.coverage.grid.GridCoverage>

Returns:

The plugin for ingesting data from HDFS

Throws:

UnsupportedOperationException - If ingesting intermediate data from HDFS is not supported

createLocalFileIngestPlugin

public LocalFileIngestPlugin<org.opengis.coverage.grid.GridCoverage> createLocalFileIngestPlugin(IngestFormatOptions options)
                                                                                          throws UnsupportedOperationException

Description copied from interface: IngestFormatPluginProviderSpi

This plugin will be used by the ingestion framework to read data from a local file system, and translate supported files into the data entries that will be written directly in GeoWave.

Specified by:

createLocalFileIngestPlugin in interface IngestFormatPluginProviderSpi<Object,org.opengis.coverage.grid.GridCoverage>

Returns:

The plugin for ingesting data from a local file system directly into GeoWave

Throws:

UnsupportedOperationException - If ingesting data directly from a local file system is not supported

getIngestFormatName

public String getIngestFormatName()

Description copied from interface: IngestFormatPluginProviderSpi

This will represent the name for the format that is registered with the ingest framework and presented as a data format option via the commandline. For consistency, this name is preferably lower-case and without spaces, and should uniquely identify the data format as much as possible.

Specified by:

getIngestFormatName in interface IngestFormatPluginProviderSpi<Object,org.opengis.coverage.grid.GridCoverage>

Returns:

The name that will be associated with this format

getIngestFormatDescription

public String getIngestFormatDescription()

Description copied from interface: IngestFormatPluginProviderSpi

This is a user-friendly full description of the data format that this plugin provider supports. It will be presented to the command-line user as help when the registered data formats are listed.

Specified by:

getIngestFormatDescription in interface IngestFormatPluginProviderSpi<Object,org.opengis.coverage.grid.GridCoverage>

Returns:

The user-friendly full description for this data format

createOptionsInstances

public IngestFormatOptions createOptionsInstances()

Description copied from interface: IngestFormatPluginProviderSpi

This is a means for a plugin to provide custom command-line options. If this is null, there will be no custom options added.

Specified by:

createOptionsInstances in interface IngestFormatPluginProviderSpi<Object,org.opengis.coverage.grid.GridCoverage>

Returns:

The ingest format's option provider or null for no custom options