org.opentripplanner.routing.api.request.request.TransitRequest 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.routing.api.request.request;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import org.opentripplanner.model.modes.ExcludeAllTransitFilter;
import org.opentripplanner.routing.api.request.DebugRaptor;
import org.opentripplanner.routing.api.request.request.filter.AllowAllTransitFilter;
import org.opentripplanner.routing.api.request.request.filter.TransitFilter;
import org.opentripplanner.routing.api.request.request.filter.TransitGroupSelect;
import org.opentripplanner.transit.model.framework.FeedScopedId;

// TODO VIA: Javadoc
public class TransitRequest implements Cloneable, Serializable {

  private List bannedTrips = new ArrayList<>();

  private List filters = List.of(AllowAllTransitFilter.of());

  @Deprecated
  private List preferredAgencies = List.of();

  private List unpreferredAgencies = List.of();

  /**
   * @deprecated TODO OTP2 Needs to be implemented
   */
  @Deprecated
  private List preferredRoutes = List.of();

  private List unpreferredRoutes = List.of();

  private List priorityGroupsByAgency = new ArrayList<>();
  private List priorityGroupsGlobal = new ArrayList<>();
  private DebugRaptor raptorDebugging = new DebugRaptor();

  public void setBannedTripsFromString(String ids) {
    if (!ids.isEmpty()) {
      this.bannedTrips = FeedScopedId.parseList(ids);
    }
  }

  public void setBannedTrips(List bannedTrips) {
    this.bannedTrips = bannedTrips;
  }

  public List bannedTrips() {
    return bannedTrips;
  }

  public List filters() {
    return filters;
  }

  public void setFilters(List filters) {
    this.filters = filters;
  }

  /**
   * A unique group-id is assigned all patterns grouped by matching select and agency.
   * In other words, two patterns matching the same select and with the same agency-id
   * will get the same group-id.
   * 
   * Note! Entities that are not matched are put in the BASE-GROUP with id 0.
   */
  public List priorityGroupsByAgency() {
    return priorityGroupsByAgency;
  }

  /**
   * All patterns matching the same select will be assigned the same group-id.
   */
  public void addPriorityGroupsByAgency(Collection priorityGroupsByAgency) {
    this.priorityGroupsByAgency.addAll(priorityGroupsByAgency);
  }

  /**
   * A unique group-id is assigned all patterns grouped by matching selects.
   * 
   * Note! Entities that are not matched are put in the BASE-GROUP with id 0.
   */
  public List priorityGroupsGlobal() {
    return priorityGroupsGlobal;
  }

  public void addPriorityGroupsGlobal(Collection priorityGroupsGlobal) {
    this.priorityGroupsGlobal.addAll(priorityGroupsGlobal);
  }

  @Deprecated
  public void setPreferredAgenciesFromString(String s) {
    if (!s.isEmpty()) {
      preferredAgencies = FeedScopedId.parseList(s);
    }
  }

  @Deprecated
  public void setPreferredAgencies(List preferredAgencies) {
    this.preferredAgencies = preferredAgencies;
  }

  /**
   * List of preferred agencies by user.
   */
  @Deprecated
  public List preferredAgencies() {
    return preferredAgencies;
  }

  public void setUnpreferredAgenciesFromString(String s) {
    if (!s.isEmpty()) {
      unpreferredAgencies = FeedScopedId.parseList(s);
    }
  }

  /**
   * List of unpreferred agencies for given user.
   */
  public void setUnpreferredAgencies(List unpreferredAgencies) {
    this.unpreferredAgencies = unpreferredAgencies;
  }

  public List unpreferredAgencies() {
    return unpreferredAgencies;
  }

  @Deprecated
  public void setPreferredRoutesFromString(String s) {
    if (!s.isEmpty()) {
      preferredRoutes = List.copyOf(FeedScopedId.parseList(s));
    } else {
      preferredRoutes = List.of();
    }
  }

  @Deprecated
  public void setPreferredRoutes(List preferredRoutes) {
    this.preferredRoutes = preferredRoutes;
  }

  /**
   * Set of preferred routes by user and configuration.
   */
  @Deprecated
  public List preferredRoutes() {
    return preferredRoutes;
  }

  public void setUnpreferredRoutesFromString(String s) {
    if (!s.isEmpty()) {
      unpreferredRoutes = List.copyOf(FeedScopedId.parseList(s));
    } else {
      unpreferredRoutes = List.of();
    }
  }

  public void setUnpreferredRoutes(List unpreferredRoutes) {
    this.unpreferredRoutes = unpreferredRoutes;
  }

  /**
   * Set of unpreferred routes for given user and configuration.
   */
  public List unpreferredRoutes() {
    return unpreferredRoutes;
  }

  public void setRaptorDebugging(DebugRaptor raptorDebugging) {
    this.raptorDebugging = raptorDebugging;
  }

  public DebugRaptor raptorDebugging() {
    return raptorDebugging;
  }

  public TransitRequest clone() {
    try {
      var clone = (TransitRequest) super.clone();

      clone.preferredAgencies = List.copyOf(this.preferredAgencies);
      clone.unpreferredAgencies = List.copyOf(this.unpreferredAgencies);
      clone.preferredRoutes = List.copyOf(this.preferredRoutes);
      clone.unpreferredRoutes = List.copyOf(this.unpreferredRoutes);
      clone.raptorDebugging = new DebugRaptor(this.raptorDebugging);
      clone.priorityGroupsByAgency = new ArrayList<>(this.priorityGroupsByAgency);
      clone.priorityGroupsGlobal = new ArrayList<>(this.priorityGroupsGlobal);

      // filters are immutable
      clone.setFilters(this.filters);

      return clone;
    } catch (CloneNotSupportedException e) {
      /* this will never happen since our super is the cloneable object */
      throw new RuntimeException(e);
    }
  }

  /**
   * Returns whether it is requested to run the transit search for this request.
   */
  public boolean enabled() {
    return filters.stream().noneMatch(ExcludeAllTransitFilter.class::isInstance);
  }

  /**
   * Disables the transit search for this request, for example when you only want bike routes.
   */
  public void disable() {
    this.filters = List.of(ExcludeAllTransitFilter.of());
  }
}