All Downloads are FREE. Search and download functionalities are using the official Maven repository.

de.micromata.opengis.kml.v_2_2_0.Data Maven / Gradle / Ivy

Go to download

This is JavaAPIforKMml, Micromata's library for use with applications that want to parse, generate and operate on KML. It is an implementation of the OGC KML 2.2 standard. It is written entirely in Java and makes heavy use of JAXB.

There is a newer version: 3.0.4
Show newest version

package de.micromata.opengis.kml.v_2_2_0;

import de.micromata.opengis.kml.v_2_2_0.annotations.Obvious;
import jakarta.xml.bind.annotation.*;

import java.util.ArrayList;
import java.util.List;


/**
 * {@code }
 * 

 * Creates an untyped name/value pair. The name can have two versions: name and displayName. 
 * The name attribute is used to identify the data pair within the KML file. The displayName 
 * element is used when a properly formatted name, with spaces and HTML formatting, 
 * is displayed in Google Earth. In the {@code } element of {@code }, the notation
 * $[name:displayName] is replaced with {@code }. If you substitute the value
 * of the name attribute of the {@code } element in this format (for example, $[holeYardage],
 * the attribute value is replaced with {@code }. By default, the Placemark's balloon
 * displays the name/value pairs associated with it. 
 * 

 * 
 * 
 * 
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "DataType", propOrder = {
    "displayName",
    "value",
    "dataExtension"
})
@XmlRootElement(name = "Data", namespace = "http://www.opengis.net/kml/2.2")
public class Data
    extends AbstractObject
    implements Cloneable
{

    /**
     * {@code }
     * 

     * An optional formatted version of name, to be used for display purposes. 
     * 

     * 
     * 
     * 
     */
    protected String displayName;
    /**
     * {@code }
     * 

     * {@code  Club house   1
     *   234   
     * 4    }
     * 

     * 

     * {@code  An optional formatted version of name, to be used for display purposes.
     *  Value of the data pair.  Club house  
     *  1   234 
     *   4    }
     * 

     * 

     * Value of the data pair. 
     * 

     * 
     * 
     * 
     */
    @XmlElement(required = true)
    protected String value;
    @XmlElement(name = "DataExtension")
    protected List dataExtension;
    /**
     * {@code }
     * 

     * User-defined text displayed in the 3D viewer as the label for the object (for example, 
     * for a Placemark, Folder, or NetworkLink). 
     * 

     * 
     * 
     * 
     */
    @XmlAttribute(name = "name")
    protected String name;

    /**
     * Value constructor with only mandatory fields
     * 
     * @param value
     *     required parameter
     */
    public Data(final String value) {
        super();
        this.value = value;
    }

    /**
     * Default no-arg constructor is private. Use overloaded constructor instead! (Temporary solution, till a better and more suitable ObjectFactory is created.) 
     * 
     */
    @Deprecated
    private Data() {
        super();
    }

    /**
     *
     * 
     * @return
     *     possible object is
     *     {@link String}
     *     
     */
    public String getDisplayName() {
        return displayName;
    }

    /**
     *
     * 
     * @param value
     *     allowed object is
     *     {@link String}
     *     
     */
    public void setDisplayName(String value) {
        this.displayName = value;
    }

    /**
     *
     * 
     * @return
     *     possible object is
     *     {@link String}
     *     
     */
    public String getValue() {
        return value;
    }

    /**
     *
     * 
     * @param value
     *     allowed object is
     *     {@link String}
     *     
     */
    public void setValue(String value) {
        this.value = value;
    }

    /**
     *
     * 
     */
    public List getDataExtension() {
        if (dataExtension == null) {
            dataExtension = new ArrayList();
        }
        return this.dataExtension;
    }

    /**
     *
     * 
     * @return
     *     possible object is
     *     {@link String}
     *     
     */
    public String getName() {
        return name;
    }

    /**
     *
     * 
     * @param value
     *     allowed object is
     *     {@link String}
     *     
     */
    public void setName(String value) {
        this.name = value;
    }

    @Override
    public int hashCode() {
        final int prime = 31;
        int result = super.hashCode();
        result = ((prime*result)+((displayName == null)? 0 :displayName.hashCode()));
        result = ((prime*result)+((value == null)? 0 :value.hashCode()));
        result = ((prime*result)+((dataExtension == null)? 0 :dataExtension.hashCode()));
        result = ((prime*result)+((name == null)? 0 :name.hashCode()));
        return result;
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj == null) {
            return false;
        }
        if (super.equals(obj) == false) {
            return false;
        }
        if ((obj instanceof Data) == false) {
            return false;
        }
        Data other = ((Data) obj);
        if (displayName == null) {
            if (other.displayName!= null) {
                return false;
            }
        } else {
            if (displayName.equals(other.displayName) == false) {
                return false;
            }
        }
        if (value == null) {
            if (other.value!= null) {
                return false;
            }
        } else {
            if (value.equals(other.value) == false) {
                return false;
            }
        }
        if (dataExtension == null) {
            if (other.dataExtension!= null) {
                return false;
            }
        } else {
            if (dataExtension.equals(other.dataExtension) == false) {
                return false;
            }
        }
        if (name == null) {
            if (other.name!= null) {
                return false;
            }
        } else {
            if (name.equals(other.name) == false) {
                return false;
            }
        }
        return true;
    }

    /**
     *
     * 
     * @param dataExtension
     *     Objects of the following type are allowed in the list: {@link Object}
     */
    public void setDataExtension(final List dataExtension) {
        this.dataExtension = dataExtension;
    }

    /**
     * add a value to the dataExtension property collection
     * 
     * @param dataExtension
     *     Objects of the following type are allowed in the list: {@link Object}
     * @return
     *     true (as general contract of Collection.add). 
     */
    public Data addToDataExtension(final Object dataExtension) {
        this.getDataExtension().add(dataExtension);
        return this;
    }

    /**
     *
     * 
     */
    @Obvious
    @Override
    public void setObjectSimpleExtension(final List objectSimpleExtension) {
        super.setObjectSimpleExtension(objectSimpleExtension);
    }

    @Obvious
    @Override
    public Data addToObjectSimpleExtension(final Object objectSimpleExtension) {
        super.getObjectSimpleExtension().add(objectSimpleExtension);
        return this;
    }

    /**
     * fluent setter
     *
     * 
     * @param displayName
     *     required parameter
     */
    public Data withDisplayName(final String displayName) {
        this.setDisplayName(displayName);
        return this;
    }

    /**
     * fluent setter
     *
     * 
     * @param dataExtension
     *     required parameter
     */
    public Data withDataExtension(final List dataExtension) {
        this.setDataExtension(dataExtension);
        return this;
    }

    /**
     * fluent setter
     *
     * 
     * @param name
     *     required parameter
     */
    public Data withName(final String name) {
        this.setName(name);
        return this;
    }

    @Obvious
    @Override
    public Data withObjectSimpleExtension(final List objectSimpleExtension) {
        super.withObjectSimpleExtension(objectSimpleExtension);
        return this;
    }

    @Obvious
    @Override
    public Data withId(final String id) {
        super.withId(id);
        return this;
    }

    @Obvious
    @Override
    public Data withTargetId(final String targetId) {
        super.withTargetId(targetId);
        return this;
    }

    @Override
    public Data clone() {
        Data copy;
        copy = ((Data) super.clone());
        copy.dataExtension = new ArrayList((getDataExtension().size()));
        for (Object iter: dataExtension) {
            copy.dataExtension.add(iter);
        }
        return copy;
    }

}
 















© 2015 - 2024 Weber Informatics LLC | Privacy Policy