de.vdv.ojp20.PlaceRefStructure 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.StopPointRefStructure;
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;


/**
 * Reference to a geographic PLACE of any type which may be specified as the origin or destination of a trip.
 * 
 * Java class for PlaceRefStructure complex type.
 * 
 * The following schema fragment specifies the expected content contained within this class.
 * 
 * {@code
 * 
 *   
 *     
 *       
 *         
 *       
 *     
 *   
 * 
 * }
 * 
 * 
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "PlaceRefStructure", propOrder = {
    "stopPointRef",
    "stopPlaceRef",
    "geoPosition",
    "topographicPlaceRef",
    "pointOfInterestRef",
    "addressRef",
    "name",
    "allowedSystemId"
})
public class PlaceRefStructure {

    /**
     * Reference to a stop point.
     * 
     */
    @XmlElement(name = "StopPointRef", namespace = "http://www.siri.org.uk/siri")
    protected StopPointRefStructure stopPointRef;
    /**
     * Reference to a Stop Place
     * 
     */
    @XmlElement(name = "StopPlaceRef")
    protected StopPlaceRefStructure stopPlaceRef;
    /**
     * WGS84 coordinates position.
     * 
     */
    @XmlElement(name = "GeoPosition")
    protected LocationStructure geoPosition;
    /**
     * Reference to a TopographicPlace
     * 
     */
    @XmlElement(name = "TopographicPlaceRef")
    protected TopographicPlaceRefStructure topographicPlaceRef;
    /**
     * Reference to a Point of Interest
     * 
     */
    @XmlElement(name = "PointOfInterestRef")
    protected PointOfInterestRefStructure pointOfInterestRef;
    /**
     * Reference to an Address
     * 
     */
    @XmlElement(name = "AddressRef")
    protected AddressRefStructure addressRef;
    /**
     * Public name of the place.
     * 
     */
    @XmlElement(name = "Name", required = true)
    protected InternationalTextStructure name;
    /**
     * Used in distributed environments. e.g., EU-Spirit. If none is given, the place information request refers to all known systems (in EU-Spirit "passive servers"). If at least one is given, the 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 = "AllowedSystemId")
    @XmlJavaTypeAdapter(NormalizedStringAdapter.class)
    @XmlSchemaType(name = "normalizedString")
    protected List allowedSystemId;

    /**
     * Reference to a stop point.
     * 
     * @return
     *     possible object is
     *     {@link StopPointRefStructure }
     *     
     */
    public StopPointRefStructure getStopPointRef() {
        return stopPointRef;
    }

    /**
     * Sets the value of the stopPointRef property.
     * 
     * @param value
     *     allowed object is
     *     {@link StopPointRefStructure }
     *     
     * @see #getStopPointRef()
     */
    public void setStopPointRef(StopPointRefStructure value) {
        this.stopPointRef = value;
    }

    /**
     * Reference to a Stop Place
     * 
     * @return
     *     possible object is
     *     {@link StopPlaceRefStructure }
     *     
     */
    public StopPlaceRefStructure getStopPlaceRef() {
        return stopPlaceRef;
    }

    /**
     * Sets the value of the stopPlaceRef property.
     * 
     * @param value
     *     allowed object is
     *     {@link StopPlaceRefStructure }
     *     
     * @see #getStopPlaceRef()
     */
    public void setStopPlaceRef(StopPlaceRefStructure value) {
        this.stopPlaceRef = value;
    }

    /**
     * WGS84 coordinates position.
     * 
     * @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;
    }

    /**
     * Reference to a TopographicPlace
     * 
     * @return
     *     possible object is
     *     {@link TopographicPlaceRefStructure }
     *     
     */
    public TopographicPlaceRefStructure getTopographicPlaceRef() {
        return topographicPlaceRef;
    }

    /**
     * Sets the value of the topographicPlaceRef property.
     * 
     * @param value
     *     allowed object is
     *     {@link TopographicPlaceRefStructure }
     *     
     * @see #getTopographicPlaceRef()
     */
    public void setTopographicPlaceRef(TopographicPlaceRefStructure value) {
        this.topographicPlaceRef = value;
    }

    /**
     * Reference to a Point of Interest
     * 
     * @return
     *     possible object is
     *     {@link PointOfInterestRefStructure }
     *     
     */
    public PointOfInterestRefStructure getPointOfInterestRef() {
        return pointOfInterestRef;
    }

    /**
     * Sets the value of the pointOfInterestRef property.
     * 
     * @param value
     *     allowed object is
     *     {@link PointOfInterestRefStructure }
     *     
     * @see #getPointOfInterestRef()
     */
    public void setPointOfInterestRef(PointOfInterestRefStructure value) {
        this.pointOfInterestRef = value;
    }

    /**
     * Reference to an Address
     * 
     * @return
     *     possible object is
     *     {@link AddressRefStructure }
     *     
     */
    public AddressRefStructure getAddressRef() {
        return addressRef;
    }

    /**
     * Sets the value of the addressRef property.
     * 
     * @param value
     *     allowed object is
     *     {@link AddressRefStructure }
     *     
     * @see #getAddressRef()
     */
    public void setAddressRef(AddressRefStructure value) {
        this.addressRef = value;
    }

    /**
     * Public name of the place.
     * 
     * @return
     *     possible object is
     *     {@link InternationalTextStructure }
     *     
     */
    public InternationalTextStructure getName() {
        return name;
    }

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

    /**
     * Used in distributed environments. e.g., EU-Spirit. If none is given, the place information request refers to all known systems (in EU-Spirit "passive servers"). If at least one is given, the 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 allowedSystemId 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 allowedSystemId property.
     * 
     * 
     * For example, to add a new item, do as follows:
     * 
     *      * getAllowedSystemId().add(newItem);
     * 
     * 
     * 
     * 
     * Objects of the following type(s) are allowed in the list
     * {@link String }
     * 
     * 
     * 
     * @return
     *     The value of the allowedSystemId property.
     */
    public List getAllowedSystemId() {
        if (allowedSystemId == null) {
            allowedSystemId = new ArrayList<>();
        }
        return this.allowedSystemId;
    }

    public PlaceRefStructure withStopPointRef(StopPointRefStructure value) {
        setStopPointRef(value);
        return this;
    }

    public PlaceRefStructure withStopPlaceRef(StopPlaceRefStructure value) {
        setStopPlaceRef(value);
        return this;
    }

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

    public PlaceRefStructure withTopographicPlaceRef(TopographicPlaceRefStructure value) {
        setTopographicPlaceRef(value);
        return this;
    }

    public PlaceRefStructure withPointOfInterestRef(PointOfInterestRefStructure value) {
        setPointOfInterestRef(value);
        return this;
    }

    public PlaceRefStructure withAddressRef(AddressRefStructure value) {
        setAddressRef(value);
        return this;
    }

    public PlaceRefStructure withName(InternationalTextStructure value) {
        setName(value);
        return this;
    }

    public PlaceRefStructure withAllowedSystemId(String... values) {
        if (values!= null) {
            for (String value: values) {
                getAllowedSystemId().add(value);
            }
        }
        return this;
    }

    public PlaceRefStructure withAllowedSystemId(Collection values) {
        if (values!= null) {
            getAllowedSystemId().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);
    }

}