org.locationtech.geowave.adapter.vector.ingest

Class AbstractSimpleFeatureIngestPlugin<I>

java.lang.Object

org.locationtech.geowave.adapter.vector.ingest.AbstractSimpleFeatureIngestPlugin<I>

All Implemented Interfaces:

Persistable, GeoWaveAvroFormatPlugin<I,org.opengis.feature.simple.SimpleFeature>, GeoWaveAvroPluginBase<I>, GeoWaveAvroSchemaProvider, IngestFromHdfsPlugin<I,org.opengis.feature.simple.SimpleFeature>, DataAdapterProvider<org.opengis.feature.simple.SimpleFeature>, IndexProvider, IngestPluginBase<URL,org.opengis.feature.simple.SimpleFeature>, LocalFileIngestPlugin<org.opengis.feature.simple.SimpleFeature>, LocalPluginBase

Direct Known Subclasses:

GDELTIngestPlugin, GeoLifeIngestPlugin, GeoWaveAvroIngestPlugin, GpxIngestPlugin, TdriveIngestPlugin, TwitterIngestPlugin

public abstract class AbstractSimpleFeatureIngestPlugin<I>
extends Object
implements LocalFileIngestPlugin<org.opengis.feature.simple.SimpleFeature>, IngestFromHdfsPlugin<I,org.opengis.feature.simple.SimpleFeature>, GeoWaveAvroFormatPlugin<I,org.opengis.feature.simple.SimpleFeature>, Persistable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractSimpleFeatureIngestPlugin.AbstractIngestSimpleFeatureWithMapper<I>

Field Summary

Fields

Modifier and Type	Field and Description
protected CQLFilterOptionProvider	filterOptionProvider
protected FeatureSerializationOptionProvider	serializationFormatOptionProvider
protected GeometrySimpOptionProvider	simpOptionProvider
protected TypeNameOptionProvider	typeNameProvider

Constructor Summary

Constructors

Constructor and Description
AbstractSimpleFeatureIngestPlugin()

Method Summary

Modifier and Type	Method and Description
void	fromBinary(byte[] bytes) Convert a stream of binary bytes to fields and data within an object.
DataTypeAdapter<org.opengis.feature.simple.SimpleFeature>[]	getDataAdapters(String globalVisibility) Get all writable adapters used by this plugin
protected abstract org.opengis.feature.simple.SimpleFeatureType[]	getTypes()
protected DataTypeAdapter<org.opengis.feature.simple.SimpleFeature>	newAdapter(org.opengis.feature.simple.SimpleFeatureType type, FieldVisibilityHandler<org.opengis.feature.simple.SimpleFeature,Object> fieldVisiblityHandler)
void	setFilterProvider(CQLFilterOptionProvider filterOptionProvider)
void	setGeometrySimpOptionProvider(GeometrySimpOptionProvider geometryProvider)
void	setSerializationFormatProvider(FeatureSerializationOptionProvider serializationFormatOptionProvider)
void	setTypeNameProvider(TypeNameOptionProvider typeNameProvider)
byte[]	toBinary() Convert fields and data within an object to binary form for transmission or storage.
CloseableIterator<GeoWaveData<org.opengis.feature.simple.SimpleFeature>>	toGeoWaveData(URL input, String[] indexNames, String globalVisibility) Convert from an expected input format to a data format that can be directly ingested into GeoWave
protected abstract CloseableIterator<GeoWaveData<org.opengis.feature.simple.SimpleFeature>>	toGeoWaveDataInternal(I hdfsObject, String[] indexNames, String globalVisibility)
protected CloseableIterator<GeoWaveData<org.opengis.feature.simple.SimpleFeature>>	wrapIteratorWithFilters(CloseableIterator<GeoWaveData<org.opengis.feature.simple.SimpleFeature>> geowaveData)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.locationtech.geowave.core.store.ingest.DataAdapterProvider

getSupportedIndexableTypes

Methods inherited from interface org.locationtech.geowave.core.ingest.hdfs.mapreduce.IngestFromHdfsPlugin

ingestWithMapper, ingestWithReducer, isUseReducerPreferred

Methods inherited from interface org.locationtech.geowave.core.ingest.avro.GeoWaveAvroFormatPlugin

getIngestWithAvroPlugin

Methods inherited from interface org.locationtech.geowave.core.ingest.avro.GeoWaveAvroPluginBase

toAvroObjects

Methods inherited from interface org.locationtech.geowave.core.ingest.avro.GeoWaveAvroSchemaProvider

getAvroSchema

Methods inherited from interface org.locationtech.geowave.core.store.ingest.LocalPluginBase

getFileExtensionFilters, init, supportsFile

Methods inherited from interface org.locationtech.geowave.core.store.ingest.IndexProvider

getRequiredIndices

Field Detail

filterOptionProvider

protected CQLFilterOptionProvider filterOptionProvider

serializationFormatOptionProvider

protected FeatureSerializationOptionProvider serializationFormatOptionProvider

typeNameProvider

protected TypeNameOptionProvider typeNameProvider

simpOptionProvider

protected GeometrySimpOptionProvider simpOptionProvider

Constructor Detail

AbstractSimpleFeatureIngestPlugin

public AbstractSimpleFeatureIngestPlugin()

Method Detail

setFilterProvider

public void setFilterProvider(CQLFilterOptionProvider filterOptionProvider)

setSerializationFormatProvider

public void setSerializationFormatProvider(FeatureSerializationOptionProvider serializationFormatOptionProvider)

setTypeNameProvider

public void setTypeNameProvider(TypeNameOptionProvider typeNameProvider)

setGeometrySimpOptionProvider

public void setGeometrySimpOptionProvider(GeometrySimpOptionProvider geometryProvider)

toBinary

public byte[] toBinary()

Description copied from interface: Persistable

Convert fields and data within an object to binary form for transmission or storage.

Specified by:

toBinary in interface Persistable

Returns:

an array of bytes representing a binary stream representation of the object.

fromBinary

public void fromBinary(byte[] bytes)

Description copied from interface: Persistable

Convert a stream of binary bytes to fields and data within an object.

Specified by:

fromBinary in interface Persistable

newAdapter

protected DataTypeAdapter<org.opengis.feature.simple.SimpleFeature> newAdapter(org.opengis.feature.simple.SimpleFeatureType type,
                                                                               FieldVisibilityHandler<org.opengis.feature.simple.SimpleFeature,Object> fieldVisiblityHandler)

getTypes

protected abstract org.opengis.feature.simple.SimpleFeatureType[] getTypes()

getDataAdapters

public DataTypeAdapter<org.opengis.feature.simple.SimpleFeature>[] getDataAdapters(String globalVisibility)

Description copied from interface: DataAdapterProvider

Get all writable adapters used by this plugin

Specified by:

getDataAdapters in interface DataAdapterProvider<org.opengis.feature.simple.SimpleFeature>

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

toGeoWaveData

public CloseableIterator<GeoWaveData<org.opengis.feature.simple.SimpleFeature>> 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.feature.simple.SimpleFeature>

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

wrapIteratorWithFilters

protected CloseableIterator<GeoWaveData<org.opengis.feature.simple.SimpleFeature>> wrapIteratorWithFilters(CloseableIterator<GeoWaveData<org.opengis.feature.simple.SimpleFeature>> geowaveData)

toGeoWaveDataInternal

protected abstract CloseableIterator<GeoWaveData<org.opengis.feature.simple.SimpleFeature>> toGeoWaveDataInternal(I hdfsObject,
                                                                                                                  String[] indexNames,
                                                                                                                  String globalVisibility)