de.vdv.ojp20.ProvisionedCallAtPlaceStructure 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.PassengerCapacityStructure;
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 org.apache.commons.lang3.builder.ToStringBuilder;
import org.opentripplanner.ojp.netex.OmitNullsToStringStyle;


/**
 * Provisioned vehicle call at a general location.
 * 
 * Java class for ProvisionedCallAtPlaceStructure complex type.
 * 
 * The following schema fragment specifies the expected content contained within this class.
 * 
 * {@code
 * 
 *   
 *     
 *       
 *         
 *         
 *         
 *         
 *         
 *       
 *     
 *   
 * 
 * }
 * 
 * 
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "ProvisionedCallAtPlaceStructure", propOrder = {
    "journeyRef",
    "operatingDayRef",
    "callPlace",
    "serviceArrival",
    "serviceDeparture",
    "order",
    "requestStop",
    "unplannedStop",
    "notServicedStop",
    "noBoardingAtStop",
    "noAlightingAtStop",
    "expectedDepartureOccupancy",
    "expectedDepartureCapacities",
    "attribute"
})
public class ProvisionedCallAtPlaceStructure {

    /**
     * Reference to a Journey
     * 
     */
    @XmlElement(name = "JourneyRef")
    protected JourneyRefStructure journeyRef;
    /**
     * Reference to an Operating Day
     * 
     */
    @XmlElement(name = "OperatingDayRef")
    protected OperatingDayRefStructure operatingDayRef;
    /**
     * More general location for a call than stop points. May be used with flexible services or "Area Dial-A-Ride".
     * 
     */
    @XmlElement(name = "CallPlace", required = true)
    protected PlaceRefStructure callPlace;
    /**
     * Arrival times of the service at this stop.
     * 
     */
    @XmlElement(name = "ServiceArrival")
    protected ServiceArrivalStructure serviceArrival;
    /**
     * Departure times of the service at this stop.
     * 
     */
    @XmlElement(name = "ServiceDeparture")
    protected ServiceDepartureStructure serviceDeparture;
    /**
     * 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 Journey
     * 
     * @return
     *     possible object is
     *     {@link JourneyRefStructure }
     *     
     */
    public JourneyRefStructure getJourneyRef() {
        return journeyRef;
    }

    /**
     * Sets the value of the journeyRef property.
     * 
     * @param value
     *     allowed object is
     *     {@link JourneyRefStructure }
     *     
     * @see #getJourneyRef()
     */
    public void setJourneyRef(JourneyRefStructure value) {
        this.journeyRef = value;
    }

    /**
     * Reference to an Operating Day
     * 
     * @return
     *     possible object is
     *     {@link OperatingDayRefStructure }
     *     
     */
    public OperatingDayRefStructure getOperatingDayRef() {
        return operatingDayRef;
    }

    /**
     * Sets the value of the operatingDayRef property.
     * 
     * @param value
     *     allowed object is
     *     {@link OperatingDayRefStructure }
     *     
     * @see #getOperatingDayRef()
     */
    public void setOperatingDayRef(OperatingDayRefStructure value) {
        this.operatingDayRef = value;
    }

    /**
     * More general location for a call than stop points. May be used with flexible services or "Area Dial-A-Ride".
     * 
     * @return
     *     possible object is
     *     {@link PlaceRefStructure }
     *     
     */
    public PlaceRefStructure getCallPlace() {
        return callPlace;
    }

    /**
     * Sets the value of the callPlace property.
     * 
     * @param value
     *     allowed object is
     *     {@link PlaceRefStructure }
     *     
     * @see #getCallPlace()
     */
    public void setCallPlace(PlaceRefStructure value) {
        this.callPlace = value;
    }

    /**
     * Arrival times of the service at this stop.
     * 
     * @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;
    }

    /**
     * Departure times of the service at this stop.
     * 
     * @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;
    }

    /**
     * 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 ProvisionedCallAtPlaceStructure withJourneyRef(JourneyRefStructure value) {
        setJourneyRef(value);
        return this;
    }

    public ProvisionedCallAtPlaceStructure withOperatingDayRef(OperatingDayRefStructure value) {
        setOperatingDayRef(value);
        return this;
    }

    public ProvisionedCallAtPlaceStructure withCallPlace(PlaceRefStructure value) {
        setCallPlace(value);
        return this;
    }

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

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

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

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

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

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

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

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

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

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

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

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

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

    public ProvisionedCallAtPlaceStructure 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);
    }

}