org.opentripplanner.model.Stop Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of otp Show documentation
The OpenTripPlanner multimodal journey planning system
There is a newer version: 2.5.0
/* This file is based on code copied from project OneBusAway, see the LICENSE file for further information. */
package org.opentripplanner.model;

import javax.validation.constraints.NotNull;
import java.util.Collection;
import java.util.Collections;
import java.util.HashSet;
import java.util.TimeZone;

/**
 * A place where actual boarding/departing happens. It can be a bus stop on one side of a road or a
 * platform at a train station. Equivalent to GTFS stop location 0 or NeTEx quay.
 */
public final class Stop extends StationElement implements StopLocation {

  private static final long serialVersionUID = 2L;

  private final Collection fareZones;

  /**
   * Platform identifier for a platform/stop belonging to a station. This should be just the
   * platform identifier (eg. "G" or "3").
   */
  private final String platformCode;

  /**
   * URL to a web page containing information about this particular stop.
   */
  private final String url;

  private final TimeZone timeZone;

  /**
   * Used for describing the type of transportation used at the stop. This can be used eg. for
   * deciding how to render a stop when it is used by multiple routes with different vehicle types.
   */
  private final TransitMode vehicleType;

  private HashSet boardingAreas;

  public Stop(
      FeedScopedId id,
      String name,
      String code,
      String description,
      WgsCoordinate coordinate,
      WheelChairBoarding wheelchairBoarding,
      StopLevel level,
      String platformCode,
      Collection fareZones,
      String url,
      TimeZone timeZone,
      TransitMode vehicleType
  ) {
    super(id, name, code, description, coordinate, wheelchairBoarding, level);
    this.platformCode = platformCode;
    this.fareZones = fareZones;
    this.url = url;
    this.timeZone = timeZone;
    this.vehicleType = vehicleType;
  }

  /**
   * Create a minimal Stop object for unit-test use, where the test only care about id, name and
   * coordinate. The feedId is static set to "TEST"
   */
  public static Stop stopForTest(String idAndName, double lat, double lon) {
    return new Stop(
        new FeedScopedId("TEST", idAndName),
        idAndName,
        idAndName,
        null,
        new WgsCoordinate(lat, lon),
        null,
        null,
        null,
        null,
        null,
        null,
        null
    );
  }


  public void addBoardingArea(BoardingArea boardingArea) {
    if (boardingAreas == null) {
      boardingAreas = new HashSet<>();
    }
    boardingAreas.add(boardingArea);
  }

  @Override
  public String toString() {
    return "";
  }

  public String getPlatformCode() {
    return platformCode;
  }

  /**
   * This is to ensure backwards compatibility with the REST API, which expects the GTFS zone_id
   * which only permits one zone per stop.
   */
  public String getFirstZoneAsString() {
    return fareZones.stream().map(t -> t.getId().getId()).findFirst().orElse(null);
  }

  public String getUrl() {
    return url;
  }

  public TimeZone getTimeZone() {
    return timeZone;
  }

  public TransitMode getVehicleType() {
    return vehicleType;
  }

  public Collection getBoardingAreas() {
    return boardingAreas != null ? boardingAreas : Collections.emptySet();
  }

  /**
   * Get the transfer cost priority for Stop. This will fetch the value from the parent
   * [if parent exist] or return the default value.
   */
  @NotNull
  public TransferPriority getCostPriority() {
    return isPartOfStation() ? getParentStation().getCostPriority() : TransferPriority.ALLOWED;
  }

  public Collection getFareZones() {
    return Collections.unmodifiableCollection(fareZones);
  }
}