TransitIndexService.java

/* This program is free software: you can redistribute it and/or
 modify it under the terms of the GNU Lesser General Public License
 as published by the Free Software Foundation, either version 3 of
 the License, or (at your option) any later version.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.

 You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>. */

package org.opentripplanner.routing.services;

import java.util.Collection;
import java.util.List;

import org.onebusaway.gtfs.model.Agency;
import org.onebusaway.gtfs.model.AgencyAndId;
import org.onebusaway.gtfs.model.ServiceCalendar;
import org.onebusaway.gtfs.model.ServiceCalendarDate;
import org.onebusaway.gtfs.model.Stop;
import org.opentripplanner.routing.core.TraverseMode;
import org.opentripplanner.routing.edgetype.PatternHop;
import org.opentripplanner.routing.edgetype.PreAlightEdge;
import org.opentripplanner.routing.edgetype.PreBoardEdge;
import org.opentripplanner.routing.transit_index.RouteVariant;

import com.vividsolutions.jts.geom.Coordinate;

public interface TransitIndexService {
    public List<RouteVariant> getVariantsForAgency(String agency);

    public List<RouteVariant> getVariantsForRoute(AgencyAndId route);

    public RouteVariant getVariantForTrip(AgencyAndId trip);

    public PreBoardEdge getPreBoardEdge(AgencyAndId stop);

    public PreAlightEdge getPreAlightEdge(AgencyAndId stop);

    /**
     * @return The list of PatternHop edges for a given trip.
     */
    public List<PatternHop> getPatternHopsForTrip(AgencyAndId tripId);

    public List<AgencyAndId> getRoutesForStop(AgencyAndId stop);

    public Collection<String> getDirectionsForRoute(AgencyAndId route);
    
    public Collection<Stop> getStopsForRoute(AgencyAndId route);

    public List<TraverseMode> getAllModes();

    public Collection<AgencyAndId> getAllRouteIds();

    public void addCalendars(Collection<ServiceCalendar> allCalendars);

    public void addCalendarDates(Collection<ServiceCalendarDate> allDates);

    public List<String> getAllAgencies();

    public List<ServiceCalendarDate> getCalendarDatesByAgency(String agency);

    public List<ServiceCalendar> getCalendarsByAgency(String agency);

    public Agency getAgency(String id);

    /**
     * Returns the transit center of the city -- the place where there is the highest
     * concentration of transit.  This isn't intended to be a rigorously computed result;
     * it's intended for display.
     * @return
     */
    public Coordinate getCenter();

    /**
     * Returns the overnight service break time in seconds past midnight. If none is found (that is,
     * there is a trip every minute of the day), returns -1. This may give weird results on tiny
     * systems with irregular hours of service, but we don't expect the relevant APIs to be used in
     * these cases.
     * 
     */
    int getOvernightBreak();
}