com.conveyal.gtfs.model

Class ScheduleException

java.lang.Object

com.conveyal.gtfs.model.Entity

com.conveyal.gtfs.model.ScheduleException

All Implemented Interfaces:

Serializable

public class ScheduleException
extends Entity

Represents an exception to the schedule, which could be "On January 18th, run a Sunday schedule" (useful for holidays), or could be "on June 23rd, run the following services" (useful for things like early subway shutdowns, re-routes, etc.) Unlike the GTFS schedule exception model, we assume that these special calendars are all-or-nothing; everything that isn't explicitly running is not running. That is, creating special service means the user starts with a blank slate.

Author:

mattwigway

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScheduleException.ExemplarServiceDescriptor Represents a desire about what service should be like on a particular day.

Nested classes/interfaces inherited from class com.conveyal.gtfs.model.Entity

Entity.Loader<E extends Entity>, Entity.Writer<E extends Entity>

Field Summary

Fields

Modifier and Type	Field and Description
List<String>	addedService
List<String>	customSchedule A custom schedule.
List<LocalDate>	dates The dates of this service exception
ScheduleException.ExemplarServiceDescriptor	exemplar If non-null, run service that would ordinarily run on this day of the week.
String	name The name of this exception, for instance "Presidents' Day" or "Early Subway Shutdowns"
List<String>	removedService

Fields inherited from class com.conveyal.gtfs.model.Entity

DOUBLE_MISSING, id, INT_MISSING

Constructor Summary

Constructors

Constructor and Description
ScheduleException()

Method Summary

Modifier and Type	Method and Description
static ScheduleException.ExemplarServiceDescriptor	exemplarFromInt(int value)
boolean	serviceRunsOn(Calendar calendar)
void	setStatementParameters(PreparedStatement statement, boolean setDefaultId) This method should be overridden by each Entity subtybe to handle setting parameters for a prepared statement created from the entity table constants defined in Table.

Methods inherited from class com.conveyal.gtfs.model.Entity

getId, getSequenceNumber, human, setDoubleParameter, setIntParameter

Methods inherited from class java.lang.Object

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

Field Detail

exemplar

public ScheduleException.ExemplarServiceDescriptor exemplar

If non-null, run service that would ordinarily run on this day of the week. Takes precedence over any custom schedule.

name

public String name

The name of this exception, for instance "Presidents' Day" or "Early Subway Shutdowns"

dates

public List<LocalDate> dates

The dates of this service exception

customSchedule

public List<String> customSchedule

A custom schedule. Only used if like == null

addedService

public List<String> addedService

removedService

public List<String> removedService

Constructor Detail

ScheduleException

public ScheduleException()

Method Detail

setStatementParameters

public void setStatementParameters(PreparedStatement statement,
                                   boolean setDefaultId)
                            throws SQLException

Description copied from class: Entity

This method should be overridden by each Entity subtybe to handle setting parameters for a prepared statement created from the entity table constants defined in Table.

Specified by:

setStatementParameters in class Entity

Throws:

SQLException

serviceRunsOn

public boolean serviceRunsOn(Calendar calendar)

exemplarFromInt

public static ScheduleException.ExemplarServiceDescriptor exemplarFromInt(int value)