de.vdv.ojp20.TransferLegStructure 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 de.vdv.ojp20.siri.InterchangeRefStructure;
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;


/**
 * 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.
 * 
 * Java class for TransferLegStructure complex type.
 * 
 * The following schema fragment specifies the expected content contained within this class.
 * 
 * {@code
 * 
 *   
 *     
 *       
 *         
 *         
 *         
 *         
 *         
 *         
 *         
 *         
 *         
 *         
 *         
 *         
 *         
 *       
 *     
 *   
 * 
 * }
 * 
 * 
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "TransferLegStructure", propOrder = {
    "transferType",
    "legStart",
    "legEnd",
    "timeWindowStart",
    "timeWindowEnd",
    "duration",
    "walkDuration",
    "bufferTime",
    "interchangeRef",
    "extraInterchange",
    "interchangeCancellation",
    "staySeated",
    "guaranteed",
    "advertised",
    "legDescription",
    "length",
    "attribute",
    "pathGuidance",
    "feasibility",
    "situationFullRefs",
    "extension"
})
public class TransferLegStructure {

    /**
     * TYPE that is used for this interchange between public services (TYPE OF TRANSFER, but also ACCESS MODE and PERSONAL MODE as far as a TRANSFER is concerned). In some constellations multiple TransferType are possible.
     * 
     */
    @XmlElement(name = "TransferType", required = true)
    @XmlSchemaType(name = "string")
    protected List transferType;
    /**
     * Stop/Station/Place where boarding is done (can be a PLACE, SCHEDULED STOP POINT or a VEHICLE MEETING POINT)
     * 
     */
    @XmlElement(name = "LegStart", required = true)
    protected PlaceRefStructure legStart;
    /**
     * Stop/Station/Place to alight (can be a PLACE, SCHEDULED STOP POINT or a VEHICLE MEETING POINT).
     * 
     */
    @XmlElement(name = "LegEnd", required = true)
    protected PlaceRefStructure legEnd;
    /**
     * Time at which window begins.
     * 
     */
    @XmlElement(name = "TimeWindowStart", type = String.class)
    @XmlJavaTypeAdapter(XmlDateTimeAdapter.class)
    @XmlSchemaType(name = "dateTime")
    protected XmlDateTime timeWindowStart;
    /**
     * Time at which window ends.
     * 
     */
    @XmlElement(name = "TimeWindowEnd", type = String.class)
    @XmlJavaTypeAdapter(XmlDateTimeAdapter.class)
    @XmlSchemaType(name = "dateTime")
    protected XmlDateTime timeWindowEnd;
    /**
     * Overall duration of this interchange (Transmodel: PT CONNECTION LEG.MEAN INTERCHANGE TIME).
     * 
     */
    @XmlElement(name = "Duration", required = true, type = String.class)
    @XmlJavaTypeAdapter(DurationXmlAdapter.class)
    @XmlSchemaType(name = "duration")
    protected Duration duration;
    /**
     * Walk time as part of the overall interchange duration (in Transmodel might be modelled as TRANSFER.CONNECTION.DefaultDuration).
     * 
     */
    @XmlElement(name = "WalkDuration", type = String.class)
    @XmlJavaTypeAdapter(DurationXmlAdapter.class)
    @XmlSchemaType(name = "duration")
    protected Duration walkDuration;
    /**
     * Buffer time as part of the overall interchange duration. Buffer times, e.g., check in/out times, sometimes are mandatory for using certain services as e.g., airplanes, ferries or highspeed trains.
     * 
     */
    @XmlElement(name = "BufferTime", type = String.class)
    @XmlJavaTypeAdapter(DurationXmlAdapter.class)
    @XmlSchemaType(name = "duration")
    protected Duration bufferTime;
    /**
     * Reference of an INTERCHANGE.
     * 
     */
    @XmlElement(name = "InterchangeRef")
    protected InterchangeRefStructure interchangeRef;
    /**
     * Whether this interchange is an addition to the plan. Can only be used when both participants recognise the same schedule version. If omitted, defaults to 'false': the interchange is not an addition. (since SIRI 2.1)
     * 
     */
    @XmlElement(name = "ExtraInterchange")
    protected Boolean extraInterchange;
    /**
     * Whether this interchange is a cancellation of a previously announced interchange (or planned according to the long-term timetable. 
     * Can only be used when both participants recognise the same schedule version. If omitted, defaults to 'false': the interchange is not cancelled. (since SIRI 2.1)
     * 
     */
    @XmlElement(name = "InterchangeCancellation")
    protected Boolean interchangeCancellation;
    @XmlElement(name = "StaySeated", namespace = "http://www.siri.org.uk/siri", defaultValue = "false")
    protected Boolean staySeated;
    @XmlElement(name = "Guaranteed", namespace = "http://www.siri.org.uk/siri", defaultValue = "false")
    protected Boolean guaranteed;
    @XmlElement(name = "Advertised", namespace = "http://www.siri.org.uk/siri", defaultValue = "false")
    protected Boolean advertised;
    /**
     * Text that describes this interchange.
     * 
     */
    @XmlElement(name = "LegDescription")
    protected InternationalTextStructure legDescription;
    /**
     * Length of this interchange path.
     * 
     */
    @XmlElement(name = "Length")
    @XmlSchemaType(name = "nonNegativeInteger")
    protected BigInteger length;
    /**
     * Note or service attribute.
     * 
     */
    @XmlElement(name = "Attribute")
    protected List attribute;
    /**
     * Structured model further describing this interchange, its geographic embedding and accessibility (LEG.PATH GUIDANCE).
     * 
     */
    @XmlElement(name = "PathGuidance")
    protected PathGuidanceStructure pathGuidance;
    /**
     * Information about the feasibility of the TransferLeg, 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;

    /**
     * TYPE that is used for this interchange between public services (TYPE OF TRANSFER, but also ACCESS MODE and PERSONAL MODE as far as a TRANSFER is concerned). In some constellations multiple TransferType are possible.
     * 
     * Gets the value of the transferType 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 transferType property.
     * 
     * 
     * For example, to add a new item, do as follows:
     * 
     *      * getTransferType().add(newItem);
     * 
     * 
     * 
     * 
     * Objects of the following type(s) are allowed in the list
     * {@link TransferTypeEnumeration }
     * 
     * 
     * 
     * @return
     *     The value of the transferType property.
     */
    public List getTransferType() {
        if (transferType == null) {
            transferType = new ArrayList<>();
        }
        return this.transferType;
    }

    /**
     * Stop/Station/Place where boarding is done (can be a PLACE, SCHEDULED STOP POINT or a VEHICLE MEETING POINT)
     * 
     * @return
     *     possible object is
     *     {@link PlaceRefStructure }
     *     
     */
    public PlaceRefStructure getLegStart() {
        return legStart;
    }

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

    /**
     * Stop/Station/Place to alight (can be a PLACE, SCHEDULED STOP POINT or a VEHICLE MEETING POINT).
     * 
     * @return
     *     possible object is
     *     {@link PlaceRefStructure }
     *     
     */
    public PlaceRefStructure getLegEnd() {
        return legEnd;
    }

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

    /**
     * Time at which window begins.
     * 
     * @return
     *     possible object is
     *     {@link String }
     *     
     */
    public XmlDateTime getTimeWindowStart() {
        return timeWindowStart;
    }

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

    /**
     * Time at which window ends.
     * 
     * @return
     *     possible object is
     *     {@link String }
     *     
     */
    public XmlDateTime getTimeWindowEnd() {
        return timeWindowEnd;
    }

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

    /**
     * Overall duration of this interchange (Transmodel: PT CONNECTION LEG.MEAN INTERCHANGE TIME).
     * 
     * @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;
    }

    /**
     * Walk time as part of the overall interchange duration (in Transmodel might be modelled as TRANSFER.CONNECTION.DefaultDuration).
     * 
     * @return
     *     possible object is
     *     {@link String }
     *     
     */
    public Duration getWalkDuration() {
        return walkDuration;
    }

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

    /**
     * Buffer time as part of the overall interchange duration. Buffer times, e.g., check in/out times, sometimes are mandatory for using certain services as e.g., airplanes, ferries or highspeed trains.
     * 
     * @return
     *     possible object is
     *     {@link String }
     *     
     */
    public Duration getBufferTime() {
        return bufferTime;
    }

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

    /**
     * Reference of an INTERCHANGE.
     * 
     * @return
     *     possible object is
     *     {@link InterchangeRefStructure }
     *     
     */
    public InterchangeRefStructure getInterchangeRef() {
        return interchangeRef;
    }

    /**
     * Sets the value of the interchangeRef property.
     * 
     * @param value
     *     allowed object is
     *     {@link InterchangeRefStructure }
     *     
     * @see #getInterchangeRef()
     */
    public void setInterchangeRef(InterchangeRefStructure value) {
        this.interchangeRef = value;
    }

    /**
     * Whether this interchange is an addition to the plan. Can only be used when both participants recognise the same schedule version. If omitted, defaults to 'false': the interchange is not an addition. (since SIRI 2.1)
     * 
     * @return
     *     possible object is
     *     {@link Boolean }
     *     
     */
    public Boolean isExtraInterchange() {
        return extraInterchange;
    }

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

    /**
     * Whether this interchange is a cancellation of a previously announced interchange (or planned according to the long-term timetable. 
     * Can only be used when both participants recognise the same schedule version. If omitted, defaults to 'false': the interchange is not cancelled. (since SIRI 2.1)
     * 
     * @return
     *     possible object is
     *     {@link Boolean }
     *     
     */
    public Boolean isInterchangeCancellation() {
        return interchangeCancellation;
    }

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

    /**
     * Gets the value of the staySeated property.
     * 
     * @return
     *     possible object is
     *     {@link Boolean }
     *     
     */
    public Boolean isStaySeated() {
        return staySeated;
    }

    /**
     * Sets the value of the staySeated property.
     * 
     * @param value
     *     allowed object is
     *     {@link Boolean }
     *     
     */
    public void setStaySeated(Boolean value) {
        this.staySeated = value;
    }

    /**
     * Gets the value of the guaranteed property.
     * 
     * @return
     *     possible object is
     *     {@link Boolean }
     *     
     */
    public Boolean isGuaranteed() {
        return guaranteed;
    }

    /**
     * Sets the value of the guaranteed property.
     * 
     * @param value
     *     allowed object is
     *     {@link Boolean }
     *     
     */
    public void setGuaranteed(Boolean value) {
        this.guaranteed = value;
    }

    /**
     * Gets the value of the advertised property.
     * 
     * @return
     *     possible object is
     *     {@link Boolean }
     *     
     */
    public Boolean isAdvertised() {
        return advertised;
    }

    /**
     * Sets the value of the advertised property.
     * 
     * @param value
     *     allowed object is
     *     {@link Boolean }
     *     
     */
    public void setAdvertised(Boolean value) {
        this.advertised = value;
    }

    /**
     * Text that describes this interchange.
     * 
     * @return
     *     possible object is
     *     {@link InternationalTextStructure }
     *     
     */
    public InternationalTextStructure getLegDescription() {
        return legDescription;
    }

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

    /**
     * Length of this interchange path.
     * 
     * @return
     *     possible object is
     *     {@link BigInteger }
     *     
     */
    public BigInteger getLength() {
        return length;
    }

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

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

    /**
     * Structured model further describing this interchange, its geographic embedding and accessibility (LEG.PATH GUIDANCE).
     * 
     * @return
     *     possible object is
     *     {@link PathGuidanceStructure }
     *     
     */
    public PathGuidanceStructure getPathGuidance() {
        return pathGuidance;
    }

    /**
     * Sets the value of the pathGuidance property.
     * 
     * @param value
     *     allowed object is
     *     {@link PathGuidanceStructure }
     *     
     * @see #getPathGuidance()
     */
    public void setPathGuidance(PathGuidanceStructure value) {
        this.pathGuidance = value;
    }

    /**
     * Information about the feasibility of the TransferLeg, 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 TransferLegStructure withTransferType(TransferTypeEnumeration... values) {
        if (values!= null) {
            for (TransferTypeEnumeration value: values) {
                getTransferType().add(value);
            }
        }
        return this;
    }

    public TransferLegStructure withTransferType(Collection values) {
        if (values!= null) {
            getTransferType().addAll(values);
        }
        return this;
    }

    public TransferLegStructure withLegStart(PlaceRefStructure value) {
        setLegStart(value);
        return this;
    }

    public TransferLegStructure withLegEnd(PlaceRefStructure value) {
        setLegEnd(value);
        return this;
    }

    public TransferLegStructure withTimeWindowStart(XmlDateTime value) {
        setTimeWindowStart(value);
        return this;
    }

    public TransferLegStructure withTimeWindowEnd(XmlDateTime value) {
        setTimeWindowEnd(value);
        return this;
    }

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

    public TransferLegStructure withWalkDuration(Duration value) {
        setWalkDuration(value);
        return this;
    }

    public TransferLegStructure withBufferTime(Duration value) {
        setBufferTime(value);
        return this;
    }

    public TransferLegStructure withInterchangeRef(InterchangeRefStructure value) {
        setInterchangeRef(value);
        return this;
    }

    public TransferLegStructure withExtraInterchange(Boolean value) {
        setExtraInterchange(value);
        return this;
    }

    public TransferLegStructure withInterchangeCancellation(Boolean value) {
        setInterchangeCancellation(value);
        return this;
    }

    public TransferLegStructure withStaySeated(Boolean value) {
        setStaySeated(value);
        return this;
    }

    public TransferLegStructure withGuaranteed(Boolean value) {
        setGuaranteed(value);
        return this;
    }

    public TransferLegStructure withAdvertised(Boolean value) {
        setAdvertised(value);
        return this;
    }

    public TransferLegStructure withLegDescription(InternationalTextStructure value) {
        setLegDescription(value);
        return this;
    }

    public TransferLegStructure withLength(BigInteger value) {
        setLength(value);
        return this;
    }

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

    public TransferLegStructure withAttribute(Collection values) {
        if (values!= null) {
            getAttribute().addAll(values);
        }
        return this;
    }

    public TransferLegStructure withPathGuidance(PathGuidanceStructure value) {
        setPathGuidance(value);
        return this;
    }

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

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

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

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

}