de.vdv.ojp20.InitialLocationInputStructure 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.util.ArrayList;
import java.util.Collection;
import java.util.List;
import de.vdv.ojp20.siri.LocationStructure;
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.XmlType;
import org.apache.commons.lang3.builder.ToStringBuilder;
import org.opentripplanner.ojp.netex.OmitNullsToStringStyle;


/**
 * Java class for InitialLocationInputStructure complex type.
 * 
 * The following schema fragment specifies the expected content contained within this class.
 * 
 * {@code
 * 
 *   
 *     
 *       
 *         
 *         
 *         
 *         
 *       
 *     
 *   
 * 
 * }
 * 
 * 
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "InitialLocationInputStructure", propOrder = {
    "name",
    "geoPosition",
    "geoRestriction",
    "allowedSystem"
})
public class InitialLocationInputStructure {

    /**
     * Name of the LOCATION object which is looked for. This is usually the user's input. If not given, the name of the resulting location objects is not relevant.
     * 
     */
    @XmlElement(name = "Name")
    protected String name;
    /**
     * Coordinate where to look for locations/places. If given, the result should prefer locations/place objects near to this GeoPosition.
     * 
     */
    @XmlElement(name = "GeoPosition")
    protected LocationStructure geoPosition;
    /**
     * Restricts the resulting location/place objects to the given geographical area.
     * 
     */
    @XmlElement(name = "GeoRestriction")
    protected GeoRestrictionsStructure geoRestriction;
    /**
     * Used in distributed environments. e.g., EU-Spirit. If none is given, the location/place information request refers to all known systems (in EU-Spirit "passive servers"). If at least one is given, the location/place information request refers only to the given systems (in EU-Spirit "passive servers"). In EU-Spirit the system IDs were previously called "provider code". See https://eu-spirit.eu/
     * 
     */
    @XmlElement(name = "AllowedSystem")
    protected List allowedSystem;

    /**
     * Name of the LOCATION object which is looked for. This is usually the user's input. If not given, the name of the resulting location objects is not relevant.
     * 
     * @return
     *     possible object is
     *     {@link String }
     *     
     */
    public String getName() {
        return name;
    }

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

    /**
     * Coordinate where to look for locations/places. If given, the result should prefer locations/place objects near to this GeoPosition.
     * 
     * @return
     *     possible object is
     *     {@link LocationStructure }
     *     
     */
    public LocationStructure getGeoPosition() {
        return geoPosition;
    }

    /**
     * Sets the value of the geoPosition property.
     * 
     * @param value
     *     allowed object is
     *     {@link LocationStructure }
     *     
     * @see #getGeoPosition()
     */
    public void setGeoPosition(LocationStructure value) {
        this.geoPosition = value;
    }

    /**
     * Restricts the resulting location/place objects to the given geographical area.
     * 
     * @return
     *     possible object is
     *     {@link GeoRestrictionsStructure }
     *     
     */
    public GeoRestrictionsStructure getGeoRestriction() {
        return geoRestriction;
    }

    /**
     * Sets the value of the geoRestriction property.
     * 
     * @param value
     *     allowed object is
     *     {@link GeoRestrictionsStructure }
     *     
     * @see #getGeoRestriction()
     */
    public void setGeoRestriction(GeoRestrictionsStructure value) {
        this.geoRestriction = value;
    }

    /**
     * Used in distributed environments. e.g., EU-Spirit. If none is given, the location/place information request refers to all known systems (in EU-Spirit "passive servers"). If at least one is given, the location/place information request refers only to the given systems (in EU-Spirit "passive servers"). In EU-Spirit the system IDs were previously called "provider code". See https://eu-spirit.eu/
     * 
     * Gets the value of the allowedSystem 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 allowedSystem property.
     * 
     * 
     * For example, to add a new item, do as follows:
     * 
     *      * getAllowedSystem().add(newItem);
     * 
     * 
     * 
     * 
     * Objects of the following type(s) are allowed in the list
     * {@link ParticipantRefStructure }
     * 
     * 
     * 
     * @return
     *     The value of the allowedSystem property.
     */
    public List getAllowedSystem() {
        if (allowedSystem == null) {
            allowedSystem = new ArrayList<>();
        }
        return this.allowedSystem;
    }

    public InitialLocationInputStructure withName(String value) {
        setName(value);
        return this;
    }

    public InitialLocationInputStructure withGeoPosition(LocationStructure value) {
        setGeoPosition(value);
        return this;
    }

    public InitialLocationInputStructure withGeoRestriction(GeoRestrictionsStructure value) {
        setGeoRestriction(value);
        return this;
    }

    public InitialLocationInputStructure withAllowedSystem(ParticipantRefStructure... values) {
        if (values!= null) {
            for (ParticipantRefStructure value: values) {
                getAllowedSystem().add(value);
            }
        }
        return this;
    }

    public InitialLocationInputStructure withAllowedSystem(Collection values) {
        if (values!= null) {
            getAllowedSystem().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);
    }

}