de.vdv.ojp20.TripSummaryStructure 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.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.NormalizedStringAdapter;
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;


/**
 * Structure for trip overview information (only implementation related and therefore not modelled in Transmodel).
 * 
 * Java class for TripSummaryStructure complex type.
 * 
 * The following schema fragment specifies the expected content contained within this class.
 * 
 * {@code
 * 
 *   
 *     
 *       
 *         
 *         
 *         
 *         
 *         
 *         
 *         
 *         
 *         
 *         
 *         
 *         
 *       
 *     
 *   
 * 
 * }
 * 
 * 
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "TripSummaryStructure", propOrder = {
    "tripId",
    "origin",
    "destination",
    "duration",
    "startTime",
    "endTime",
    "ptLegs",
    "distance",
    "operatingDays",
    "operatingDaysDescription",
    "feasibility",
    "situationFullRefs",
    "extension"
})
public class TripSummaryStructure {

    /**
     * Id of this trip for referencing purposes. Unique within trip response.
     * 
     */
    @XmlElement(name = "TripId", required = true)
    @XmlJavaTypeAdapter(NormalizedStringAdapter.class)
    @XmlSchemaType(name = "normalizedString")
    protected String tripId;
    /**
     * Describes the origin situation of this trip.
     * 
     */
    @XmlElement(name = "Origin")
    protected PlaceRefStructure origin;
    /**
     * Describes the arrival situation of this trip.
     * 
     */
    @XmlElement(name = "Destination")
    protected PlaceRefStructure destination;
    /**
     * Overall duration of the trip (TRIP attribute, not detailed in Transmodel, available from constituting LEGs).
     * 
     */
    @XmlElement(name = "Duration", type = String.class)
    @XmlJavaTypeAdapter(DurationXmlAdapter.class)
    @XmlSchemaType(name = "duration")
    protected Duration duration;
    /**
     * Departure time at origin (TRIP attribute, not detailed in Transmodel, available from constituting LEGs).
     * 
     */
    @XmlElement(name = "StartTime", type = String.class)
    @XmlJavaTypeAdapter(XmlDateTimeAdapter.class)
    @XmlSchemaType(name = "dateTime")
    protected XmlDateTime startTime;
    /**
     * Arrival time at destination (TRIP attribute, not detailed in Transmodel, available from constituting LEGs).
     * 
     */
    @XmlElement(name = "EndTime", type = String.class)
    @XmlJavaTypeAdapter(XmlDateTimeAdapter.class)
    @XmlSchemaType(name = "dateTime")
    protected XmlDateTime endTime;
    /**
     * Number of public transport legs.
     * 
     */
    @XmlElement(name = "PTLegs")
    @XmlSchemaType(name = "nonNegativeInteger")
    protected BigInteger ptLegs;
    /**
     * Trip distance (TRIP attribute, not detailed in Transmodel, available from constituting LEGs).
     * 
     */
    @XmlElement(name = "Distance")
    @XmlSchemaType(name = "nonNegativeInteger")
    protected BigInteger distance;
    /**
     * Bit string definition of operating days.
     * 
     */
    @XmlElement(name = "OperatingDays")
    protected OperatingDaysStructure operatingDays;
    /**
     * Textual description of the operation days, e.g., "Monday to Friday" or "not on holidays".
     * 
     */
    @XmlElement(name = "OperatingDaysDescription")
    protected InternationalTextStructure operatingDaysDescription;
    /**
     * Information about the feasibility of the TRIP, in particular with respect to the access features used.
     * 
     */
    @XmlElement(name = "Feasibility")
    @XmlSchemaType(name = "string")
    protected List feasibility;
    /**
     * A list of references to SITUATIONs.
     * 
     */
    @XmlElement(name = "SituationFullRefs")
    protected SituationRefList situationFullRefs;
    @XmlElement(name = "Extension")
    protected Object extension;

    /**
     * Id of this trip for referencing purposes. Unique within trip response.
     * 
     * @return
     *     possible object is
     *     {@link String }
     *     
     */
    public String getTripId() {
        return tripId;
    }

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

    /**
     * Describes the origin situation of this trip.
     * 
     * @return
     *     possible object is
     *     {@link PlaceRefStructure }
     *     
     */
    public PlaceRefStructure getOrigin() {
        return origin;
    }

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

    /**
     * Describes the arrival situation of this trip.
     * 
     * @return
     *     possible object is
     *     {@link PlaceRefStructure }
     *     
     */
    public PlaceRefStructure getDestination() {
        return destination;
    }

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

    /**
     * Overall duration of the trip (TRIP attribute, not detailed in Transmodel, available from constituting LEGs).
     * 
     * @return
     *     possible object is
     *     {@link String }
     *     
     */
    public Duration getDuration() {
        return duration;
    }

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

    /**
     * Departure time at origin (TRIP attribute, not detailed in Transmodel, available from constituting LEGs).
     * 
     * @return
     *     possible object is
     *     {@link String }
     *     
     */
    public XmlDateTime getStartTime() {
        return startTime;
    }

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

    /**
     * Arrival time at destination (TRIP attribute, not detailed in Transmodel, available from constituting LEGs).
     * 
     * @return
     *     possible object is
     *     {@link String }
     *     
     */
    public XmlDateTime getEndTime() {
        return endTime;
    }

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

    /**
     * Number of public transport legs.
     * 
     * @return
     *     possible object is
     *     {@link BigInteger }
     *     
     */
    public BigInteger getPTLegs() {
        return ptLegs;
    }

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

    /**
     * Trip distance (TRIP attribute, not detailed in Transmodel, available from constituting LEGs).
     * 
     * @return
     *     possible object is
     *     {@link BigInteger }
     *     
     */
    public BigInteger getDistance() {
        return distance;
    }

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

    /**
     * Bit string definition of operating days.
     * 
     * @return
     *     possible object is
     *     {@link OperatingDaysStructure }
     *     
     */
    public OperatingDaysStructure getOperatingDays() {
        return operatingDays;
    }

    /**
     * Sets the value of the operatingDays property.
     * 
     * @param value
     *     allowed object is
     *     {@link OperatingDaysStructure }
     *     
     * @see #getOperatingDays()
     */
    public void setOperatingDays(OperatingDaysStructure value) {
        this.operatingDays = value;
    }

    /**
     * Textual description of the operation days, e.g., "Monday to Friday" or "not on holidays".
     * 
     * @return
     *     possible object is
     *     {@link InternationalTextStructure }
     *     
     */
    public InternationalTextStructure getOperatingDaysDescription() {
        return operatingDaysDescription;
    }

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

    /**
     * Information about the feasibility of the TRIP, in particular with respect to the access features used.
     * 
     * Gets the value of the feasibility 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 feasibility property.
     * 
     * 
     * For example, to add a new item, do as follows:
     * 
     *      * getFeasibility().add(newItem);
     * 
     * 
     * 
     * 
     * Objects of the following type(s) are allowed in the list
     * {@link FeasibilityEnumeration }
     * 
     * 
     * 
     * @return
     *     The value of the feasibility property.
     */
    public List getFeasibility() {
        if (feasibility == null) {
            feasibility = new ArrayList<>();
        }
        return this.feasibility;
    }

    /**
     * A list of references to SITUATIONs.
     * 
     * @return
     *     possible object is
     *     {@link SituationRefList }
     *     
     */
    public SituationRefList getSituationFullRefs() {
        return situationFullRefs;
    }

    /**
     * Sets the value of the situationFullRefs property.
     * 
     * @param value
     *     allowed object is
     *     {@link SituationRefList }
     *     
     * @see #getSituationFullRefs()
     */
    public void setSituationFullRefs(SituationRefList value) {
        this.situationFullRefs = value;
    }

    /**
     * Gets the value of the extension property.
     * 
     * @return
     *     possible object is
     *     {@link Object }
     *     
     */
    public Object getExtension() {
        return extension;
    }

    /**
     * Sets the value of the extension property.
     * 
     * @param value
     *     allowed object is
     *     {@link Object }
     *     
     */
    public void setExtension(Object value) {
        this.extension = value;
    }

    public TripSummaryStructure withTripId(String value) {
        setTripId(value);
        return this;
    }

    public TripSummaryStructure withOrigin(PlaceRefStructure value) {
        setOrigin(value);
        return this;
    }

    public TripSummaryStructure withDestination(PlaceRefStructure value) {
        setDestination(value);
        return this;
    }

    public TripSummaryStructure withDuration(Duration value) {
        setDuration(value);
        return this;
    }

    public TripSummaryStructure withStartTime(XmlDateTime value) {
        setStartTime(value);
        return this;
    }

    public TripSummaryStructure withEndTime(XmlDateTime value) {
        setEndTime(value);
        return this;
    }

    public TripSummaryStructure withPTLegs(BigInteger value) {
        setPTLegs(value);
        return this;
    }

    public TripSummaryStructure withDistance(BigInteger value) {
        setDistance(value);
        return this;
    }

    public TripSummaryStructure withOperatingDays(OperatingDaysStructure value) {
        setOperatingDays(value);
        return this;
    }

    public TripSummaryStructure withOperatingDaysDescription(InternationalTextStructure value) {
        setOperatingDaysDescription(value);
        return this;
    }

    public TripSummaryStructure withFeasibility(FeasibilityEnumeration... values) {
        if (values!= null) {
            for (FeasibilityEnumeration value: values) {
                getFeasibility().add(value);
            }
        }
        return this;
    }

    public TripSummaryStructure withFeasibility(Collection values) {
        if (values!= null) {
            getFeasibility().addAll(values);
        }
        return this;
    }

    public TripSummaryStructure withSituationFullRefs(SituationRefList value) {
        setSituationFullRefs(value);
        return this;
    }

    public TripSummaryStructure withExtension(Object value) {
        setExtension(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);
    }

}