de.vdv.ojp20.LegStructure 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 de.vdv.ojp20.siri.ParticipantRefStructure;
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.util.DurationXmlAdapter;


/**
 * A single stage of a TRIP that is made without change of MODE or service (e.g., between each interchange). Implements LEG from TM 6.2.
 * 
 * Java class for LegStructure complex type.
 * 
 * The following schema fragment specifies the expected content contained within this class.
 * 
 * {@code
 * 
 *   
 *     
 *       
 *         
 *         
 *         
 *         
 *           
 *           
 *           
 *         
 *         
 *         
 *       
 *     
 *   
 * 
 * }
 * 
 * 
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "LegStructure", propOrder = {
    "id",
    "participantRef",
    "duration",
    "timedLeg",
    "transferLeg",
    "continuousLeg",
    "emissionCO2",
    "changed"
})
public class LegStructure {

    /**
     * Id of this leg. Unique within trip result.
     * 
     */
    @XmlElement(name = "Id", required = true)
    @XmlJavaTypeAdapter(NormalizedStringAdapter.class)
    @XmlSchemaType(name = "normalizedString")
    protected String id;
    /**
     * [equivalent of PARTICIPANT in SIRI] IT system that is participating in a communication with other participant(s)
     * 
     */
    @XmlElement(name = "ParticipantRef")
    protected ParticipantRefStructure participantRef;
    /**
     * The duration of the LEG (e.g., from Transmodel PT RIDE LEG.Duration).
     * 
     */
    @XmlElement(name = "Duration", type = String.class)
    @XmlJavaTypeAdapter(DurationXmlAdapter.class)
    @XmlSchemaType(name = "duration")
    protected Duration duration;
    /**
     * Corresponds to a RIDE or PT RIDE LEG in TM 6.2 with the attribute Timed (with related information). Passenger LEG with timetabled schedule.
     * 
     */
    @XmlElement(name = "TimedLeg")
    protected TimedLegStructure timedLeg;
    /**
     * TRANSFER LEG or CONNECTION LEG according to TM 6.2. Description of a LEG which links other LEGs where a TRANSFER or CONNECTION between different LOCATIONs is required.
     * 
     */
    @XmlElement(name = "TransferLeg")
    protected TransferLegStructure transferLeg;
    /**
     * A specialised type of RIDE LEG in with Timed=false, a PERSONAL LEG or an ACCESS LEG TM 6 and NeTEx. LEG of a TRIP that is not bound to a timetable.
     * 
     */
    @XmlElement(name = "ContinuousLeg")
    protected ContinuousLegStructure continuousLeg;
    /**
     * Estimation of CO2 emissions.
     * 
     */
    @XmlElement(name = "EmissionCO2")
    protected EmissionCO2Structure emissionCO2;
    /**
     * TRUE if leg got changed by TripChange-Request.
     * 
     */
    @XmlElement(name = "Changed")
    protected Boolean changed;

    /**
     * Id of this leg. Unique within trip result.
     * 
     * @return
     *     possible object is
     *     {@link String }
     *     
     */
    public String getId() {
        return id;
    }

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

    /**
     * [equivalent of PARTICIPANT in SIRI] IT system that is participating in a communication with other participant(s)
     * 
     * @return
     *     possible object is
     *     {@link ParticipantRefStructure }
     *     
     */
    public ParticipantRefStructure getParticipantRef() {
        return participantRef;
    }

    /**
     * Sets the value of the participantRef property.
     * 
     * @param value
     *     allowed object is
     *     {@link ParticipantRefStructure }
     *     
     * @see #getParticipantRef()
     */
    public void setParticipantRef(ParticipantRefStructure value) {
        this.participantRef = value;
    }

    /**
     * The duration of the LEG (e.g., from Transmodel PT RIDE LEG.Duration).
     * 
     * @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;
    }

    /**
     * Corresponds to a RIDE or PT RIDE LEG in TM 6.2 with the attribute Timed (with related information). Passenger LEG with timetabled schedule.
     * 
     * @return
     *     possible object is
     *     {@link TimedLegStructure }
     *     
     */
    public TimedLegStructure getTimedLeg() {
        return timedLeg;
    }

    /**
     * Sets the value of the timedLeg property.
     * 
     * @param value
     *     allowed object is
     *     {@link TimedLegStructure }
     *     
     * @see #getTimedLeg()
     */
    public void setTimedLeg(TimedLegStructure value) {
        this.timedLeg = value;
    }

    /**
     * TRANSFER LEG or CONNECTION LEG according to TM 6.2. Description of a LEG which links other LEGs where a TRANSFER or CONNECTION between different LOCATIONs is required.
     * 
     * @return
     *     possible object is
     *     {@link TransferLegStructure }
     *     
     */
    public TransferLegStructure getTransferLeg() {
        return transferLeg;
    }

    /**
     * Sets the value of the transferLeg property.
     * 
     * @param value
     *     allowed object is
     *     {@link TransferLegStructure }
     *     
     * @see #getTransferLeg()
     */
    public void setTransferLeg(TransferLegStructure value) {
        this.transferLeg = value;
    }

    /**
     * A specialised type of RIDE LEG in with Timed=false, a PERSONAL LEG or an ACCESS LEG TM 6 and NeTEx. LEG of a TRIP that is not bound to a timetable.
     * 
     * @return
     *     possible object is
     *     {@link ContinuousLegStructure }
     *     
     */
    public ContinuousLegStructure getContinuousLeg() {
        return continuousLeg;
    }

    /**
     * Sets the value of the continuousLeg property.
     * 
     * @param value
     *     allowed object is
     *     {@link ContinuousLegStructure }
     *     
     * @see #getContinuousLeg()
     */
    public void setContinuousLeg(ContinuousLegStructure value) {
        this.continuousLeg = value;
    }

    /**
     * Estimation of CO2 emissions.
     * 
     * @return
     *     possible object is
     *     {@link EmissionCO2Structure }
     *     
     */
    public EmissionCO2Structure getEmissionCO2() {
        return emissionCO2;
    }

    /**
     * Sets the value of the emissionCO2 property.
     * 
     * @param value
     *     allowed object is
     *     {@link EmissionCO2Structure }
     *     
     * @see #getEmissionCO2()
     */
    public void setEmissionCO2(EmissionCO2Structure value) {
        this.emissionCO2 = value;
    }

    /**
     * TRUE if leg got changed by TripChange-Request.
     * 
     * @return
     *     possible object is
     *     {@link Boolean }
     *     
     */
    public Boolean isChanged() {
        return changed;
    }

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

    public LegStructure withId(String value) {
        setId(value);
        return this;
    }

    public LegStructure withParticipantRef(ParticipantRefStructure value) {
        setParticipantRef(value);
        return this;
    }

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

    public LegStructure withTimedLeg(TimedLegStructure value) {
        setTimedLeg(value);
        return this;
    }

    public LegStructure withTransferLeg(TransferLegStructure value) {
        setTransferLeg(value);
        return this;
    }

    public LegStructure withContinuousLeg(ContinuousLegStructure value) {
        setContinuousLeg(value);
        return this;
    }

    public LegStructure withEmissionCO2(EmissionCO2Structure value) {
        setEmissionCO2(value);
        return this;
    }

    public LegStructure withChanged(Boolean value) {
        setChanged(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);
    }

}