com.pb.routing.gra

Interface IGRAInstance

All Known Implementing Classes:

DynamicGRAInstance, GRAInstanceImpl

public interface IGRAInstance

A IGRAInstance object is a resource intensive object that should be created only when required.
It is advisable to destroy this object calling the destroy method, once it is no longer in use.

Method Summary

Modifier and Type	Method and Description
PersistentUpdateResponse	createPersistentUpdates(PersistentUpdateRequest request) This method is used for applying persistent updates.
void	destroy() Releases all resources which are held by routing engine for processing routing requests.
GetRouteResponse	getRoute(GetRouteRequest request) Returns a GetRouteResponse object corresponding to a GetRouteRequest object.
GetRouteCostMatrixResponse	getRouteCostMatrix(GetRouteCostMatrixRequest request) Returns a GetRouteCostMatrixResponse object corresponding to a GetRouteCostMatrixRequest object.
GetSegmentDataResponse	getSegmentData(GetSegmentDataRequest request) Returns a GetSegmentDataResponse object corresponding to a GetSegmentDataRequest object.
GetTravelBoundaryResponse	getTravelBoundary(GetTravelBoundaryRequest request) Returns a GetTravelBoundaryResponse object corresponding to a GetTravelBoundaryRequest object.
PersistentResetResponse	resetPersitentUpdates(PersistentResetRequest request) This method is used for resetting persistent updates.

Method Detail

getTravelBoundary

GetTravelBoundaryResponse getTravelBoundary(GetTravelBoundaryRequest request)
                                     throws RoutingException

Returns a GetTravelBoundaryResponse object corresponding to a GetTravelBoundaryRequest object.

In GetTravelBoundaryRequest class you can specify various options for Travel Boundary.

Request can either be IsoChrone or IsoDistance. If request is intended to be IsoChrone, TimeUnit should be set to appropriate value and LinearUnit should be set null.

If Request is intended to be IsoDistance, LinearUnit should be set to appropriate value and TimeUnit should be null.

It is illegal to set both to non-null values.

Parameters:

request - GetTravelBoundaryRequest object for which travel boundary will be generated.

Returns:

GetTravelBoundaryResponse object which contains List of TravelBoundary for the request.

Throws:

RoutingException - If something goes wrong while processing the request.

getRoute

GetRouteResponse getRoute(GetRouteRequest request)
                   throws RoutingException

Returns a GetRouteResponse object corresponding to a GetRouteRequest object.

In GetRouteRequest class you can specify various options for route calculation.

GetRouteRequest takes a starting location and an ending location with optional intermediate points as input, and returns the route that is either the fastest or the shortest.

Specify distance unit (LinearUnit) and TimeUnit to get the route response in desired units.

Parameters:

request - GetRouteRequest object for which route will be generated.

Returns:

GetRouteResponse object which contains the following:

• The route generated.
• Time and Distance to travel through the route.
• Turn by turn directions for the route i.e. ArrayList of RouteInstruction.
• IGeometry of the route.

Throws:

RoutingException - If something goes wrong while processing the request.

getRouteCostMatrix

GetRouteCostMatrixResponse getRouteCostMatrix(GetRouteCostMatrixRequest request)
                                       throws RoutingException

Returns a GetRouteCostMatrixResponse object corresponding to a GetRouteCostMatrixRequest object.

In GetRouteCostMatrixRequest class you can specify various options for route calculation.

GetRouteCostMatrixRequest takes list of start locations and end locations as input, and returns the route cost matrix that is either the fastest or the shortest.

Specify distance unit (LinearUnit) and TimeUnit to get the route cost matrix response in desired units.

Parameters:

request - GetRouteCostMatrixRequest object for which route cost matrix will be generated.

Returns:

GetRouteCostMatrixResponse object which contains route cost matrix generated. It also contains the time and distance to travel through for each route.

Throws:

RoutingException - If something goes wrong while processing the request.

getSegmentData

GetSegmentDataResponse getSegmentData(GetSegmentDataRequest request)
                               throws RoutingException

Returns a GetSegmentDataResponse object corresponding to a GetSegmentDataRequest object.

In GetSegmentDataRequest class you can specify various options for fetching segment information.

GetSegmentDataRequest takes either point or segment id for which segment information is to be fetched from network.

Parameters:

request - GetRouteCostMatrixRequest object for which segment data will be fetched.

Returns:

GetRouteCostMatrixResponse object which contains segment information for the specified segment.

Throws:

RoutingException - If something goes wrong while processing the request.

createPersistentUpdates

PersistentUpdateResponse createPersistentUpdates(PersistentUpdateRequest request)
                                          throws RoutingException

This method is used for applying persistent updates.

In PersistentUpdateRequest class you can specify List of Update to be applied on the network.

Parameters:

request - PersistentUpdateRequest object containing List of Update to be applied on the network.

Returns:

PersistentUpdateResponse object which contains the success message for PersistentUpdateRequest.

Throws:

RoutingException - If something goes wrong while processing the request.

resetPersitentUpdates

PersistentResetResponse resetPersitentUpdates(PersistentResetRequest request)
                                       throws RoutingException

This method is used for resetting persistent updates. This method can be used to revert Update applied on the network. To revert all the updates applied reset all option can be used.

In PersistentResetRequest class you can specify List of Reset to be applied on the network.

Parameters:

request - PersistentResetRequest object containing List of Reset to be applied on the network or reset all option is set to true to revert all the Update applied on the network.

Returns:

PersistentResetResponse object which contains the success message for PersistentResetRequest.

Throws:

RoutingException - If something goes wrong while processing the request.

destroy

void destroy()

Releases all resources which are held by routing engine for processing routing requests. It is recommended to invoke this method once you no longer need the routing engine.