org.opentripplanner.ext.geocoder.StopCluster Maven / Gradle / Ivy
package org.opentripplanner.ext.geocoder;
import java.util.Collection;
import java.util.List;
import java.util.Objects;
import javax.annotation.Nullable;
import org.opentripplanner.transit.model.framework.FeedScopedId;
/**
* A result of a fuzzy stop cluster geocoding search. A cluster is defined as a group of stops that
* are related to one another.
*
* Specifically this means that:
*
* - if a stop has a parent station only the parent is returned
* - if stops are closer than 10 meters to each and have an identical name, only one is returned
*/
record StopCluster(Location primary, Collection secondaries) {
/**
* Easily serializable version of a coordinate
*/
public record Coordinate(double lat, double lon) {}
/**
* Easily serializable version of an agency
*/
public record Agency(FeedScopedId id, String name) {}
/**
* Easily serializable version of a feed publisher
*/
public record FeedPublisher(String name) {}
public enum LocationType {
STATION,
STOP,
}
public record Location(
FeedScopedId id,
@Nullable String code,
LocationType type,
String name,
Coordinate coordinate,
Collection modes,
List agencies,
@Nullable FeedPublisher feedPublisher
) {
public Location {
Objects.requireNonNull(id);
Objects.requireNonNull(name);
Objects.requireNonNull(type);
Objects.requireNonNull(coordinate);
Objects.requireNonNull(modes);
Objects.requireNonNull(agencies);
}
}
}