TravelOptions (Route 360 Java Client 0.0.16 API)

java.lang.Object
- net.motionintelligence.client.api.TravelOptions

Direct Known Subclasses:

StatisticTravelOptions
```
@Entity
public class TravelOptions
extends Object
```
Common configuration class for executing all requests. Define source points, target points and other configuration values such as travel times, elevation etc. here. See: PolygonRequest, RouteRequest, TimeRequest, ReachabilityRequest.

Constructor Summary

Constructors
Constructor and Description

TravelOptions()

Constructors
Constructor and Description
`TravelOptions()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addAllSources(Map<String,Coordinate> inactiveSources)`
`void`	`addAllTargets(Collection<Coordinate> targets)`
`void`	`addAllTargets(Map<String,Coordinate> targets)`
`void`	`addSource(Coordinate source)`
`void`	`addTarget(Coordinate target)`
`void`	`clearAndAddSource(String id, Coordinate source)` Clear sources and add new one
`boolean`	`equals(Object o)`
`Boolean`	`getAppendTravelTimes()`
`double`	`getBikeDownhill()`
`double`	`getBikeSpeed()`
`double`	`getBikeUphill()`
`String`	`getBoundingBox()`
`Double`	`getBuffer()` Get the buffer value of polygons.
`Set<PoiType>`	`getCustomPois()`
`int`	`getDate()`
`EdgeWeightType`	`getEdgeWeightType()`
`String`	`getFallbackServiceUrl()`
`Format`	`getFormat()`
`int`	`getFrame()`
`Integer`	`getId()`
`PolygonIntersectionMode`	`getIntersectionMode()`
`String`	`getInterServiceKey()`
`Integer`	`getMaxEdgeWeight()`
`Integer`	`getMaxRoutingLength()` Deprecated.
`int`	`getMaxRoutingTime()` Deprecated.
`long`	`getMinPolygonHoleSize()`
`boolean`	`getOnlyPrintReachablePoints()`
`Set<PoiType>`	`getOsmTypes()`
`String`	`getOverpassQuery()`
`String`	`getOverpassServiceUrl()`
`PathSerializerType`	`getPathSerializer()`
`String`	`getPointOfInterestServiceUrl()`
`PolygonSerializerType`	`getPolygonSerializerType()`
`int`	`getRecommendations()`
`Boolean`	`getReverse()`
`String`	`getServiceKey()`
`String`	`getServiceUrl()`
`Coordinate`	`getSource(String id)`
`double[][]`	`getSourceCoordinates()`
`Map<String,Coordinate>`	`getSources()`
`Integer`	`getSrid()`
`Integer`	`getStatisticGroupId()`
`List<Short>`	`getStatisticIds()`
`String`	`getStatisticServiceUrl()`
`Coordinate`	`getTarget(String id)`
`double[][]`	`getTargetCoordinates()`
`Map<String,Coordinate>`	`getTargets()`
`int`	`getTime()`
`List<Integer>`	`getTravelTimes()`
`TravelType`	`getTravelType()`
`Set<TravelType>`	`getTravelTypes()`
`double`	`getWalkDownhill()`
`double`	`getWalkSpeed()`
`double`	`getWalkUphill()`
`int`	`hashCode()`
`Boolean`	`isElevationEnabled()`
`boolean`	`isPointReduction()`
`static void`	`main(String[] args)`
`void`	`setAppendTravelTimes(Boolean appendTravelTimes)`
`void`	`setBikeDownhill(double bikeDownhill)`
`void`	`setBikeSpeed(double bikeSpeed)`
`void`	`setBikeUphill(double bikeUphill)`
`void`	`setBoundingBox(String boundingBox)`
`void`	`setBuffer(Double buffer)` Set how much the polygons will be buffered.
`void`	`setCustomPois(Set<PoiType> customPois)`
`void`	`setDate(Integer date)`
`void`	`setEdgeWeightType(EdgeWeightType edgeWeightType)`
`void`	`setElevationEnabled(Boolean elevationEnabled)`
`void`	`setFallbackServiceUrl(String fallbackServiceUrl)`
`void`	`setFormat(Format format)`
`void`	`setFrame(int frame)`
`void`	`setId(Integer id)`
`void`	`setIntersectionMode(PolygonIntersectionMode intersectionMode)`
`void`	`setInterServiceKey(String interServiceKey)`
`void`	`setMaxEdgeWeight(Integer maxEdgeWeight)`
`void`	`setMaxRoutingLength(Integer maxRoutingLength)` Deprecated.
`void`	`setMaxRoutingTime(int maxRoutingTime)` Deprecated.
`void`	`setMinPolygonHoleSize(long minPolygonHoleSize)`
`void`	`setOnlyPrintReachablePoints(boolean onlyPrintReachablePoints)` Determines whether to return only reachable points or all
`void`	`setOsmTypes(Set<PoiType> osmTypes)`
`void`	`setOverpassQuery(String overpassQuery)`
`void`	`setOverpassServiceUrl(String overpassServiceUrl)`
`void`	`setPathSerializer(PathSerializerType pathSerializer)`
`void`	`setPointReduction(boolean pointReduction)`
`void`	`setPolygonSerializerType(PolygonSerializerType polygonSerializerType)`
`void`	`setRecommendations(int recommendations)`
`void`	`setReverse(Boolean reverse)`
`void`	`setServiceKey(String serviceKey)`
`void`	`setServiceUrl(String serviceUrl)`
`void`	`setSources(Map<String,Coordinate> sources)`
`void`	`setSrid(Integer srid)`
`void`	`setStatisticGroupId(Integer statisticGroupId)`
`void`	`setStatisticIds(List<Short> statisticIds)`
`void`	`setStatisticServiceUrl(String statisticServiceUrl)`
`void`	`setTargets(Map<String,Coordinate> targets)`
`void`	`setTime(Integer time)`
`void`	`setTravelTimes(List<Integer> travelTimes)`
`void`	`setTravelType(TravelType travelType)`
`void`	`setTravelTypes(Set<TravelType> travelTypes)`
`void`	`setWalkDownhill(double walkDownhill)`
`void`	`setWalkSpeed(double walkSpeed)`
`void`	`setWalkUphill(double walkUphill)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail
- TravelOptions
```
public TravelOptions()
```

Method Detail

getFormat
```
public Format getFormat()
```

setFormat
```
public void setFormat(Format format)
```

getBoundingBox
```
public String getBoundingBox()
```

setBoundingBox

public void setBoundingBox(String boundingBox)

getCustomPois
```
public Set<PoiType> getCustomPois()
```

setCustomPois

public void setCustomPois(Set<PoiType> customPois)

getTravelTypes

public Set<TravelType> getTravelTypes()

setTravelTypes

public void setTravelTypes(Set<TravelType> travelTypes)

getOsmTypes
```
public Set<PoiType> getOsmTypes()
```

setOsmTypes

public void setOsmTypes(Set<PoiType> osmTypes)

getId
```
public Integer getId()
```

setId
```
public void setId(Integer id)
```

getSourceCoordinates
```
public double[][] getSourceCoordinates()
```
Returns:

source coordinates array

getTargetCoordinates
```
public double[][] getTargetCoordinates()
```
Returns:

target coordinates array

getSources

public Map<String,Coordinate> getSources()

Returns:: the sources

setSources

public void setSources(Map<String,Coordinate> sources)

Parameters:: sources - the sources to set

getTargets

public Map<String,Coordinate> getTargets()

Returns:: the targets

setTargets

public void setTargets(Map<String,Coordinate> targets)

Parameters:: targets - the targets to set

addAllTargets
```
public void addAllTargets(Map<String,Coordinate> targets)
```
Parameters:

targets - add all specified targets to the target map

addAllTargets

public void addAllTargets(Collection<Coordinate> targets)

getBikeSpeed
```
public double getBikeSpeed()
```
Returns:

the bikeSpeed

setBikeSpeed
```
public void setBikeSpeed(double bikeSpeed)
```
Parameters:

bikeSpeed - the bikeSpeed to set

getBikeUphill
```
public double getBikeUphill()
```
Returns:

the bikeUphill

setBikeUphill
```
public void setBikeUphill(double bikeUphill)
```
Parameters:

bikeUphill - the bikeUphill to set

getBikeDownhill
```
public double getBikeDownhill()
```
Returns:

the bikeDownhill

setBikeDownhill
```
public void setBikeDownhill(double bikeDownhill)
```
Parameters:

bikeDownhill - the bikeDownhill to set

getWalkSpeed
```
public double getWalkSpeed()
```
Returns:

the walkSpeed

setWalkSpeed
```
public void setWalkSpeed(double walkSpeed)
```
Parameters:

walkSpeed - the walkSpeed to set

getWalkUphill
```
public double getWalkUphill()
```
Returns:

the walkUphill

setWalkUphill
```
public void setWalkUphill(double walkUphill)
```
Parameters:

walkUphill - the walkUphill to set

getWalkDownhill
```
public double getWalkDownhill()
```
Returns:

the walkDownhill

setWalkDownhill
```
public void setWalkDownhill(double walkDownhill)
```
Parameters:

walkDownhill - the walkDownhill to set

getTravelTimes
```
public List<Integer> getTravelTimes()
```
Returns:

the travelTimes

setTravelTimes
```
public void setTravelTimes(List<Integer> travelTimes)
```
Parameters:

travelTimes - the travelTimes to set

getTravelType
```
public TravelType getTravelType()
```
Returns:

the travelType

setTravelType
```
public void setTravelType(TravelType travelType)
```
Parameters:

travelType - the travelType to set

isElevationEnabled
```
public Boolean isElevationEnabled()
```
Returns:

the elevationEnabled

setElevationEnabled
```
public void setElevationEnabled(Boolean elevationEnabled)
```
Parameters:

elevationEnabled - the elevationEnabled to set

getMinPolygonHoleSize
```
public long getMinPolygonHoleSize()
```
Returns:

the minPolygonHoleSize

setMinPolygonHoleSize
```
public void setMinPolygonHoleSize(long minPolygonHoleSize)
```
Parameters:

minPolygonHoleSize - the minPolygonHoleSize to set

getTime
```
public int getTime()
```
Returns:

the time

setTime
```
public void setTime(Integer time)
```
Parameters:

time - the time to set

getDate
```
public int getDate()
```
Returns:

the date

setDate
```
public void setDate(Integer date)
```
Parameters:

date - the date to set

getFrame
```
public int getFrame()
```
Returns:

the frame

setFrame
```
public void setFrame(int frame)
```
Parameters:

frame - the frame to set

getRecommendations
```
public int getRecommendations()
```
Returns:

the recommendations

setRecommendations
```
public void setRecommendations(int recommendations)
```
Parameters:

recommendations - the recommendations to set

getIntersectionMode

public PolygonIntersectionMode getIntersectionMode()

Returns:: the intersectionMode

setIntersectionMode
```
public void setIntersectionMode(PolygonIntersectionMode intersectionMode)
```
Parameters:

intersectionMode - the intersectionMode to set. Default: UNION

getPathSerializer

public PathSerializerType getPathSerializer()

Returns:: the pathSerializer

setPathSerializer
```
public void setPathSerializer(PathSerializerType pathSerializer)
```
Parameters:

pathSerializer - the pathSerializer to set. Default: COMPACT

getPolygonSerializerType

public PolygonSerializerType getPolygonSerializerType()

Returns:: the polygonSerializerType

setPolygonSerializerType
```
public void setPolygonSerializerType(PolygonSerializerType polygonSerializerType)
```
Parameters:

polygonSerializerType - the polygonSerializerType to set. Default: JSON

isPointReduction
```
public boolean isPointReduction()
```
Returns:

the pointReduction

setPointReduction
```
public void setPointReduction(boolean pointReduction)
```
Parameters:

pointReduction - the pointReduction to set. Default: true

getMaxRoutingTime
```
@Deprecated
public int getMaxRoutingTime()
```
Deprecated.

Returns:

the maxRoutingTime

setMaxRoutingTime
```
@Deprecated
public void setMaxRoutingTime(int maxRoutingTime)
```
Deprecated.

Parameters:

maxRoutingTime - the maxRoutingTime to set

getMaxRoutingLength
```
@Deprecated
public Integer getMaxRoutingLength()
```
Deprecated.

Returns:

the maxRoutingLength

setMaxRoutingLength
```
@Deprecated
public void setMaxRoutingLength(Integer maxRoutingLength)
```
Deprecated.

Parameters:

maxRoutingLength - the maxRoutingLength to set

getServiceUrl
```
public String getServiceUrl()
```
Returns:

the serviceUrl

setServiceUrl
```
public void setServiceUrl(String serviceUrl)
```
Parameters:

serviceUrl - the serviceUrl to set

getServiceKey
```
public String getServiceKey()
```
Returns:

the serviceKey

setServiceKey
```
public void setServiceKey(String serviceKey)
```
Parameters:

serviceKey - the serviceKey to set

addSource

public void addSource(Coordinate source)

Parameters:: source - Source coordinate

addTarget

public void addTarget(Coordinate target)

Parameters:: target - Target coordinate

equals
```
public boolean equals(Object o)
```
Overrides:

equals in class Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

toString
```
public String toString()
```
Overrides:

toString in class Object

getSource
```
public Coordinate getSource(String id)
```
Parameters:

id - ID of source Coordinate

Returns:

Source coordinate

getTarget
```
public Coordinate getTarget(String id)
```
Parameters:

id - ID of source Coordinate

Returns:

Target coordinate

getStatisticIds
```
public List<Short> getStatisticIds()
```

setStatisticIds

public void setStatisticIds(List<Short> statisticIds)

setOnlyPrintReachablePoints
```
public void setOnlyPrintReachablePoints(boolean onlyPrintReachablePoints)
```
Determines whether to return only reachable points or all

Parameters:

onlyPrintReachablePoints - default: true

getOnlyPrintReachablePoints

public boolean getOnlyPrintReachablePoints()

getBuffer
```
public Double getBuffer()
```
Get the buffer value of polygons. Unit can be meters or degrees depending on the output CRS

Returns:

Buffer value in meters or in degrees

setBuffer
```
public void setBuffer(Double buffer)
```
Set how much the polygons will be buffered. Unit can be meters or degrees depending on the output CRS

Parameters:

buffer - Buffer value in meters or in degrees

getReverse
```
public Boolean getReverse()
```

setReverse

public void setReverse(Boolean reverse)

Parameters:: reverse - default: false

getSrid
```
public Integer getSrid()
```

setSrid
```
public void setSrid(Integer srid)
```

getEdgeWeightType

public EdgeWeightType getEdgeWeightType()

setEdgeWeightType

public void setEdgeWeightType(EdgeWeightType edgeWeightType)

getAppendTravelTimes
```
public Boolean getAppendTravelTimes()
```
Returns:

Append travel times setting

setAppendTravelTimes

public void setAppendTravelTimes(Boolean appendTravelTimes)

getStatisticServiceUrl

public String getStatisticServiceUrl()

setStatisticServiceUrl

public void setStatisticServiceUrl(String statisticServiceUrl)

getStatisticGroupId
```
public Integer getStatisticGroupId()
```

setStatisticGroupId

public void setStatisticGroupId(Integer statisticGroupId)

getMaxEdgeWeight
```
public Integer getMaxEdgeWeight()
```

setMaxEdgeWeight

public void setMaxEdgeWeight(Integer maxEdgeWeight)

addAllSources

public void addAllSources(Map<String,Coordinate> inactiveSources)

clearAndAddSource

public void clearAndAddSource(String id,
                              Coordinate source)

Clear sources and add new one

Parameters:: id - ID for the new source; source - New source coordinate

getFallbackServiceUrl
```
public String getFallbackServiceUrl()
```

setFallbackServiceUrl

public void setFallbackServiceUrl(String fallbackServiceUrl)

main

public static void main(String[] args)
                 throws com.fasterxml.jackson.core.JsonProcessingException,
                        Route360ClientException

Throws:: com.fasterxml.jackson.core.JsonProcessingException; Route360ClientException

getPointOfInterestServiceUrl

public String getPointOfInterestServiceUrl()

getOverpassServiceUrl
```
public String getOverpassServiceUrl()
```

setOverpassServiceUrl

public void setOverpassServiceUrl(String overpassServiceUrl)

getOverpassQuery
```
public String getOverpassQuery()
```

setOverpassQuery

public void setOverpassQuery(String overpassQuery)

getInterServiceKey
```
public String getInterServiceKey()
```

setInterServiceKey

public void setInterServiceKey(String interServiceKey)

Class TravelOptions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TravelOptions

Method Detail

getFormat

setFormat

getBoundingBox

setBoundingBox

getCustomPois

setCustomPois

getTravelTypes

setTravelTypes

getOsmTypes

setOsmTypes

getId

setId

getSourceCoordinates

getTargetCoordinates

getSources

setSources

getTargets

setTargets

addAllTargets

addAllTargets

getBikeSpeed

setBikeSpeed

getBikeUphill

setBikeUphill

getBikeDownhill

setBikeDownhill

getWalkSpeed

setWalkSpeed

getWalkUphill

setWalkUphill

getWalkDownhill

setWalkDownhill

getTravelTimes

setTravelTimes

getTravelType

setTravelType

isElevationEnabled

setElevationEnabled

getMinPolygonHoleSize

setMinPolygonHoleSize

getTime

setTime

getDate

setDate

getFrame

setFrame

getRecommendations

setRecommendations

getIntersectionMode

setIntersectionMode

getPathSerializer

setPathSerializer

getPolygonSerializerType

setPolygonSerializerType

isPointReduction

setPointReduction

getMaxRoutingTime

setMaxRoutingTime

getMaxRoutingLength

setMaxRoutingLength

getServiceUrl

setServiceUrl

getServiceKey

setServiceKey

addSource

addTarget

equals

hashCode

toString

getSource

getTarget

getStatisticIds

setStatisticIds