org.opentripplanner.routing.impl

Class DefaultFareServiceImpl

java.lang.Object

org.opentripplanner.routing.impl.DefaultFareServiceImpl

All Implemented Interfaces:

Serializable, FareService

Direct Known Subclasses:

DutchFareServiceImpl, SeattleFareServiceImpl, SFBayFareServiceImpl

public class DefaultFareServiceImpl
extends Object
implements FareService, Serializable

This fare service module handles the cases that GTFS handles within a single feed. It cannot necessarily handle multi-feed graphs, because a rule-less fare attribute might be applied to rides on routes in another feed, for example. For more interesting fare structures like New York's MTA, or cities with multiple feeds and inter-feed transfer rules, you get to implement your own FareService. See this thread on gtfs-changes explaining the proper interpretation of fares.txt: http://groups.google.com/group/gtfs-changes/browse_thread/thread/8a4a48ae1e742517/4f81b826cb732f3b

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<Fare.FareType,Collection<FareRuleSet>>	fareRulesPerType For each fare type (regular, student, etc...) the collection of rules that apply.

Constructor Summary

Constructors

Constructor and Description
DefaultFareServiceImpl()

Method Summary

Modifier and Type	Method and Description
void	addFareRules(Fare.FareType fareType, Collection<FareRuleSet> fareRules)
protected float	addFares(List<org.opentripplanner.routing.impl.Ride> ride0, List<org.opentripplanner.routing.impl.Ride> ride1, float cost0, float cost1)
protected float	calculateCost(Fare.FareType fareType, List<org.opentripplanner.routing.impl.Ride> rides, Collection<FareRuleSet> fareRules)
protected List<org.opentripplanner.routing.impl.Ride>	createRides(GraphPath path)
Fare	getCost(GraphPath path)
protected float	getLowestCost(Fare.FareType fareType, List<org.opentripplanner.routing.impl.Ride> rides, Collection<FareRuleSet> fareRules)
protected static Money	getMoney(Currency currency, float cost)
protected boolean	populateFare(Fare fare, Currency currency, Fare.FareType fareType, List<org.opentripplanner.routing.impl.Ride> rides, Collection<FareRuleSet> fareRules) Builds the Fare object for the given currency, fareType and fareRules.

Methods inherited from class java.lang.Object

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

Field Detail

fareRulesPerType

protected Map<Fare.FareType,Collection<FareRuleSet>> fareRulesPerType

For each fare type (regular, student, etc...) the collection of rules that apply.

Constructor Detail

DefaultFareServiceImpl

public DefaultFareServiceImpl()

Method Detail

addFareRules

public void addFareRules(Fare.FareType fareType,
                         Collection<FareRuleSet> fareRules)

createRides

protected List<org.opentripplanner.routing.impl.Ride> createRides(GraphPath path)

getCost

public Fare getCost(GraphPath path)

Specified by:

getCost in interface FareService

getMoney

protected static Money getMoney(Currency currency,
                                float cost)

addFares

protected float addFares(List<org.opentripplanner.routing.impl.Ride> ride0,
                         List<org.opentripplanner.routing.impl.Ride> ride1,
                         float cost0,
                         float cost1)

getLowestCost

protected float getLowestCost(Fare.FareType fareType,
                              List<org.opentripplanner.routing.impl.Ride> rides,
                              Collection<FareRuleSet> fareRules)

populateFare

protected boolean populateFare(Fare fare,
                               Currency currency,
                               Fare.FareType fareType,
                               List<org.opentripplanner.routing.impl.Ride> rides,
                               Collection<FareRuleSet> fareRules)

Builds the Fare object for the given currency, fareType and fareRules.

Besides calculating the lowest fare, we also break down the fare and which routes correspond to which components. Note that even if we cannot get a lowest fare (if some rides don't have fare rules), there will still be a breakdown for those parts which have fares.

As an example, given the rides A-B and B-C. Where A-B and B-C have fares of 10 each, 2 fare detail objects are added, one with fare 10 for A-B and one with fare 10 for B-C.

If we add the rule for A-C with a fare of 15, we will get 1 fare detail object with fare 15, which lists both A-B and B-C as routes involved.

If our only rule were A-B with a fare of 10, we would have no lowest fare, but we will still have one fare detail with fare 10 for the route A-B. B-C will not just not be listed at all.

calculateCost

protected float calculateCost(Fare.FareType fareType,
                              List<org.opentripplanner.routing.impl.Ride> rides,
                              Collection<FareRuleSet> fareRules)