de.vdv.ojp20.PlaceContextStructure 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.time.Duration;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
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.XmlJavaTypeAdapter;
import org.apache.commons.lang3.builder.ToStringBuilder;
import org.opentripplanner.ojp.netex.OmitNullsToStringStyle;
import org.opentripplanner.ojp.time.XmlDateTime;
import org.opentripplanner.ojp.util.DurationXmlAdapter;
import org.opentripplanner.ojp.util.XmlDateTimeAdapter;


/**
 * [a view of PLACE in TMv6] a PLACE and access to it by individual transport
 * 
 * Java class for PlaceContextStructure complex type.
 * 
 * The following schema fragment specifies the expected content contained within this class.
 * 
 * {@code
 * 
 *   
 *     
 *       
 *         
 *           
 *           
 *         
 *         
 *           
 *           
 *         
 *         
 *       
 *     
 *   
 * 
 * }
 * 
 * 
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "PlaceContextStructure", propOrder = {
    "placeRef",
    "tripLocation",
    "depArrTime",
    "timeAllowance",
    "individualTransportOption"
})
public class PlaceContextStructure {

    /**
     * Static place.
     * 
     */
    @XmlElement(name = "PlaceRef")
    protected PlaceRefStructure placeRef;
    /**
     * Location within a (moving) vehicle.
     * 
     */
    @XmlElement(name = "TripLocation")
    protected TripLocationStructure tripLocation;
    /**
     * Time when departure/arrival from/to location is required.
     * 
     */
    @XmlElement(name = "DepArrTime", type = String.class)
    @XmlJavaTypeAdapter(XmlDateTimeAdapter.class)
    @XmlSchemaType(name = "dateTime")
    protected XmlDateTime depArrTime;
    /**
     * Extra time needed before reaching/after leaving this location (an example of a TRIP ACCESS CONSTRAINT. In Transmodel it is modelled more extensively and could relate to ACCESS MODE e.g., walk max. 5 minutes, but cycle 10 minutes).
     * 
     */
    @XmlElement(name = "TimeAllowance", type = String.class)
    @XmlJavaTypeAdapter(DurationXmlAdapter.class)
    @XmlSchemaType(name = "duration")
    protected Duration timeAllowance;
    /**
     * Options how to access/leave the place by individual transport.
     * 
     */
    @XmlElement(name = "IndividualTransportOption")
    protected List individualTransportOption;

    /**
     * Static place.
     * 
     * @return
     *     possible object is
     *     {@link PlaceRefStructure }
     *     
     */
    public PlaceRefStructure getPlaceRef() {
        return placeRef;
    }

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

    /**
     * Location within a (moving) vehicle.
     * 
     * @return
     *     possible object is
     *     {@link TripLocationStructure }
     *     
     */
    public TripLocationStructure getTripLocation() {
        return tripLocation;
    }

    /**
     * Sets the value of the tripLocation property.
     * 
     * @param value
     *     allowed object is
     *     {@link TripLocationStructure }
     *     
     * @see #getTripLocation()
     */
    public void setTripLocation(TripLocationStructure value) {
        this.tripLocation = value;
    }

    /**
     * Time when departure/arrival from/to location is required.
     * 
     * @return
     *     possible object is
     *     {@link String }
     *     
     */
    public XmlDateTime getDepArrTime() {
        return depArrTime;
    }

    /**
     * Sets the value of the depArrTime property.
     * 
     * @param value
     *     allowed object is
     *     {@link String }
     *     
     * @see #getDepArrTime()
     */
    public void setDepArrTime(XmlDateTime value) {
        this.depArrTime = value;
    }

    /**
     * Extra time needed before reaching/after leaving this location (an example of a TRIP ACCESS CONSTRAINT. In Transmodel it is modelled more extensively and could relate to ACCESS MODE e.g., walk max. 5 minutes, but cycle 10 minutes).
     * 
     * @return
     *     possible object is
     *     {@link String }
     *     
     */
    public Duration getTimeAllowance() {
        return timeAllowance;
    }

    /**
     * Sets the value of the timeAllowance property.
     * 
     * @param value
     *     allowed object is
     *     {@link String }
     *     
     * @see #getTimeAllowance()
     */
    public void setTimeAllowance(Duration value) {
        this.timeAllowance = value;
    }

    /**
     * Options how to access/leave the place by individual transport.
     * 
     * Gets the value of the individualTransportOption 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 individualTransportOption property.
     * 
     * 
     * For example, to add a new item, do as follows:
     * 
     *      * getIndividualTransportOption().add(newItem);
     * 
     * 
     * 
     * 
     * Objects of the following type(s) are allowed in the list
     * {@link IndividualTransportOptionStructure }
     * 
     * 
     * 
     * @return
     *     The value of the individualTransportOption property.
     */
    public List getIndividualTransportOption() {
        if (individualTransportOption == null) {
            individualTransportOption = new ArrayList<>();
        }
        return this.individualTransportOption;
    }

    public PlaceContextStructure withPlaceRef(PlaceRefStructure value) {
        setPlaceRef(value);
        return this;
    }

    public PlaceContextStructure withTripLocation(TripLocationStructure value) {
        setTripLocation(value);
        return this;
    }

    public PlaceContextStructure withDepArrTime(XmlDateTime value) {
        setDepArrTime(value);
        return this;
    }

    public PlaceContextStructure withTimeAllowance(Duration value) {
        setTimeAllowance(value);
        return this;
    }

    public PlaceContextStructure withIndividualTransportOption(IndividualTransportOptionStructure... values) {
        if (values!= null) {
            for (IndividualTransportOptionStructure value: values) {
                getIndividualTransportOption().add(value);
            }
        }
        return this;
    }

    public PlaceContextStructure withIndividualTransportOption(Collection values) {
        if (values!= null) {
            getIndividualTransportOption().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);
    }

}