org.opentripplanner.scripting.api

Class OtpsCsvOutput

java.lang.Object

org.opentripplanner.scripting.api.OtpsCsvOutput

public class OtpsCsvOutput
extends Object

This class allow one to generate easily tabular data and save it as a CSV file. For example, in python:

   csv = otp.createCSVOutput()
   csv.setHeader( [ 'lat', 'lon', 'total' ] )
   csv.addRow( [ 45.123, 5.789, 42 ] )
   csv.addRow( [ 45.124, 5.792, 34 ] )
   csv.save('mydata.csv')
 

TODO Rename this class to "TabularOutput" and allow for saving in various format.

Author:

laurent

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OtpsCsvOutput()

Method Summary

Modifier and Type	Method and Description
void	addRow(Object[] row) Add a new row to the data.
String	asText()
void	save(String file) Save the data to a file.
void	setHeader(Object[] headers) Set the (optional) column header names.

Methods inherited from class java.lang.Object

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

Constructor Detail

OtpsCsvOutput

protected OtpsCsvOutput()

Method Detail

setHeader

public void setHeader(Object[] headers)

Set the (optional) column header names. If this is not set, no header will be generated.

Parameters:

headers - An array of string, each entry is the name of the corresponding column header, in order.

addRow

public void addRow(Object[] row)

Add a new row to the data.

Parameters:

row - An array of objects. The order and size of the array should correspond to the header. The default toString method of each object will be called to get the actual data to output; so any type of object can be provided (string, numbers...)

save

public void save(String file)
          throws IOException

Save the data to a file.

Parameters:

file - The name of the file to save the data to.

Throws:

IOException - In case something bad happens (IO exception)

asText

public String asText()
              throws IOException

Returns:

The CSV data as a string. It can be used for example as the script return value.

Throws:

IOException

See Also:

OtpsEntryPoint.setRetval()