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

de.micromata.opengis.kml.v_2_2_0.SchemaData 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 de.micromata.opengis.kml.v_2_2_0.gx.SimpleArrayData;
import jakarta.xml.bind.annotation.*;

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


/**
 * {@code }
 * 

 * The {@code } can be a full URL, a reference to a Schema ID defined in an external
 * KML file, or a reference to a Schema ID defined in the same KML file. All of the 
 * following specifications are acceptable: 
 * 

 * 

 * The Schema element is always a child of Document. The ExtendedData element is a 
 * child of the Feature that contains the custom data. 
 * 

 * 

 * This element is used in conjunction with {@code } to add typed custom data to a 
 * KML Feature. The Schema element (identified by the schemaUrl attribute) declares 
 * the custom data type. The actual data objects ("instances" of the custom data) are 
 * defined using the SchemaData element. 
 * 

 * 
 * 
 * 
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "SchemaDataType", propOrder = {
    "simpleData",
    "schemaDataExtension"
})
@XmlRootElement(name = "SchemaData", namespace = "http://www.opengis.net/kml/2.2")
public class SchemaData
    extends AbstractObject
    implements Cloneable
{

    /**
     * {@code }
     * 

     * {@code } This element assigns a value to the custom data field
     * identified by the name attribute. The type and name of this custom data field are 
     * declared in the {@code } element. Here is an example of defining two custom data 
     * elements: {@code  Easy trail  
     * Pi in the sky 3.14159 
     * 10  Point 
     * coordinates-122.000,37.002    Difficult 
     * trail   Mount Everest 347.45 
     * 10000   
     *Point coordinates-122.000,37.002   }
     * 

     * 

     * Here is an example of defining two custom data elements: 
     * 

     * 

     * This element assigns a value to the custom data field identified by the name attribute. 
     * The type and name of this custom data field are declared in the {@code } element. 
     * 

     * 
     * 
     * 
     */
    @XmlElement(name = "SimpleData")
    protected List simpleData;
    /**
     * {@code }
     * 

     * This is an abstract base class and cannot be used directly in a KML file. It provides 
     * the id attribute, which allows unique identification of a KML element, and the targetId 
     * attribute, which is used to reference objects that have already been loaded into 
     * Google Earth. The id attribute must be assigned if the Update mechanism is to 
     * be used. 
     * 

     * 
     * Syntax: 
     * 
<!-- abstract element; do not create -->
     * <!-- Object id="ID" targetId="NCName" -->
     * <!-- /Object> -->

     * 
     * 
     * 
     */
    @XmlElement(name = "SchemaDataExtension")
    protected List schemaDataExtension;
    @XmlAttribute(name = "schemaUrl")
    @XmlSchemaType(name = "anyURI")
    protected String schemaUrl;

    public SchemaData() {
        super();
    }

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

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

    /**
     *
     * 
     * @return
     *     possible object is
     *     {@link String}
     *     
     */
    public String getSchemaUrl() {
        return schemaUrl;
    }

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

    @Override
    public int hashCode() {
        final int prime = 31;
        int result = super.hashCode();
        result = ((prime*result)+((simpleData == null)? 0 :simpleData.hashCode()));
        result = ((prime*result)+((schemaDataExtension == null)? 0 :schemaDataExtension.hashCode()));
        result = ((prime*result)+((schemaUrl == null)? 0 :schemaUrl.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 SchemaData) == false) {
            return false;
        }
        SchemaData other = ((SchemaData) obj);
        if (simpleData == null) {
            if (other.simpleData!= null) {
                return false;
            }
        } else {
            if (simpleData.equals(other.simpleData) == false) {
                return false;
            }
        }
        if (schemaDataExtension == null) {
            if (other.schemaDataExtension!= null) {
                return false;
            }
        } else {
            if (schemaDataExtension.equals(other.schemaDataExtension) == false) {
                return false;
            }
        }
        if (schemaUrl == null) {
            if (other.schemaUrl!= null) {
                return false;
            }
        } else {
            if (schemaUrl.equals(other.schemaUrl) == false) {
                return false;
            }
        }
        return true;
    }

    /**
     * Creates a new instance of {@link SimpleData} and adds it to simpleData.
     * This method is a short version for:
     * {@code
     * SimpleData simpleData = new SimpleData();
     * this.getSimpleData().add(simpleData); }
     * 
     * 
     * @param name
     *     required parameter
     */
    public SimpleData createAndAddSimpleData(final String name) {
        SimpleData newValue = new SimpleData(name);
        this.getSimpleData().add(newValue);
        return newValue;
    }

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

    /**
     * add a value to the simpleData property collection
     * 
     * @param simpleData
     *     Objects of the following type are allowed in the list: {@link SimpleData}
     * @return
     *     true (as general contract of Collection.add). 
     */
    public SchemaData addToSimpleData(final SimpleData simpleData) {
        this.getSimpleData().add(simpleData);
        return this;
    }

    /**
     *
     * 
     * @param schemaDataExtension
     *     Objects of the following type are allowed in the list: {@code <}{@link SimpleArrayData}{@code >}{@code <}{@link Object}{@code >}
     */
    public void setSchemaDataExtension(final List schemaDataExtension) {
        this.schemaDataExtension = schemaDataExtension;
    }

    /**
     * add a value to the schemaDataExtension property collection
     * 
     * @param schemaDataExtension
     *     Objects of the following type are allowed in the list: {@code <}{@link SimpleArrayData}{@code >}{@code <}{@link Object}{@code >}
     * @return
     *     true (as general contract of Collection.add). 
     */
    public SchemaData addToSchemaDataExtension(final Object schemaDataExtension) {
        this.getSchemaDataExtension().add(schemaDataExtension);
        return this;
    }

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

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

    /**
     * fluent setter
     *
     * 
     * @param simpleData
     *     required parameter
     */
    public SchemaData withSimpleData(final List simpleData) {
        this.setSimpleData(simpleData);
        return this;
    }

    /**
     * fluent setter
     *
     * 
     * @param schemaDataExtension
     *     required parameter
     */
    public SchemaData withSchemaDataExtension(final List schemaDataExtension) {
        this.setSchemaDataExtension(schemaDataExtension);
        return this;
    }

    /**
     * fluent setter
     *
     * 
     * @param schemaUrl
     *     required parameter
     */
    public SchemaData withSchemaUrl(final String schemaUrl) {
        this.setSchemaUrl(schemaUrl);
        return this;
    }

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

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

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

    @Override
    public SchemaData clone() {
        SchemaData copy;
        copy = ((SchemaData) super.clone());
        copy.simpleData = new ArrayList((getSimpleData().size()));
        for (SimpleData iter: simpleData) {
            copy.simpleData.add(iter.clone());
        }
        copy.schemaDataExtension = new ArrayList((getSchemaDataExtension().size()));
        for (Object iter: schemaDataExtension) {
            copy.schemaDataExtension.add(iter);
        }
        return copy;
    }

}
 















© 2015 - 2024 Weber Informatics LLC | Privacy Policy