de.vdv.ojp20.StopPointStructure Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ojp-java-model Show documentation
Generates Java model from OJP xsds using jaxb.
The newest version!
//
// This file was generated by the Eclipse Implementation of JAXB, v4.0.5 
// See https://eclipse-ee4j.github.io/jaxb-ri 
// Any modifications to this file will be lost upon recompilation of the source schema. 
//


package de.vdv.ojp20;

import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import de.vdv.ojp20.siri.StopPointRefStructure;
import jakarta.xml.bind.annotation.XmlAccessType;
import jakarta.xml.bind.annotation.XmlAccessorType;
import jakarta.xml.bind.annotation.XmlElement;
import jakarta.xml.bind.annotation.XmlType;
import org.apache.commons.lang3.builder.ToStringBuilder;
import org.opentripplanner.ojp.netex.OmitNullsToStringStyle;


/**
 * [an extended view of SCHEDULED STOP POINT in TMv6] a SCHEDULED STOP POINT extended by ACCESSIBILITY LIMITATION attributes and with identifier and name where passengers can board or alight from vehicles
 * 
 * Java class for StopPointStructure complex type.
 * 
 * The following schema fragment specifies the expected content contained within this class.
 * 
 * {@code
 * 
 *   
 *     
 *       
 *         
 *         
 *         
 *         
 *         
 *       
 *     
 *   
 * 
 * }
 * 
 * 
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "StopPointStructure", propOrder = {
    "stopPointRef",
    "stopPointName",
    "nameSuffix",
    "plannedQuay",
    "estimatedQuay",
    "privateCode",
    "parentRef",
    "topographicPlaceRef",
    "wheelchairAccessible",
    "lighting",
    "covered"
})
public class StopPointStructure {

    /**
     * Reference to a stop point.
     * 
     */
    @XmlElement(name = "StopPointRef", namespace = "http://www.siri.org.uk/siri", required = true)
    protected StopPointRefStructure stopPointRef;
    /**
     * Name or description of stop point for use in passenger information.
     * 
     */
    @XmlElement(name = "StopPointName", required = true)
    protected InternationalTextStructure stopPointName;
    /**
     * Additional description of the stop point that may be appended to the name if enough space is available. E.g. "opposite main entrance".
     * 
     */
    @XmlElement(name = "NameSuffix")
    protected InternationalTextStructure nameSuffix;
    /**
     * Name of the bay where to board/alight from the vehicle. According to planned timetable.
     * 
     */
    @XmlElement(name = "PlannedQuay")
    protected InternationalTextStructure plannedQuay;
    /**
     * Name of the bay where to board/alight from the vehicle. As to the latest real-time status.
     * 
     */
    @XmlElement(name = "EstimatedQuay")
    protected InternationalTextStructure estimatedQuay;
    /**
     * Code of this stop point in private/foreign/proprietary coding schemes.
     * 
     */
    @XmlElement(name = "PrivateCode")
    protected List privateCode;
    /**
     * Reference to the stop place to which this stop point belongs.
     * 
     */
    @XmlElement(name = "ParentRef")
    protected StopPlaceRefStructure parentRef;
    /**
     * Reference to a TopographicPlace
     * 
     */
    @XmlElement(name = "TopographicPlaceRef")
    protected TopographicPlaceRefStructure topographicPlaceRef;
    /**
     * Whether this stop is accessible for wheelchair users.
     * 
     */
    @XmlElement(name = "WheelchairAccessible", defaultValue = "false")
    protected Boolean wheelchairAccessible;
    /**
     * Whether this stop is lit.
     * 
     */
    @XmlElement(name = "Lighting", defaultValue = "false")
    protected Boolean lighting;
    /**
     * Whether this stop offers protection from weather conditions like rain, snow, storm etc.
     * 
     */
    @XmlElement(name = "Covered", defaultValue = "false")
    protected Boolean covered;

    /**
     * Reference to a stop point.
     * 
     * @return
     *     possible object is
     *     {@link StopPointRefStructure }
     *     
     */
    public StopPointRefStructure getStopPointRef() {
        return stopPointRef;
    }

    /**
     * Sets the value of the stopPointRef property.
     * 
     * @param value
     *     allowed object is
     *     {@link StopPointRefStructure }
     *     
     * @see #getStopPointRef()
     */
    public void setStopPointRef(StopPointRefStructure value) {
        this.stopPointRef = value;
    }

    /**
     * Name or description of stop point for use in passenger information.
     * 
     * @return
     *     possible object is
     *     {@link InternationalTextStructure }
     *     
     */
    public InternationalTextStructure getStopPointName() {
        return stopPointName;
    }

    /**
     * Sets the value of the stopPointName property.
     * 
     * @param value
     *     allowed object is
     *     {@link InternationalTextStructure }
     *     
     * @see #getStopPointName()
     */
    public void setStopPointName(InternationalTextStructure value) {
        this.stopPointName = value;
    }

    /**
     * Additional description of the stop point that may be appended to the name if enough space is available. E.g. "opposite main entrance".
     * 
     * @return
     *     possible object is
     *     {@link InternationalTextStructure }
     *     
     */
    public InternationalTextStructure getNameSuffix() {
        return nameSuffix;
    }

    /**
     * Sets the value of the nameSuffix property.
     * 
     * @param value
     *     allowed object is
     *     {@link InternationalTextStructure }
     *     
     * @see #getNameSuffix()
     */
    public void setNameSuffix(InternationalTextStructure value) {
        this.nameSuffix = value;
    }

    /**
     * Name of the bay where to board/alight from the vehicle. According to planned timetable.
     * 
     * @return
     *     possible object is
     *     {@link InternationalTextStructure }
     *     
     */
    public InternationalTextStructure getPlannedQuay() {
        return plannedQuay;
    }

    /**
     * Sets the value of the plannedQuay property.
     * 
     * @param value
     *     allowed object is
     *     {@link InternationalTextStructure }
     *     
     * @see #getPlannedQuay()
     */
    public void setPlannedQuay(InternationalTextStructure value) {
        this.plannedQuay = value;
    }

    /**
     * Name of the bay where to board/alight from the vehicle. As to the latest real-time status.
     * 
     * @return
     *     possible object is
     *     {@link InternationalTextStructure }
     *     
     */
    public InternationalTextStructure getEstimatedQuay() {
        return estimatedQuay;
    }

    /**
     * Sets the value of the estimatedQuay property.
     * 
     * @param value
     *     allowed object is
     *     {@link InternationalTextStructure }
     *     
     * @see #getEstimatedQuay()
     */
    public void setEstimatedQuay(InternationalTextStructure value) {
        this.estimatedQuay = value;
    }

    /**
     * Code of this stop point in private/foreign/proprietary coding schemes.
     * 
     * Gets the value of the privateCode property.
     * 
     * This accessor method returns a reference to the live list,
     * not a snapshot. Therefore any modification you make to the
     * returned list will be present inside the JAXB object.
     * This is why there is not a set method for the privateCode property.
     * 
     * 
     * For example, to add a new item, do as follows:
     * 
     *      * getPrivateCode().add(newItem);
     * 
     * 
     * 
     * 
     * Objects of the following type(s) are allowed in the list
     * {@link PrivateCodeStructure }
     * 
     * 
     * 
     * @return
     *     The value of the privateCode property.
     */
    public List getPrivateCode() {
        if (privateCode == null) {
            privateCode = new ArrayList<>();
        }
        return this.privateCode;
    }

    /**
     * Reference to the stop place to which this stop point belongs.
     * 
     * @return
     *     possible object is
     *     {@link StopPlaceRefStructure }
     *     
     */
    public StopPlaceRefStructure getParentRef() {
        return parentRef;
    }

    /**
     * Sets the value of the parentRef property.
     * 
     * @param value
     *     allowed object is
     *     {@link StopPlaceRefStructure }
     *     
     * @see #getParentRef()
     */
    public void setParentRef(StopPlaceRefStructure value) {
        this.parentRef = value;
    }

    /**
     * Reference to a TopographicPlace
     * 
     * @return
     *     possible object is
     *     {@link TopographicPlaceRefStructure }
     *     
     */
    public TopographicPlaceRefStructure getTopographicPlaceRef() {
        return topographicPlaceRef;
    }

    /**
     * Sets the value of the topographicPlaceRef property.
     * 
     * @param value
     *     allowed object is
     *     {@link TopographicPlaceRefStructure }
     *     
     * @see #getTopographicPlaceRef()
     */
    public void setTopographicPlaceRef(TopographicPlaceRefStructure value) {
        this.topographicPlaceRef = value;
    }

    /**
     * Whether this stop is accessible for wheelchair users.
     * 
     * @return
     *     possible object is
     *     {@link Boolean }
     *     
     */
    public Boolean isWheelchairAccessible() {
        return wheelchairAccessible;
    }

    /**
     * Sets the value of the wheelchairAccessible property.
     * 
     * @param value
     *     allowed object is
     *     {@link Boolean }
     *     
     * @see #isWheelchairAccessible()
     */
    public void setWheelchairAccessible(Boolean value) {
        this.wheelchairAccessible = value;
    }

    /**
     * Whether this stop is lit.
     * 
     * @return
     *     possible object is
     *     {@link Boolean }
     *     
     */
    public Boolean isLighting() {
        return lighting;
    }

    /**
     * Sets the value of the lighting property.
     * 
     * @param value
     *     allowed object is
     *     {@link Boolean }
     *     
     * @see #isLighting()
     */
    public void setLighting(Boolean value) {
        this.lighting = value;
    }

    /**
     * Whether this stop offers protection from weather conditions like rain, snow, storm etc.
     * 
     * @return
     *     possible object is
     *     {@link Boolean }
     *     
     */
    public Boolean isCovered() {
        return covered;
    }

    /**
     * Sets the value of the covered property.
     * 
     * @param value
     *     allowed object is
     *     {@link Boolean }
     *     
     * @see #isCovered()
     */
    public void setCovered(Boolean value) {
        this.covered = value;
    }

    public StopPointStructure withStopPointRef(StopPointRefStructure value) {
        setStopPointRef(value);
        return this;
    }

    public StopPointStructure withStopPointName(InternationalTextStructure value) {
        setStopPointName(value);
        return this;
    }

    public StopPointStructure withNameSuffix(InternationalTextStructure value) {
        setNameSuffix(value);
        return this;
    }

    public StopPointStructure withPlannedQuay(InternationalTextStructure value) {
        setPlannedQuay(value);
        return this;
    }

    public StopPointStructure withEstimatedQuay(InternationalTextStructure value) {
        setEstimatedQuay(value);
        return this;
    }

    public StopPointStructure withPrivateCode(PrivateCodeStructure... values) {
        if (values!= null) {
            for (PrivateCodeStructure value: values) {
                getPrivateCode().add(value);
            }
        }
        return this;
    }

    public StopPointStructure withPrivateCode(Collection values) {
        if (values!= null) {
            getPrivateCode().addAll(values);
        }
        return this;
    }

    public StopPointStructure withParentRef(StopPlaceRefStructure value) {
        setParentRef(value);
        return this;
    }

    public StopPointStructure withTopographicPlaceRef(TopographicPlaceRefStructure value) {
        setTopographicPlaceRef(value);
        return this;
    }

    public StopPointStructure withWheelchairAccessible(Boolean value) {
        setWheelchairAccessible(value);
        return this;
    }

    public StopPointStructure withLighting(Boolean value) {
        setLighting(value);
        return this;
    }

    public StopPointStructure withCovered(Boolean value) {
        setCovered(value);
        return this;
    }

    /**
     * Generates a String representation of the contents of this type.
     * This is an extension method, produced by the 'ts' xjc plugin
     * 
     */
    @Override
    public String toString() {
        return ToStringBuilder.reflectionToString(this, OmitNullsToStringStyle.INSTANCE);
    }

}