de.vdv.ojp20.LegBoardStructure 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.math.BigInteger;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import de.vdv.ojp20.siri.LocationStructure;
import de.vdv.ojp20.siri.PassengerCapacityStructure;
import de.vdv.ojp20.siri.StopPointRefStructure;
import de.vdv.ojp20.siri.VehicleOccupancyStructure;
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 jakarta.xml.bind.annotation.adapters.NormalizedStringAdapter;
import jakarta.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
import org.apache.commons.lang3.builder.ToStringBuilder;
import org.opentripplanner.ojp.netex.OmitNullsToStringStyle;


/**
 * Describes the situation at a stop or station at which the passenger boards a Leg of a trip including time-related information.
 * 
 * Java class for LegBoardStructure complex type.
 * 
 * The following schema fragment specifies the expected content contained within this class.
 * 
 * {@code
 * 
 *   
 *     
 *       
 *         
 *           
 *           
 *         
 *         
 *         
 *         
 *         
 *         
 *       
 *     
 *   
 * 
 * }
 * 
 * 
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "LegBoardStructure", propOrder = {
    "stopPointRef",
    "stopPointName",
    "nameSuffix",
    "plannedQuay",
    "estimatedQuay",
    "geoPosition",
    "serviceArrival",
    "serviceDeparture",
    "distributorInterchangeId",
    "meetsViaRequest",
    "order",
    "requestStop",
    "unplannedStop",
    "notServicedStop",
    "noBoardingAtStop",
    "noAlightingAtStop",
    "expectedDepartureOccupancy",
    "expectedDepartureCapacities",
    "attribute"
})
public class LegBoardStructure {

    /**
     * Reference to a stop point.
     * 
     */
    @XmlElement(name = "StopPointRef", namespace = "http://www.siri.org.uk/siri")
    protected StopPointRefStructure stopPointRef;
    /**
     * Name or description of stop point for use in passenger information.
     * 
     */
    @XmlElement(name = "StopPointName")
    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;
    @XmlElement(name = "GeoPosition")
    protected LocationStructure geoPosition;
    /**
     * Contains ARRIVAL times (timetable, recorded, estimated, timing bands estimated) and the ARRIVAL formation.
     * 
     */
    @XmlElement(name = "ServiceArrival")
    protected ServiceArrivalStructure serviceArrival;
    /**
     * Contains DEPARTURE times (timetable, recorded, estimated, timing bands estimated) and the DEPARTURE formation.
     * 
     */
    @XmlElement(name = "ServiceDeparture", required = true)
    protected ServiceDepartureStructure serviceDeparture;
    /**
     * Interchange identifier of the distributing line/service at its boarding. This is not a reference. This identifier is used to recognize in a distributed environment (e.g., EU-Spirit), that two systems refer to the same line (or service) while using their own internal references. In EU-Spirit this is used to decide whether an interchange is in fact a stay-seated scenario (aka "line ID"). See https://eu-spirit.eu/
     * 
     */
    @XmlElement(name = "DistributorInterchangeId")
    @XmlJavaTypeAdapter(NormalizedStringAdapter.class)
    @XmlSchemaType(name = "normalizedString")
    protected String distributorInterchangeId;
    /**
     * This stop fulfils one of the via requirements stated in the request data.
     * 
     */
    @XmlElement(name = "MeetsViaRequest", defaultValue = "false")
    protected Boolean meetsViaRequest;
    /**
     * Sequence number of this stop in the service pattern of the journey.
     * 
     */
    @XmlElement(name = "Order")
    @XmlSchemaType(name = "positiveInteger")
    protected BigInteger order;
    /**
     * The vehicle journey calls at this stop only on demand.
     * 
     */
    @XmlElement(name = "RequestStop", defaultValue = "false")
    protected Boolean requestStop;
    /**
     * This stop has not been planned by the planning department.
     * 
     */
    @XmlElement(name = "UnplannedStop", defaultValue = "false")
    protected Boolean unplannedStop;
    /**
     * The vehicle will not call at this stop despite earlier planning.
     * 
     */
    @XmlElement(name = "NotServicedStop", defaultValue = "false")
    protected Boolean notServicedStop;
    /**
     * Boarding will not be allowed at this stop of this journey.
     * 
     */
    @XmlElement(name = "NoBoardingAtStop", defaultValue = "false")
    protected Boolean noBoardingAtStop;
    /**
     * Alighting will not be allowed at this stop of this journey.
     * 
     */
    @XmlElement(name = "NoAlightingAtStop", defaultValue = "false")
    protected Boolean noAlightingAtStop;
    /**
     * The Occupancy structure from SIRI can be used here. It is recommended to mainly have one ExpectedDepartureOccupancy for each FareClass and mainly focus on OccupancyLevel and OccupancyPercentage. For more details have a look at the SIRI documentation.
     * 
     */
    @XmlElement(name = "ExpectedDepartureOccupancy", namespace = "http://www.siri.org.uk/siri")
    protected List expectedDepartureOccupancy;
    /**
     * The Capacity structure also will probably rarely be used and parsed. When used, then it mainly shows elements that are important for accessibility.
     * 
     */
    @XmlElement(name = "ExpectedDepartureCapacities", namespace = "http://www.siri.org.uk/siri")
    protected List expectedDepartureCapacities;
    /**
     * Note or attribute.
     * 
     */
    @XmlElement(name = "Attribute")
    protected List attribute;

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

    /**
     * Gets the value of the geoPosition property.
     * 
     * @return
     *     possible object is
     *     {@link LocationStructure }
     *     
     */
    public LocationStructure getGeoPosition() {
        return geoPosition;
    }

    /**
     * Sets the value of the geoPosition property.
     * 
     * @param value
     *     allowed object is
     *     {@link LocationStructure }
     *     
     */
    public void setGeoPosition(LocationStructure value) {
        this.geoPosition = value;
    }

    /**
     * Contains ARRIVAL times (timetable, recorded, estimated, timing bands estimated) and the ARRIVAL formation.
     * 
     * @return
     *     possible object is
     *     {@link ServiceArrivalStructure }
     *     
     */
    public ServiceArrivalStructure getServiceArrival() {
        return serviceArrival;
    }

    /**
     * Sets the value of the serviceArrival property.
     * 
     * @param value
     *     allowed object is
     *     {@link ServiceArrivalStructure }
     *     
     * @see #getServiceArrival()
     */
    public void setServiceArrival(ServiceArrivalStructure value) {
        this.serviceArrival = value;
    }

    /**
     * Contains DEPARTURE times (timetable, recorded, estimated, timing bands estimated) and the DEPARTURE formation.
     * 
     * @return
     *     possible object is
     *     {@link ServiceDepartureStructure }
     *     
     */
    public ServiceDepartureStructure getServiceDeparture() {
        return serviceDeparture;
    }

    /**
     * Sets the value of the serviceDeparture property.
     * 
     * @param value
     *     allowed object is
     *     {@link ServiceDepartureStructure }
     *     
     * @see #getServiceDeparture()
     */
    public void setServiceDeparture(ServiceDepartureStructure value) {
        this.serviceDeparture = value;
    }

    /**
     * Interchange identifier of the distributing line/service at its boarding. This is not a reference. This identifier is used to recognize in a distributed environment (e.g., EU-Spirit), that two systems refer to the same line (or service) while using their own internal references. In EU-Spirit this is used to decide whether an interchange is in fact a stay-seated scenario (aka "line ID"). See https://eu-spirit.eu/
     * 
     * @return
     *     possible object is
     *     {@link String }
     *     
     */
    public String getDistributorInterchangeId() {
        return distributorInterchangeId;
    }

    /**
     * Sets the value of the distributorInterchangeId property.
     * 
     * @param value
     *     allowed object is
     *     {@link String }
     *     
     * @see #getDistributorInterchangeId()
     */
    public void setDistributorInterchangeId(String value) {
        this.distributorInterchangeId = value;
    }

    /**
     * This stop fulfils one of the via requirements stated in the request data.
     * 
     * @return
     *     possible object is
     *     {@link Boolean }
     *     
     */
    public Boolean isMeetsViaRequest() {
        return meetsViaRequest;
    }

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

    /**
     * Sequence number of this stop in the service pattern of the journey.
     * 
     * @return
     *     possible object is
     *     {@link BigInteger }
     *     
     */
    public BigInteger getOrder() {
        return order;
    }

    /**
     * Sets the value of the order property.
     * 
     * @param value
     *     allowed object is
     *     {@link BigInteger }
     *     
     * @see #getOrder()
     */
    public void setOrder(BigInteger value) {
        this.order = value;
    }

    /**
     * The vehicle journey calls at this stop only on demand.
     * 
     * @return
     *     possible object is
     *     {@link Boolean }
     *     
     */
    public Boolean isRequestStop() {
        return requestStop;
    }

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

    /**
     * This stop has not been planned by the planning department.
     * 
     * @return
     *     possible object is
     *     {@link Boolean }
     *     
     */
    public Boolean isUnplannedStop() {
        return unplannedStop;
    }

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

    /**
     * The vehicle will not call at this stop despite earlier planning.
     * 
     * @return
     *     possible object is
     *     {@link Boolean }
     *     
     */
    public Boolean isNotServicedStop() {
        return notServicedStop;
    }

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

    /**
     * Boarding will not be allowed at this stop of this journey.
     * 
     * @return
     *     possible object is
     *     {@link Boolean }
     *     
     */
    public Boolean isNoBoardingAtStop() {
        return noBoardingAtStop;
    }

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

    /**
     * Alighting will not be allowed at this stop of this journey.
     * 
     * @return
     *     possible object is
     *     {@link Boolean }
     *     
     */
    public Boolean isNoAlightingAtStop() {
        return noAlightingAtStop;
    }

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

    /**
     * The Occupancy structure from SIRI can be used here. It is recommended to mainly have one ExpectedDepartureOccupancy for each FareClass and mainly focus on OccupancyLevel and OccupancyPercentage. For more details have a look at the SIRI documentation.
     * 
     * Gets the value of the expectedDepartureOccupancy 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 expectedDepartureOccupancy property.
     * 
     * 
     * For example, to add a new item, do as follows:
     * 
     *      * getExpectedDepartureOccupancy().add(newItem);
     * 
     * 
     * 
     * 
     * Objects of the following type(s) are allowed in the list
     * {@link VehicleOccupancyStructure }
     * 
     * 
     * 
     * @return
     *     The value of the expectedDepartureOccupancy property.
     */
    public List getExpectedDepartureOccupancy() {
        if (expectedDepartureOccupancy == null) {
            expectedDepartureOccupancy = new ArrayList<>();
        }
        return this.expectedDepartureOccupancy;
    }

    /**
     * The Capacity structure also will probably rarely be used and parsed. When used, then it mainly shows elements that are important for accessibility.
     * 
     * Gets the value of the expectedDepartureCapacities 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 expectedDepartureCapacities property.
     * 
     * 
     * For example, to add a new item, do as follows:
     * 
     *      * getExpectedDepartureCapacities().add(newItem);
     * 
     * 
     * 
     * 
     * Objects of the following type(s) are allowed in the list
     * {@link PassengerCapacityStructure }
     * 
     * 
     * 
     * @return
     *     The value of the expectedDepartureCapacities property.
     */
    public List getExpectedDepartureCapacities() {
        if (expectedDepartureCapacities == null) {
            expectedDepartureCapacities = new ArrayList<>();
        }
        return this.expectedDepartureCapacities;
    }

    /**
     * Note or attribute.
     * 
     * Gets the value of the attribute 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 attribute property.
     * 
     * 
     * For example, to add a new item, do as follows:
     * 
     *      * getAttribute().add(newItem);
     * 
     * 
     * 
     * 
     * Objects of the following type(s) are allowed in the list
     * {@link GeneralAttributeStructure }
     * 
     * 
     * 
     * @return
     *     The value of the attribute property.
     */
    public List getAttribute() {
        if (attribute == null) {
            attribute = new ArrayList<>();
        }
        return this.attribute;
    }

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

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

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

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

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

    public LegBoardStructure withGeoPosition(LocationStructure value) {
        setGeoPosition(value);
        return this;
    }

    public LegBoardStructure withServiceArrival(ServiceArrivalStructure value) {
        setServiceArrival(value);
        return this;
    }

    public LegBoardStructure withServiceDeparture(ServiceDepartureStructure value) {
        setServiceDeparture(value);
        return this;
    }

    public LegBoardStructure withDistributorInterchangeId(String value) {
        setDistributorInterchangeId(value);
        return this;
    }

    public LegBoardStructure withMeetsViaRequest(Boolean value) {
        setMeetsViaRequest(value);
        return this;
    }

    public LegBoardStructure withOrder(BigInteger value) {
        setOrder(value);
        return this;
    }

    public LegBoardStructure withRequestStop(Boolean value) {
        setRequestStop(value);
        return this;
    }

    public LegBoardStructure withUnplannedStop(Boolean value) {
        setUnplannedStop(value);
        return this;
    }

    public LegBoardStructure withNotServicedStop(Boolean value) {
        setNotServicedStop(value);
        return this;
    }

    public LegBoardStructure withNoBoardingAtStop(Boolean value) {
        setNoBoardingAtStop(value);
        return this;
    }

    public LegBoardStructure withNoAlightingAtStop(Boolean value) {
        setNoAlightingAtStop(value);
        return this;
    }

    public LegBoardStructure withExpectedDepartureOccupancy(VehicleOccupancyStructure... values) {
        if (values!= null) {
            for (VehicleOccupancyStructure value: values) {
                getExpectedDepartureOccupancy().add(value);
            }
        }
        return this;
    }

    public LegBoardStructure withExpectedDepartureOccupancy(Collection values) {
        if (values!= null) {
            getExpectedDepartureOccupancy().addAll(values);
        }
        return this;
    }

    public LegBoardStructure withExpectedDepartureCapacities(PassengerCapacityStructure... values) {
        if (values!= null) {
            for (PassengerCapacityStructure value: values) {
                getExpectedDepartureCapacities().add(value);
            }
        }
        return this;
    }

    public LegBoardStructure withExpectedDepartureCapacities(Collection values) {
        if (values!= null) {
            getExpectedDepartureCapacities().addAll(values);
        }
        return this;
    }

    public LegBoardStructure withAttribute(GeneralAttributeStructure... values) {
        if (values!= null) {
            for (GeneralAttributeStructure value: values) {
                getAttribute().add(value);
            }
        }
        return this;
    }

    public LegBoardStructure withAttribute(Collection values) {
        if (values!= null) {
            getAttribute().addAll(values);
        }
        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);
    }

}