Package com.targomo.client.api.request

Class PolygonRequest

java.lang.Object

com.targomo.client.api.request.PolygonRequest

public class PolygonRequest
extends Object

Creates polygons for the source points with specified travel times in minutes. In case of GeoJson output, Polygons will be buffered, simplified and transformed according to the respective values in TravelOptions. Buffer should be given in meters or in degrees, depending on the output CRS's unit.

Constructor Summary

Constructors

Constructor	Description
PolygonRequest()	Use default Client.
PolygonRequest(TravelOptions travelOptions)	Use default Client with specified travelOptions
PolygonRequest(TravelOptions travelOptions, String method)	Use default Client with specified travelOptions and HTTP method
PolygonRequest(javax.ws.rs.client.Client client)	Use a custom client implementation
PolygonRequest(javax.ws.rs.client.Client client, TravelOptions travelOptions)	Use custom client with specified travelOptions
PolygonRequest(javax.ws.rs.client.Client client, TravelOptions travelOptions, String method)	Use custom client with specified travelOptions and the specified HTTP VERB
PolygonRequest(javax.ws.rs.client.Client client, TravelOptions travelOptions, String method, javax.ws.rs.core.MultivaluedMap<String,Object> headers)	Use custom client with specified travelOptions and the specified HTTP VERB

Method Summary

Modifier and Type	Method	Description
PolygonResponse	get()	Execute request
void	setMethod(String method)	Specify HTTP method to be used
void	setTravelOptions(TravelOptions options)

Methods inherited from class java.lang.Object

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

Constructor Details

PolygonRequest

public PolygonRequest(javax.ws.rs.client.Client client)

Use a custom client implementation

Parameters:

client - Client to be used

PolygonRequest

public PolygonRequest()

Use default Client. See SslClientGenerator

PolygonRequest

public PolygonRequest(TravelOptions travelOptions)

Use default Client with specified travelOptions

Parameters:

travelOptions - Travel options parameters

PolygonRequest

public PolygonRequest(TravelOptions travelOptions,
 String method)

Use default Client with specified travelOptions and HTTP method

Parameters:

travelOptions - Travel options parameters

method - HTTP Method (GET or POST)

PolygonRequest

public PolygonRequest(javax.ws.rs.client.Client client,
 TravelOptions travelOptions)

Use custom client with specified travelOptions

Parameters:

client - Client to be used

travelOptions - Travel options parameters

PolygonRequest

public PolygonRequest(javax.ws.rs.client.Client client,
 TravelOptions travelOptions,
 String method)

Use custom client with specified travelOptions and the specified HTTP VERB

Parameters:

client - Client to be used

travelOptions - Travel options parameters

method - the HTTP VERB

PolygonRequest

public PolygonRequest(javax.ws.rs.client.Client client,
 TravelOptions travelOptions,
 String method,
 javax.ws.rs.core.MultivaluedMap<String,Object> headers)

Use custom client with specified travelOptions and the specified HTTP VERB

Parameters:

client - Client to be used

travelOptions - Travel options parameters

method - the HTTP VERB

headers - List of custom http headers to be used

Method Details

setTravelOptions

public void setTravelOptions(TravelOptions options)

Parameters:

options - Travel options parameters

get

public PolygonResponse get()
                    throws TargomoClientException,
ResponseErrorException

Execute request

Returns:

Polygon response

Throws:

TargomoClientException - In case of error other than Gateway Timeout

ResponseErrorException

setMethod

public void setMethod(String method)

Specify HTTP method to be used

Parameters:

method - HTTP method (GET or POST)