public class Tidy extends Object
Modifier and Type | Field and Description |
---|---|
static String |
DATE_FORMAT |
static String |
KEY_COORD_TIMES |
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.
|
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.
|
SimpleDateFormat |
getDateFormat() |
int |
getMaximumPoints() |
int |
getMinimumDistance() |
int |
getMinimumTime() |
void |
setDateFormat(SimpleDateFormat dateFormat) |
void |
setMaximumPoints(int maximumPoints) |
void |
setMinimumDistance(int minimumDistance) |
void |
setMinimumTime(int minimumTime) |
public static final String KEY_COORD_TIMES
public static final String DATE_FORMAT
public Tidy()
public Tidy(int minimumDistance, int minimumTime, int maximumPoints)
minimumDistance
- in meters between successive coordinates.minimumTime
- in milliseconds between successive coordinates.maximumPoints
- for output.public int getMinimumDistance()
public void setMinimumDistance(int minimumDistance)
minimumDistance
- set/update the minimum distance in meters between successive
coordinates.public int getMinimumTime()
public void setMinimumTime(int minimumTime)
minimumTime
- set/update the minimum time in milliseconds between successive coordinates.public int getMaximumPoints()
public void setMaximumPoints(int maximumPoints)
maximumPoints
- set/update the maximum points output; defaults 100.public SimpleDateFormat getDateFormat()
setDateFormat(SimpleDateFormat)
.public void setDateFormat(SimpleDateFormat dateFormat)
dateFormat
- set/update the date format used when execute(FeatureCollection)
is called.public com.mapbox.services.commons.geojson.FeatureCollection execute(com.mapbox.services.commons.geojson.FeatureCollection geojson) throws TurfException, ServicesException
Tidy
object or the values set using their respected setters. The
result returned will be a GeoJSON FeatureCollection with similar coordinates removed.geojson
- FeatureCollection
representing your route that you'd like to tidy up
and remove similar unnecessary coordinates from.FeatureCollection
with similar unnecessary coordinates that met within the
parameters you specified, removed.TurfException
- signals that a Turf exception of some sort has occurred.ServicesException
- if error occurs Mapbox API related.© 2015–2016 Mapbox. All rights reserved.