com.conveyal.gtfs.model

Class Entity.Writer<E extends Entity>

java.lang.Object

com.conveyal.gtfs.model.Entity.Writer<E>

Direct Known Subclasses:

Agency.Writer, Calendar.Writer, CalendarDate.Writer, FareAttribute.Writer, FareRule.Writer, FeedInfo.Writer, Frequency.Writer, Route.Writer, ShapePoint.Writer, Stop.Writer, StopTime.Writer, Transfer.Writer, Trip.Writer

Enclosing class:

Entity

public abstract static class Entity.Writer<E extends Entity>
extends Object

Write this entity to a CSV file. This should be subclassed in subclasses of Entity. The following (abstract) methods should be overridden in a subclass: writeHeaders(): write the headers to the CsvWriter writer. writeRow(E): write the passed-in object to the CsvWriter writer, potentially using the write*Field methods. iterator(): return an iterator over objects of this class (note that the feed is available at this.feed public Writer (GTFSFeed feed): this should super to Writer(GTFSFeed feed, String tableName), with the table name defined.

Author:

mattwigway

Field Summary

Fields

Modifier and Type	Field and Description
protected GTFSFeed	feed
protected long	row one-based to match reader.
protected String	tableName
protected com.csvreader.CsvWriter	writer

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Writer(GTFSFeed feed, String tableName)

Method Summary

Modifier and Type	Method and Description
static String	convertToGtfsTime(int secsSinceMidnight)
void	endRecord() End a row.
protected abstract Iterator<E>	iterator() Get an iterator over objects of this type.
protected void	writeDateField(LocalDate d) Writes date as YYYYMMDD
protected void	writeDoubleField(double val) Write a double value, with precision 10^-7.
protected abstract void	writeHeaders() Write the CSV header.
protected void	writeIntField(Integer val)
protected abstract void	writeOneRow(E obj) Write one row of the CSV from the passed-in object.
protected void	writeStringField(String str)
void	writeTable(ZipOutputStream zip)
protected void	writeTimeField(int secsSinceMidnight) Take a time expressed in seconds since noon - 12h (midnight, usually) and write it in HH:MM:SS format.
protected void	writeUrlField(URL obj)

Methods inherited from class java.lang.Object

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

Field Detail

feed

protected final GTFSFeed feed

tableName

protected final String tableName

writer

protected com.csvreader.CsvWriter writer

row

protected long row

one-based to match reader.

Constructor Detail

Writer

protected Writer(GTFSFeed feed,
                 String tableName)

Method Detail

writeHeaders

protected abstract void writeHeaders()
                              throws IOException

Write the CSV header.

Throws:

IOException

writeOneRow

protected abstract void writeOneRow(E obj)
                             throws IOException

Write one row of the CSV from the passed-in object.

Throws:

IOException

iterator

protected abstract Iterator<E> iterator()

Get an iterator over objects of this type.

writeTable

public void writeTable(ZipOutputStream zip)
                throws IOException

Throws:

IOException

writeStringField

protected void writeStringField(String str)
                         throws IOException

Throws:

IOException

writeUrlField

protected void writeUrlField(URL obj)
                      throws IOException

Throws:

IOException

writeDateField

protected void writeDateField(LocalDate d)
                       throws IOException

Writes date as YYYYMMDD

Throws:

IOException

writeTimeField

protected void writeTimeField(int secsSinceMidnight)
                       throws IOException

Take a time expressed in seconds since noon - 12h (midnight, usually) and write it in HH:MM:SS format.

Throws:

IOException

convertToGtfsTime

public static String convertToGtfsTime(int secsSinceMidnight)

writeIntField

protected void writeIntField(Integer val)
                      throws IOException

Throws:

IOException

writeDoubleField

protected void writeDoubleField(double val)
                         throws IOException

Write a double value, with precision 10^-7. NaN is written as "".

Throws:

IOException

endRecord

public void endRecord()
               throws IOException

End a row. This is just a proxy to the writer, but could be used for hooks in the future.

Throws:

IOException