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


/**
 * [TMv6] A type of PLACE providing the topographical context when searching for or presenting travel information, for example as the origin or destination of a trip. It may be of any size (e.g., County,City, Town, Village) and of different specificity (e.g., Greater London, London, West End, Westminster, St James's).
 * 
 * Java class for TopographicPlaceStructure complex type.
 * 
 * The following schema fragment specifies the expected content contained within this class.
 * 
 * {@code
 * 
 *   
 *     
 *       
 *         
 *         
 *         
 *         
 *         
 *         
 *       
 *     
 *   
 * 
 * }
 * 
 * 
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "TopographicPlaceStructure", propOrder = {
    "topographicPlaceCode",
    "topographicPlaceName",
    "privateCode",
    "parentRef",
    "referredSystem",
    "area"
})
public class TopographicPlaceStructure {

    /**
     * TopographicPlace ID.
     * 
     */
    @XmlElement(name = "TopographicPlaceCode", required = true)
    @XmlJavaTypeAdapter(NormalizedStringAdapter.class)
    @XmlSchemaType(name = "normalizedString")
    protected String topographicPlaceCode;
    /**
     * Name or description of TopographicPlace for use in passenger information.
     * 
     */
    @XmlElement(name = "TopographicPlaceName", required = true)
    protected InternationalTextStructure topographicPlaceName;
    /**
     * Code of this TopographicPlace in private/foreign/proprietary coding schemes.
     * 
     */
    @XmlElement(name = "PrivateCode")
    protected List privateCode;
    /**
     * Reference to a parent TopographicPlace.
     * 
     */
    @XmlElement(name = "ParentRef")
    protected TopographicPlaceRefStructure parentRef;
    /**
     * Used in distributed environments (e.g., EU-Spirit). If set, this topographic place resides within the given system (in EU-Spirit "passive server"). This system can be queried for actual places within this topographic place. This is used in a distributed environment for a two-steps place identification. In EU-Spirit the system IDs were previously called "provider code". See https://eu-spirit.eu/
     * 
     */
    @XmlElement(name = "ReferredSystem")
    protected ParticipantRefStructure referredSystem;
    /**
     * Area covered by the locality described as a polygon.
     * 
     */
    @XmlElement(name = "Area")
    protected AreaStructure area;

    /**
     * TopographicPlace ID.
     * 
     * @return
     *     possible object is
     *     {@link String }
     *     
     */
    public String getTopographicPlaceCode() {
        return topographicPlaceCode;
    }

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

    /**
     * Name or description of TopographicPlace for use in passenger information.
     * 
     * @return
     *     possible object is
     *     {@link InternationalTextStructure }
     *     
     */
    public InternationalTextStructure getTopographicPlaceName() {
        return topographicPlaceName;
    }

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

    /**
     * Code of this TopographicPlace in private/foreign/proprietary coding schemes.
     * 
     * Gets the value of the privateCode 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 privateCode property.
     * 
     * 
     * For example, to add a new item, do as follows:
     * 
     *      * getPrivateCode().add(newItem);
     * 
     * 
     * 
     * 
     * Objects of the following type(s) are allowed in the list
     * {@link PrivateCodeStructure }
     * 
     * 
     * 
     * @return
     *     The value of the privateCode property.
     */
    public List getPrivateCode() {
        if (privateCode == null) {
            privateCode = new ArrayList<>();
        }
        return this.privateCode;
    }

    /**
     * Reference to a parent TopographicPlace.
     * 
     * @return
     *     possible object is
     *     {@link TopographicPlaceRefStructure }
     *     
     */
    public TopographicPlaceRefStructure getParentRef() {
        return parentRef;
    }

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

    /**
     * Used in distributed environments (e.g., EU-Spirit). If set, this topographic place resides within the given system (in EU-Spirit "passive server"). This system can be queried for actual places within this topographic place. This is used in a distributed environment for a two-steps place identification. In EU-Spirit the system IDs were previously called "provider code". See https://eu-spirit.eu/
     * 
     * @return
     *     possible object is
     *     {@link ParticipantRefStructure }
     *     
     */
    public ParticipantRefStructure getReferredSystem() {
        return referredSystem;
    }

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

    /**
     * Area covered by the locality described as a polygon.
     * 
     * @return
     *     possible object is
     *     {@link AreaStructure }
     *     
     */
    public AreaStructure getArea() {
        return area;
    }

    /**
     * Sets the value of the area property.
     * 
     * @param value
     *     allowed object is
     *     {@link AreaStructure }
     *     
     * @see #getArea()
     */
    public void setArea(AreaStructure value) {
        this.area = value;
    }

    public TopographicPlaceStructure withTopographicPlaceCode(String value) {
        setTopographicPlaceCode(value);
        return this;
    }

    public TopographicPlaceStructure withTopographicPlaceName(InternationalTextStructure value) {
        setTopographicPlaceName(value);
        return this;
    }

    public TopographicPlaceStructure withPrivateCode(PrivateCodeStructure... values) {
        if (values!= null) {
            for (PrivateCodeStructure value: values) {
                getPrivateCode().add(value);
            }
        }
        return this;
    }

    public TopographicPlaceStructure withPrivateCode(Collection values) {
        if (values!= null) {
            getPrivateCode().addAll(values);
        }
        return this;
    }

    public TopographicPlaceStructure withParentRef(TopographicPlaceRefStructure value) {
        setParentRef(value);
        return this;
    }

    public TopographicPlaceStructure withReferredSystem(ParticipantRefStructure value) {
        setReferredSystem(value);
        return this;
    }

    public TopographicPlaceStructure withArea(AreaStructure value) {
        setArea(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);
    }

}