org.opentripplanner.scripting.api

Class OtpsEntryPoint

java.lang.Object

org.opentripplanner.scripting.api.OtpsEntryPoint

public class OtpsEntryPoint
extends Object

This is the main entry point (facade) for use by scripts. An instance of this facade is accessible through the bean named "otp" in the various scripts, or by creating one if using OTP as a library from an external script. This facade allow a script to access / create OTP objects (routers, populations, ...)

Author:

laurent

See Also:

OtpsRouter, OtpsPopulation

Constructor Summary

Constructors

Constructor and Description
OtpsEntryPoint(OTPServer otpServer)

Method Summary

Modifier and Type	Method and Description
OtpsCsvOutput	createCSVOutput()
OtpsPopulation	createEmptyPopulation()
OtpsPopulation	createGridPopulation(double top, double bottom, double left, double right, int rows, int cols) Create a grid of evently spaced points in a rectangle.
OtpsRoutingRequest	createRequest()
static OtpsEntryPoint	fromArgs()
static OtpsEntryPoint	fromArgs(String[] args) Create an OTP scripting entry point using the same command-line parameters as used by the OTP application.
Object	getRetval()
OtpsRouter	getRouter()
OtpsRouter	getRouter(String routerId)
OtpsPopulation	loadCSVPopulation(String filename, String latColName, String lonColName) Load a population from a CSV file.
OtpsPopulation	loadRasterPopulation(String filename) Load a population from a raster (GeoTIFF) file.
void	setRetval(Object retval)

Methods inherited from class java.lang.Object

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

Constructor Detail

OtpsEntryPoint

public OtpsEntryPoint(OTPServer otpServer)

Method Detail

fromArgs

public static OtpsEntryPoint fromArgs(String[] args)
                               throws Exception

Create an OTP scripting entry point using the same command-line parameters as used by the OTP application. This is useful when using scripting from an outside environment, using OTP as a library. For example in jython the following script 'myscript.py':

   #!/usr/bin/jython
   from org.opentripplanner.scripting.api import OtpsEntryPoint
   otp = OtpsEntryPoint.fromArgs([ "-g", "." ])
   ...
 

One can then run jython with:

   CLASSPATH=otp.jar jython myscript.py
 

Parameters:

args - Command-line arguments, as used by the application.

Returns:

The "otp" scripting facade bean.

Throws:

Exception

fromArgs

public static OtpsEntryPoint fromArgs()
                               throws Exception

Throws:

Exception

getRouter

public OtpsRouter getRouter()

Returns:

The default router. If there is one router, this will be the default.

getRouter

public OtpsRouter getRouter(String routerId)

Parameters:

routerId - The ID of the router to request.

Returns:

The router of the given ID.

createRequest

public OtpsRoutingRequest createRequest()

Returns:

A new plan request that can be used to plan route / shortest path tree on a router.

createEmptyPopulation

public OtpsPopulation createEmptyPopulation()

Returns:

A new empty population.

createGridPopulation

public OtpsPopulation createGridPopulation(double top,
                                           double bottom,
                                           double left,
                                           double right,
                                           int rows,
                                           int cols)

Create a grid of evently spaced points in a rectangle. Coordinates are expressed in the given CRS, by default WGS84 geographical.

Parameters:

top -

bottom -

left -

right -

rows -

cols -

Returns:

A new grid population of rows x cols individuals, regularly spaced.

loadCSVPopulation

public OtpsPopulation loadCSVPopulation(String filename,
                                        String latColName,
                                        String lonColName)
                                 throws IOException

Load a population from a CSV file.

Parameters:

filename - The filename to load data from.

latColName - The name of the latitude column header.

lonColName - The name of the longitude column header.

Returns:

A population containing an individual per CSV row.

Throws:

IOException - If something bad happens (file not found, invalid format...)

loadRasterPopulation

public OtpsPopulation loadRasterPopulation(String filename)

Load a population from a raster (GeoTIFF) file.

Parameters:

filename - The filename to load data from.

Returns:

A population containing an individual per cell.

createCSVOutput

public OtpsCsvOutput createCSVOutput()

Returns:

A new CSV output.

setRetval

public void setRetval(Object retval)

Parameters:

retval - Set the return value of the script, which will be returned in web mode. For command-line mode, the return value is not used (for now).

getRetval

public Object getRetval()