de.vdv.ojp20.ServiceViaPointStructure 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 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.XmlSchemaType;
import jakarta.xml.bind.annotation.XmlType;
import org.apache.commons.lang3.builder.ToStringBuilder;
import org.opentripplanner.ojp.netex.OmitNullsToStringStyle;


/**
 * [a specialisation of VIA in TMv6] STOP PLACE or SCHEDULED STOP POINT as a VIA for a particular SERVICE PATTERN. Specialisation of a VIA.
 * 
 * Java class for ServiceViaPointStructure complex type.
 * 
 * The following schema fragment specifies the expected content contained within this class.
 * 
 * {@code
 * 
 *   
 *     
 *       
 *         
 *         
 *       
 *     
 *   
 * 
 * }
 * 
 * 
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "ServiceViaPointStructure", propOrder = {
    "stopPointRef",
    "stopPointName",
    "nameSuffix",
    "plannedQuay",
    "estimatedQuay",
    "displayPriority"
})
public class ServiceViaPointStructure {

    /**
     * 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;
    /**
     * Priority of this via point to be displayed when space is limited.
     * 
     */
    @XmlElement(name = "DisplayPriority")
    @XmlSchemaType(name = "nonNegativeInteger")
    protected Integer displayPriority;

    /**
     * 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;
    }

    /**
     * Priority of this via point to be displayed when space is limited.
     * 
     * @return
     *     possible object is
     *     {@link Integer }
     *     
     */
    public Integer getDisplayPriority() {
        return displayPriority;
    }

    /**
     * Sets the value of the displayPriority property.
     * 
     * @param value
     *     allowed object is
     *     {@link Integer }
     *     
     * @see #getDisplayPriority()
     */
    public void setDisplayPriority(Integer value) {
        this.displayPriority = value;
    }

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

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

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

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

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

    public ServiceViaPointStructure withDisplayPriority(Integer value) {
        setDisplayPriority(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);
    }

}