Package com.targomo.client.api.request

Class PointOfInterestRequest

java.lang.Object

com.targomo.client.api.request.PointOfInterestRequest

public class PointOfInterestRequest
extends Object

Find reachable openstreetmap pois with this class. Only accepts HttpMethod POST.

Constructor Summary

Constructors

Constructor	Description
PointOfInterestRequest(TravelOptions travelOptions)	Use default client implementation with specified options and method Default client uses ClientBuilder.
PointOfInterestRequest(javax.ws.rs.client.Client client, TravelOptions travelOptions)	Use a custom client implementation with specified options and method
PointOfInterestRequest(javax.ws.rs.client.Client client, TravelOptions travelOptions, javax.ws.rs.core.MultivaluedMap<String,Object> headers)	Use a custom client implementation with specified options and method

Method Summary

Modifier and Type	Method	Description
PointOfInterestResponse	get()	Execute poi reachability request
PointOfInterestGravitationResponse	getGravitationAnalysis()	Execute gravitation poi request
PointOfInterestResponse	getPOIsWithinGeometry()	Execute poi inside geometry request
PointOfInterestSummaryResponse	getPOIsWithinGeometrySummary()	Execute poi inside geometry summary request
PointOfInterestSummaryResponse	getSummary()	Execute poi reachability summary request

Methods inherited from class java.lang.Object

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

Constructor Details

PointOfInterestRequest

public PointOfInterestRequest(TravelOptions travelOptions)

Use default client implementation with specified options and method Default client uses ClientBuilder.

Parameters:

travelOptions - Options to be used

PointOfInterestRequest

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

Use a custom client implementation with specified options and method

Parameters:

client - Client implementation to be used

travelOptions - Options to be used

PointOfInterestRequest

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

Use a custom client implementation with specified options and method

Parameters:

client - Client implementation to be used

travelOptions - Options to be used

headers - List of custom http headers to be used

Method Details

get

public PointOfInterestResponse get()
                            throws TargomoClientException

Execute poi reachability request

Returns:

point of interest response

Throws:

TargomoClientException - In case of error other than Gateway Timeout

getSummary

public PointOfInterestSummaryResponse getSummary()
                                          throws TargomoClientException

Execute poi reachability summary request

Returns:

point of interest summary response

Throws:

TargomoClientException - In case of error other than Gateway Timeout

getPOIsWithinGeometry

public PointOfInterestResponse getPOIsWithinGeometry()
                                              throws TargomoClientException

Execute poi inside geometry request

Returns:

point of interest response

Throws:

TargomoClientException - In case of error other than Gateway Timeout

getPOIsWithinGeometrySummary

public PointOfInterestSummaryResponse getPOIsWithinGeometrySummary()
                                                            throws TargomoClientException

Execute poi inside geometry summary request

Returns:

point of interest summary response

Throws:

TargomoClientException - In case of error other than Gateway Timeout

getGravitationAnalysis

public PointOfInterestGravitationResponse getGravitationAnalysis()
                                                          throws TargomoClientException

Execute gravitation poi request

Returns:

point of interest gravitation response

Throws:

TargomoClientException - In case of error other than Gateway Timeout