org.opentripplanner.model.FeedScopedId 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.io.Serializable;
import java.util.Arrays;
import java.util.Set;
import java.util.stream.Collectors;

import static org.opentripplanner.util.AssertUtils.assertHasValue;

public final class FeedScopedId implements Serializable, Comparable {

    /**
     * One Bus Away uses the underscore as a scope separator between Agency and ID. In OTP we use
     * feed IDs instead of agency IDs as scope, and they are separated with a colon when
     * represented together in String form.
     */
    private static final char ID_SEPARATOR = ':';

    private static final long serialVersionUID = 1L;

    private final String feedId;

    private final String id;

    public FeedScopedId(@NotNull String feedId, @NotNull String id) {
        assertHasValue(feedId);
        assertHasValue(id);

        this.feedId = feedId;
        this.id = id;
    }

    public String getFeedId() {
        return feedId;
    }

    public String getId() {
        return id;
    }

    public int compareTo(FeedScopedId o) {
        int c = this.feedId.compareTo(o.feedId);
        if (c == 0) {
            c = this.id.compareTo(o.id);
        }
        return c;
    }

    /**
     * DO NOT CHANGE THIS - It is used in Serialization of the id.
     */
    @Override
    public String toString() {
        return concatenateId(feedId, id);
    }

    @Override
    public int hashCode() {
        return feedId.hashCode() ^ id.hashCode();
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) { return true; }
        if (obj == null) { return false; }
        if (!(obj instanceof FeedScopedId)) { return false; }

        FeedScopedId other = (FeedScopedId) obj;
        return feedId.equals(other.feedId) && id.equals(other.id);
    }

    /**
     * Given an id of the form "feedId:entityId", parses into a
     * {@link FeedScopedId} id object.
     *
     * @param value id of the form "feedId:entityId"
     * @return an id object
     * @throws IllegalArgumentException if the id cannot be parsed
     */
    public static FeedScopedId parseId(String value) throws IllegalArgumentException {
        if (value == null || value.isEmpty()) {
            return null;
        }
        int index = value.indexOf(ID_SEPARATOR);
        if (index == -1) {
            throw new IllegalArgumentException("invalid feed-scoped-id: " + value);
        } else {
            return new FeedScopedId(value.substring(0, index), value.substring(index + 1));
        }
    }

    public static boolean isValidString(String value) throws IllegalArgumentException {
        return value != null && value.indexOf(ID_SEPARATOR) > -1;
    }

    /**
     * Concatenate feedId and id into a string.
     */
    public static String concatenateId(String feedId, String id) {
        return feedId + ID_SEPARATOR + id;
    }

    /**
     * Parses a string consisting of concatenated FeedScopedIds to a Set
     */
    public static Set parseListOfIds(String s) {
        return Arrays
            .stream(s.split(","))
            .map(FeedScopedId::parseId)
            .collect(Collectors.toSet());
    }
}