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

de.micromata.opengis.kml.v_2_2_0.Container 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.atom.Author;
import de.micromata.opengis.kml.v_2_2_0.atom.Link;
import de.micromata.opengis.kml.v_2_2_0.xal.AddressDetails;
import jakarta.xml.bind.annotation.*;

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


/**
 * {@code }
 * 

 * This is an abstract element and cannot be used directly in a KML file. A Container 
 * element holds one or more Features and allows the creation of nested hierarchies. 
 * 

 * 
 * Syntax: 
 * 
<!-- abstract element; do not create -->
 * <!-- Container id="ID" -->              <!-- Document,Folder -->                 
 *   <!-- inherited from Feature element -->
 *   <name>...</name>                      <!-- string -->
 *   <visibility>1</visibility>            <!-- boolean -->
 *   <open>0</open>                        <!-- boolean -->
 *   <address>...</address>                <!-- string -->
 *   <AddressDetails xmlns="urn:oasis:names:tc:ciq:xsdschema:xAL:2.0">...
      </AddressDetails>                 <!-- string -->
 *   <phoneNumber>...</phoneNumber>        <!-- string -->
  <Snippet maxLines="2">...</Snippet>   <!-- string -->
 *   <description>...</description>        <!-- string -->
 *   <AbstractView>...</AbstractView>      <!-- LookAt or Camera -->
 *   <TimePrimitive>...</TimePrimitive>
 *   <styleUrl>...</styleUrl>              <!-- anyURI -->
 *   <StyleSelector>...</StyleSelector>
 *   <Region>...</Region>
 *   <Metadata>...</Metadata>
 *   <atom:author>...<atom:author>   <!-- xmlns:atom="http://www.w3.org/2005/Atom" -->
 *   <atom:link>...</atom:link>
 * 
 *   <!-- specific to Container --> 
  <!-- 0 or more Features --> 
 * <!-- /Container -->

 * 
 * Extends: 
 *
 * 
 * Extended By: 
 *
 *
 * 
 * 
 * 
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "AbstractContainerType", propOrder = {
    "containerSimpleExtension",
    "containerObjectExtension"
})
@XmlSeeAlso({
    Folder.class,
    Document.class
})
public abstract class Container
    extends Feature
    implements Cloneable
{

    @XmlElement(name = "AbstractContainerSimpleExtensionGroup")
    @XmlSchemaType(name = "anySimpleType")
    protected List containerSimpleExtension;
    /**
     * {@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 = "AbstractContainerObjectExtensionGroup")
    protected List containerObjectExtension;

    public Container() {
        super();
    }

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

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

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

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

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

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

    /**
     * add a value to the containerObjectExtension property collection
     * 
     * @param containerObjectExtension
     *     Objects of the following type are allowed in the list: {@link AbstractObject}
     * @return
     *     true (as general contract of Collection.add). 
     */
    public Container addToContainerObjectExtension(final AbstractObject containerObjectExtension) {
        this.getContainerObjectExtension().add(containerObjectExtension);
        return this;
    }

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

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

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

    @Obvious
    @Override
    public Container addToStyleSelector(final StyleSelector styleSelector) {
        super.getStyleSelector().add(styleSelector);
        return this;
    }

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

    @Obvious
    @Override
    public Container addToFeatureSimpleExtension(final Object featureSimpleExtension) {
        super.getFeatureSimpleExtension().add(featureSimpleExtension);
        return this;
    }

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

    @Obvious
    @Override
    public Container addToFeatureObjectExtension(final AbstractObject featureObjectExtension) {
        super.getFeatureObjectExtension().add(featureObjectExtension);
        return this;
    }

    /**
     * fluent setter
     *
     * 
     * @param containerSimpleExtension
     *     required parameter
     */
    public Container withContainerSimpleExtension(final List containerSimpleExtension) {
        this.setContainerSimpleExtension(containerSimpleExtension);
        return this;
    }

    /**
     * fluent setter
     *
     * 
     * @param containerObjectExtension
     *     required parameter
     */
    public Container withContainerObjectExtension(final List containerObjectExtension) {
        this.setContainerObjectExtension(containerObjectExtension);
        return this;
    }

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

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

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

    @Obvious
    @Override
    public Container withName(final String name) {
        super.withName(name);
        return this;
    }

    @Obvious
    @Override
    public Container withVisibility(final Boolean visibility) {
        super.withVisibility(visibility);
        return this;
    }

    @Obvious
    @Override
    public Container withOpen(final Boolean open) {
        super.withOpen(open);
        return this;
    }

    @Obvious
    @Override
    public Container withAtomAuthor(final Author atomAuthor) {
        super.withAtomAuthor(atomAuthor);
        return this;
    }

    @Obvious
    @Override
    public Container withAtomLink(final Link atomLink) {
        super.withAtomLink(atomLink);
        return this;
    }

    @Obvious
    @Override
    public Container withAddress(final String address) {
        super.withAddress(address);
        return this;
    }

    @Obvious
    @Override
    public Container withXalAddressDetails(final AddressDetails xalAddressDetails) {
        super.withXalAddressDetails(xalAddressDetails);
        return this;
    }

    @Obvious
    @Override
    public Container withPhoneNumber(final String phoneNumber) {
        super.withPhoneNumber(phoneNumber);
        return this;
    }

    @Obvious
    @Override
    public Container withSnippet(final Snippet snippet) {
        super.withSnippet(snippet);
        return this;
    }

    @Obvious
    @Override
    public Container withSnippetd(final String snippetd) {
        super.withSnippetd(snippetd);
        return this;
    }

    @Obvious
    @Override
    public Container withDescription(final String description) {
        super.withDescription(description);
        return this;
    }

    @Obvious
    @Override
    public Container withAbstractView(final AbstractView abstractView) {
        super.withAbstractView(abstractView);
        return this;
    }

    @Obvious
    @Override
    public Container withTimePrimitive(final TimePrimitive timePrimitive) {
        super.withTimePrimitive(timePrimitive);
        return this;
    }

    @Obvious
    @Override
    public Container withStyleUrl(final String styleUrl) {
        super.withStyleUrl(styleUrl);
        return this;
    }

    @Obvious
    @Override
    public Container withStyleSelector(final List styleSelector) {
        super.withStyleSelector(styleSelector);
        return this;
    }

    @Obvious
    @Override
    public Container withRegion(final Region region) {
        super.withRegion(region);
        return this;
    }

    @Obvious
    @Override
    public Container withMetadata(final Metadata metadata) {
        super.withMetadata(metadata);
        return this;
    }

    @Obvious
    @Override
    public Container withExtendedData(final ExtendedData extendedData) {
        super.withExtendedData(extendedData);
        return this;
    }

    @Obvious
    @Override
    public Container withFeatureSimpleExtension(final List featureSimpleExtension) {
        super.withFeatureSimpleExtension(featureSimpleExtension);
        return this;
    }

    @Obvious
    @Override
    public Container withFeatureObjectExtension(final List featureObjectExtension) {
        super.withFeatureObjectExtension(featureObjectExtension);
        return this;
    }

    @Override
    public Container clone() {
        Container copy;
        copy = ((Container) super.clone());
        copy.containerSimpleExtension = new ArrayList((getContainerSimpleExtension().size()));
        for (Object iter: containerSimpleExtension) {
            copy.containerSimpleExtension.add(iter);
        }
        copy.containerObjectExtension = new ArrayList((getContainerObjectExtension().size()));
        for (AbstractObject iter: containerObjectExtension) {
            copy.containerObjectExtension.add(iter.clone());
        }
        return copy;
    }

}
 















© 2015 - 2024 Weber Informatics LLC | Privacy Policy