org.locationtech.geowave.examples.ingest.plugin

Class CustomIngestFormat

java.lang.Object

org.locationtech.geowave.adapter.vector.ingest.MinimalSimpleFeatureIngestFormat

org.locationtech.geowave.examples.ingest.plugin.CustomIngestFormat

All Implemented Interfaces:

IngestFormatPluginProviderSpi<AvroWholeFile,org.opengis.feature.simple.SimpleFeature>

public class CustomIngestFormat
extends MinimalSimpleFeatureIngestFormat

In order for the custom ingest plugin to be usable via the GeoWave CLI, it must be registered as an available format. This can be done by extending the MinimalSimpleFeatureIngestFormat class and registering the new class. The ingest format can be registered by adding it to `src/main/resources/META-INF/services/org.locationtech.geowave.core.ingest.spi.IngestFormatPluginProviderSpi`.

Field Summary

Fields inherited from class org.locationtech.geowave.adapter.vector.ingest.MinimalSimpleFeatureIngestFormat

myOptions

Constructor Summary

Constructors

Constructor and Description
CustomIngestFormat()

Method Summary

Modifier and Type	Method and Description
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.
protected MinimalSimpleFeatureIngestPlugin	newPluginInstance(IngestFormatOptions options)

Methods inherited from class org.locationtech.geowave.adapter.vector.ingest.MinimalSimpleFeatureIngestFormat

createAvroFormatPlugin, createIngestFromHdfsPlugin, createLocalFileIngestPlugin, createOptionsInstances, internalGetIngestFormatOptionProviders

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomIngestFormat

public CustomIngestFormat()

Method Detail

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.

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.

Returns:

The user-friendly full description for this data format

newPluginInstance

protected MinimalSimpleFeatureIngestPlugin newPluginInstance(IngestFormatOptions options)

Specified by:

newPluginInstance in class MinimalSimpleFeatureIngestFormat