org.locationtech.geowave.format.gpx

Class GPXConsumer

java.lang.Object

org.locationtech.geowave.format.gpx.GPXConsumer

All Implemented Interfaces:

Closeable, AutoCloseable, Iterator<org.locationtech.geowave.core.store.ingest.GeoWaveData<org.opengis.feature.simple.SimpleFeature>>, org.locationtech.geowave.core.store.CloseableIterator<org.locationtech.geowave.core.store.ingest.GeoWaveData<org.opengis.feature.simple.SimpleFeature>>

public class GPXConsumer
extends Object
implements org.locationtech.geowave.core.store.CloseableIterator<org.locationtech.geowave.core.store.ingest.GeoWaveData<org.opengis.feature.simple.SimpleFeature>>

Consumes a GPX file. The consumer is an iterator, parsing the input stream and returning results as the stream is parsed. Data is emitted for each element at the 'end' tag.

Caution: Developers should maintain the cohesiveness of attribute names associated with each feature type defined in GpxUtils.

Route way points and way points are treated similarly except way points do not include the parent ID information in their ID. The assumption is that the name, lat and lon attributes are globally unique. In contrast, Route way points include the file name and parent route name as part of their ID. Routes are not assumed to be global.

Nested Class Summary

Nested classes/interfaces inherited from interface org.locationtech.geowave.core.store.CloseableIterator

org.locationtech.geowave.core.store.CloseableIterator.Empty<E>, org.locationtech.geowave.core.store.CloseableIterator.Wrapper<E>

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.opengis.feature.simple.SimpleFeatureType	pointType
protected static org.opengis.feature.simple.SimpleFeatureType	routeType
protected static org.opengis.feature.simple.SimpleFeatureType	trackType
protected static org.opengis.feature.simple.SimpleFeatureType	waypointType

Constructor Summary

Constructors

Constructor and Description
GPXConsumer(InputStream fileStream, String[] indexNames, String inputID, Map<String,Map<String,String>> additionalData, Long backTimestamp, boolean uniqueWayPoints, double maxLength)

Method Summary

Modifier and Type	Method and Description
void	close()
boolean	hasNext()
org.locationtech.geowave.core.store.ingest.GeoWaveData<org.opengis.feature.simple.SimpleFeature>	next()
void	remove()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Field Detail

pointType

protected static final org.opengis.feature.simple.SimpleFeatureType pointType

waypointType

protected static final org.opengis.feature.simple.SimpleFeatureType waypointType

trackType

protected static final org.opengis.feature.simple.SimpleFeatureType trackType

routeType

protected static final org.opengis.feature.simple.SimpleFeatureType routeType

Constructor Detail

GPXConsumer

public GPXConsumer(InputStream fileStream,
                   String[] indexNames,
                   String inputID,
                   Map<String,Map<String,String>> additionalData,
                   Long backTimestamp,
                   boolean uniqueWayPoints,
                   double maxLength)

Parameters:

fileStream -

indexNames -

inputID - prefix to all IDs except waypoints (see uniqueWayPoints)

additionalData - additional attributes to add the over-ride attributes in the GPX data file. The attribute are grouped by path. "gpx.trk", "gpx.rte" and "gpx.wpt"

backTimestamp -

uniqueWayPoints - if true, waypoints are globally unique, otherwise are unique to this file and should have inputID and other components added to the identifier

globalVisibility -

maxLength -

Method Detail

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<org.locationtech.geowave.core.store.ingest.GeoWaveData<org.opengis.feature.simple.SimpleFeature>>

next

public org.locationtech.geowave.core.store.ingest.GeoWaveData<org.opengis.feature.simple.SimpleFeature> next()

Specified by:

next in interface Iterator<org.locationtech.geowave.core.store.ingest.GeoWaveData<org.opengis.feature.simple.SimpleFeature>>

remove

public void remove()

Specified by:

remove in interface Iterator<org.locationtech.geowave.core.store.ingest.GeoWaveData<org.opengis.feature.simple.SimpleFeature>>

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface org.locationtech.geowave.core.store.CloseableIterator<org.locationtech.geowave.core.store.ingest.GeoWaveData<org.opengis.feature.simple.SimpleFeature>>