com.mapbox.services.api.utils.tidy

Class Tidy

java.lang.Object

com.mapbox.services.api.utils.tidy.Tidy

public class Tidy
extends java.lang.Object

Create a tidy geojson by resampling points in the feature based on sampling time and distance. Handy when geometries that have been converted from a noisy GPS/GPX output.

Since:

1.3.0

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DATE_FORMAT
static java.lang.String	KEY_COORD_TIMES

Constructor Summary

Constructors

Constructor and Description
Tidy() Constructor that uses a default 10 meter distance, 5 second minimum time and 100 default points.
Tidy(int minimumDistance, int minimumTime, int maximumPoints) Constructor allowing you to pass in specific values for distance, time, and max points.

Method Summary

Modifier and Type	Method and Description
com.mapbox.services.commons.geojson.FeatureCollection	execute(com.mapbox.services.commons.geojson.FeatureCollection geojson) Method that performs the tidying of geojson route passed in.
java.text.SimpleDateFormat	getDateFormat()
int	getMaximumPoints()
int	getMinimumDistance()
int	getMinimumTime()
void	setDateFormat(java.text.SimpleDateFormat dateFormat)
void	setMaximumPoints(int maximumPoints)
void	setMinimumDistance(int minimumDistance)
void	setMinimumTime(int minimumTime)

Methods inherited from class java.lang.Object

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

Field Detail

KEY_COORD_TIMES

public static final java.lang.String KEY_COORD_TIMES

See Also:

Constant Field Values

DATE_FORMAT

public static final java.lang.String DATE_FORMAT

See Also:

Constant Field Values

Constructor Detail

Tidy

public Tidy()

Constructor that uses a default 10 meter distance, 5 second minimum time and 100 default points.

Since:

1.3.0

Tidy

public Tidy(int minimumDistance,
            int minimumTime,
            int maximumPoints)

Constructor allowing you to pass in specific values for distance, time, and max points.

Parameters:

minimumDistance - in meters between successive coordinates.

minimumTime - in milliseconds between successive coordinates.

maximumPoints - for output.

Since:

1.3.0

Method Detail

getMinimumDistance

public int getMinimumDistance()

Returns:

the minimum distance set; defaults 10 meters

Since:

1.3.0

setMinimumDistance

public void setMinimumDistance(int minimumDistance)

Parameters:

minimumDistance - set/update the minimum distance in meters between successive coordinates.

Since:

1.3.0

getMinimumTime

public int getMinimumTime()

Returns:

the minimum time set; defaults 5 seconds

Since:

1.3.0

setMinimumTime

public void setMinimumTime(int minimumTime)

Parameters:

minimumTime - set/update the minimum time in milliseconds between successive coordinates.

Since:

1.3.0

getMaximumPoints

public int getMaximumPoints()

Returns:

the maximum points set; defaults 100.

Since:

1.3.0

setMaximumPoints

public void setMaximumPoints(int maximumPoints)

Parameters:

maximumPoints - set/update the maximum points output; defaults 100.

Since:

1.3.0

getDateFormat

public java.text.SimpleDateFormat getDateFormat()

Returns:

either the default date format or one that you have set using setDateFormat(SimpleDateFormat).

Since:

1.3.0

setDateFormat

public void setDateFormat(java.text.SimpleDateFormat dateFormat)

Parameters:

dateFormat - set/update the date format used when execute(FeatureCollection) is called.

Since:

1.3.0

execute

public com.mapbox.services.commons.geojson.FeatureCollection execute(com.mapbox.services.commons.geojson.FeatureCollection geojson)
                                                              throws TurfException,
                                                                     ServicesException

Method that performs the tidying of geojson route passed in. It uses the parameters set when constructing the Tidy object or the values set using their respected setters. The result returned will be a GeoJSON FeatureCollection with similar coordinates removed.

Parameters:

geojson - FeatureCollection representing your route that you'd like to tidy up and remove similar unnecessary coordinates from.

Returns:

FeatureCollection with similar unnecessary coordinates that met within the parameters you specified, removed.

Throws:

TurfException - signals that a Turf exception of some sort has occurred.

ServicesException - if error occurs Mapbox API related.

Since:

1.3.0