org.opentripplanner.transit.model.site.GroupOfStations 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.transit.model.site;

import java.util.Collection;
import java.util.Objects;
import java.util.Set;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import org.opentripplanner.framework.geometry.WgsCoordinate;
import org.opentripplanner.framework.i18n.I18NString;
import org.opentripplanner.transit.model.framework.AbstractTransitEntity;
import org.opentripplanner.transit.model.framework.FeedScopedId;

/**
 * A grouping that can contain a mix of Stations and MultiModalStations. It can be used to link
 * several StopPlaces into a hub. It can be a grouping of major stops within a city or a cluster of
 * stops that naturally belong together.
 */
public class GroupOfStations
  extends AbstractTransitEntity
  implements StopLocationsGroup {

  private final Set childStations;
  private final I18NString name;
  private final GroupOfStationsPurpose purposeOfGrouping;
  private final WgsCoordinate coordinate;

  GroupOfStations(GroupOfStationsBuilder builder) {
    super(builder.getId());
    // Required fields
    this.name = I18NString.assertHasValue(builder.name());
    this.childStations = Objects.requireNonNull(builder.childStations());

    // Optional fields
    this.purposeOfGrouping = builder.purposeOfGrouping();
    // TODO: Coordinate should be
    this.coordinate = builder.coordinate();
  }

  public static GroupOfStationsBuilder of(FeedScopedId id) {
    return new GroupOfStationsBuilder(id);
  }

  @Nonnull
  public I18NString getName() {
    return name;
  }

  @Override
  @Nullable
  public WgsCoordinate getCoordinate() {
    return coordinate;
  }

  @Nonnull
  public Collection getChildStops() {
    return this.childStations.stream().flatMap(s -> s.getChildStops().stream()).toList();
  }

  @Nonnull
  public Collection getChildStations() {
    return this.childStations;
  }

  /**
   * Categorization for the grouping
   */
  @Nullable
  public GroupOfStationsPurpose getPurposeOfGrouping() {
    return purposeOfGrouping;
  }

  @Override
  public boolean sameAs(@Nonnull GroupOfStations other) {
    return (
      getId().equals(other.getId()) &&
      Objects.equals(name, other.getName()) &&
      Objects.equals(childStations, other.getChildStations()) &&
      Objects.equals(coordinate, other.getCoordinate()) &&
      Objects.equals(purposeOfGrouping, other.getPurposeOfGrouping())
    );
  }

  @Nonnull
  @Override
  public GroupOfStationsBuilder copy() {
    return new GroupOfStationsBuilder(this);
  }
}