com.pb.routing.gra

Class Options.Builder

java.lang.Object

com.pb.routing.gra.Options.Builder

Enclosing class:

Options

public static class Options.Builder
extends Object

Builder class to create Options object.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
Options.Builder	allowFallback(boolean allowFallback) Sets whether to use or not, the major roads when other roads cannot be used.
Options	build() Builds the object of Options class to be used for creation of IGRAInstance
Options.Builder	defaultCoordSys(CoordSys defaultCoordSys) Sets the default CoordSys to be used for processing the routing requests.
Options.Builder	isoTimeout(long isoTimeout) Sets the amount of processing time (in milliseconds) before stopping an ISO routing request if processing is not complete.
Options.Builder	longProcessThreads(int longProcessThreads) Sets the number of threads to be used for isochrone, matrix route and multipoint route requests.
Options.Builder	matrixRouteTimeout(long matrixRouteTimeout) Sets the amount of processing time (in milliseconds) before stopping a matrix routing request if processing is not complete.
Options.Builder	multiPointTimeout(long multiPointTimeout) Sets the amount of processing time (in milliseconds) before stopping a multipoint routing request if processing is not complete.
Options.Builder	routeTimeout(long routeTimeout) Sets the amount of processing time (in milliseconds) before stopping a point to point routing request if processing is not complete.
Options.Builder	shortProcessThreads(int shortProcessThreads) Sets the number of threads to be used for point to point route requests.
Options.Builder	updateFilePath(File updateFilePath) Sets the File object containing the path where are system updates are saved.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

build

public Options build()
              throws RoutingException

Builds the object of Options class to be used for creation of IGRAInstance

Returns:

- Options consisting of all the values defined in builder.

Throws:

RoutingException - - If some illegal value is defined for any field.

routeTimeout

public Options.Builder routeTimeout(long routeTimeout)

Sets the amount of processing time (in milliseconds) before stopping a point to point routing request if processing is not complete. It's value shouldn't be less then 0.

Parameters:

routeTimeout - Timeout value (in milliseconds) for a point to point routing request.

multiPointTimeout

public Options.Builder multiPointTimeout(long multiPointTimeout)

Sets the amount of processing time (in milliseconds) before stopping a multipoint routing request if processing is not complete. It's value shouldn't be less then 0.

Parameters:

multiPointTimeout - Timeout value (in milliseconds) for a multipoint routing request.

isoTimeout

public Options.Builder isoTimeout(long isoTimeout)

Sets the amount of processing time (in milliseconds) before stopping an ISO routing request if processing is not complete. It's value shouldn't be less then 0.

Parameters:

isoTimeout - Timeout value (in milliseconds) for an ISO routing request.

matrixRouteTimeout

public Options.Builder matrixRouteTimeout(long matrixRouteTimeout)

Sets the amount of processing time (in milliseconds) before stopping a matrix routing request if processing is not complete. It's value shouldn't be less then 0.

Parameters:

matrixRouteTimeout - Timeout value (in milliseconds) for a matrix routing request.

allowFallback

public Options.Builder allowFallback(boolean allowFallback)

Sets whether to use or not, the major roads when other roads cannot be used.

Parameters:

allowFallback - A boolean, true value means major roads will be used when other roads cannot be used, false otherwise.

shortProcessThreads

public Options.Builder shortProcessThreads(int shortProcessThreads)

Sets the number of threads to be used for point to point route requests.

Parameters:

shortProcessThreads - Number of threads to be used for point to point route requests. It's value shouldn't be less then 0.

longProcessThreads

public Options.Builder longProcessThreads(int longProcessThreads)

Sets the number of threads to be used for isochrone, matrix route and multipoint route requests.

Parameters:

longProcessThreads - Number of threads to be used for isochrone, matrix route and multipoint route requests. It's value shouldn't be less then 0.

defaultCoordSys

public Options.Builder defaultCoordSys(CoordSys defaultCoordSys)
                                throws RoutingException

Sets the default CoordSys to be used for processing the routing requests.

Parameters:

defaultCoordSys - - default CoordSys.

Throws:

RoutingException - - RoutingException if invalid value is specified.

updateFilePath

public Options.Builder updateFilePath(File updateFilePath)
                               throws RoutingException

Sets the File object containing the path where are system updates are saved.

Parameters:

updateFilePath - - updates path.

Throws:

RoutingException - - RoutingException if invalid updateFilePath is specified.