juraclient/src/main/java/de/stklcode/pubtrans/ura/model/Stop.java

/*
 * Copyright 2016-2021 Stefan Kalscheuer
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package de.stklcode.pubtrans.ura.model;

import java.io.IOException;
import java.io.Serializable;
import java.util.List;

/**
 * Entity for a single stop.
 *
 * @author Stefan Kalscheuer
 */
public final class Stop implements Model {
    private static final long serialVersionUID = 202040044477267787L;

    private static final int F_STOP_NAME = 1;
    private static final int F_STOP_ID = 2;
    private static final int F_INDICATOR = 3;
    private static final int F_STATE = 4;
    private static final int F_LATITUDE = 5;
    private static final int F_LONGITUDE = 6;
    private static final int F_NUM_OF_FIELDS = 7;

    /**
     * Stop identifier.
     */
    private final String id;

    /**
     * The name of the bus stop.
     */
    private final String name;

    /**
     * The stop indicator.
     */
    private final String indicator;

    /**
     * The stop state
     */
    private final Integer state;

    /**
     * The stop geolocation latitude.
     */
    private final Double latitude;

    /**
     * The stop geolocation longitude.
     */
    private final Double longitude;

    /**
     * Construct Stop object.
     *
     * @param id        Stop ID.
     * @param name      Stop name.
     * @param indicator Stop indicator.
     * @param state     Stop state.
     * @param latitude  Stop geolocation latitude.
     * @param longitude Stop geolocation longitude.
     */
    public Stop(final String id,
                final String name,
                final String indicator,
                final Integer state,
                final Double latitude,
                final Double longitude) {
        this.id = id;
        this.name = name;
        this.indicator = indicator;
        this.state = state;
        this.latitude = latitude;
        this.longitude = longitude;
    }

    /**
     * Construct Stop object from raw list of attributes parsed from JSON.
     *
     * @param raw List of attributes from JSON line
     * @throws IOException Thrown on invalid line format.
     */
    public Stop(final List<Serializable> raw) throws IOException {
        if (raw == null || raw.size() < F_NUM_OF_FIELDS) {
            throw new IOException("Invalid number of fields");
        }

        if (raw.get(1) instanceof String) {
            name = (String) raw.get(F_STOP_NAME);
        } else {
            throw Model.typeErrorString(F_STOP_NAME, raw.get(F_STOP_NAME).getClass());
        }

        if (raw.get(F_STOP_ID) instanceof String) {
            id = (String) raw.get(F_STOP_ID);
        } else {
            throw Model.typeErrorString(F_STOP_ID, raw.get(F_STOP_ID).getClass());
        }

        if (raw.get(F_INDICATOR) instanceof String) {
            indicator = (String) raw.get(F_INDICATOR);
        } else if (raw.get(F_INDICATOR) == null) {
            indicator = null;
        } else {
            throw Model.typeErrorString(F_INDICATOR, raw.get(F_INDICATOR).getClass());
        }

        if (raw.get(F_STATE) instanceof Integer) {
            state = (Integer) raw.get(F_STATE);
        } else {
            throw Model.typeError(F_STATE, raw.get(F_STATE).getClass(), "Integer");
        }

        if (raw.get(F_LATITUDE) instanceof Double) {
            latitude = (Double) raw.get(F_LATITUDE);
        } else {
            throw Model.typeError(F_LATITUDE, raw.get(F_LATITUDE).getClass(), "Double");
        }

        if (raw.get(F_LONGITUDE) instanceof Double) {
            longitude = (Double) raw.get(F_LONGITUDE);
        } else {
            throw Model.typeError(F_LONGITUDE, raw.get(F_LONGITUDE).getClass(), "Double");
        }
    }

    /**
     * Stop identifier.
     *
     * @return The stop ID.
     */
    public String getId() {
        return id;
    }

    /**
     * The name of the bus stop.
     *
     * @return The stop name.
     */
    public String getName() {
        return name;
    }

    /**
     * The letter(s) that are displayed on top of the bus stop flag (e.g. SA).
     * These are used to help passengers easily identify a bus stop from others in the locality.
     *
     * @return The stop indicator.
     */
    public String getIndicator() {
        return indicator;
    }

    /**
     * The different stop states and their definitions are provided below:
     * <ul>
     * <li>0: “Open”: Bus stop is being served as usual</li>
     * <li>1: “Temporarily Closed” : Vehicles are not serving the stop but may be serving a nearby bus stop,
     *                               predictions may be available</li>
     * <li>2: “Closed” : Vehicles are not serving the stop.
     *                   Stop should display the closed message and predictions should not be shown.</li>
     * <li>3: “Suspended” : Vehicles are not serving the stop.
     *                      Stop should display the closed message and predictions should not be shown.</li>
     * </ul>
     *
     * @return The stop state.
     */
    public Integer getState() {
        return state;
    }

    /**
     * The latitude of the stop. This is expressed using the WGS84 coordinate system.
     *
     * @return The stop geolocation latitude.
     */
    public Double getLatitude() {
        return latitude;
    }

    /**
     * The longitude of the stop. This isexpressed using the WGS84 coordinate system.
     *
     * @return The stop geolocation longitude.
     */
    public Double getLongitude() {
        return longitude;
    }
}