org.opentripplanner.service.realtimevehicles.RealtimeVehicleRepository Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of otp Show documentation

The OpenTripPlanner multimodal journey planning system

The newest version!

package org.opentripplanner.service.realtimevehicles;

import java.util.List;
import org.opentripplanner.service.realtimevehicles.model.RealtimeVehicle;
import org.opentripplanner.transit.model.network.TripPattern;

public interface RealtimeVehicleRepository {
  /**
   * For the given pattern set all realtime vehicles.
   * 
   * The list is expected to be exhaustive: all existing vehicles will be overridden.
   * 

   * This means that if there are two updaters providing vehicles for the same pattern they
   * overwrite each other.
   */
  void setRealtimeVehicles(TripPattern pattern, List updates);

  /**
   * Remove all vehicles for a given pattern.
   * 
   * This is useful to clear old vehicles for which there are no more updates and we assume that
   * they have stopped their trip.
   */
  void clearRealtimeVehicles(TripPattern pattern);
  /**
   * Get the vehicles for a certain trip.
   */
  List getRealtimeVehicles(TripPattern pattern);
}