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

de.micromata.opengis.kml.v_2_2_0.LinearRing 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 jakarta.xml.bind.annotation.adapters.XmlJavaTypeAdapter;

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


/**
 * {@code }
 * 

 * Defines a closed line string, typically the outer boundary of a Polygon. Optionally, 
 * a LinearRing can also be used as the inner boundary of a Polygon to create holes 
 * in the Polygon. A Polygon can contain multiple {@code } elements used as inner 
 * boundaries. 
 * 

 * 

 * Note: In Google Earth, a Polygon with an altitudeMode of clampToGround follows 
 * the great circle; however, a LinearRing (by itself) with an altitudeMode of clampToGround 
 * follows lines of constant latitude. 
 * 

 * 
 * Syntax: 
 * 
<LinearRing id="ID">
 *   <!-- specific to LinearRing -->
 *   <extrude>0</extrude>                       <!-- boolean -->
 *   <tessellate>0</tessellate>                 <!-- boolean -->
 *   <altitudeMode>clampToGround</altitudeMode> 
 *     <!-- kml:altitudeModeEnum: clampToGround, relativeToGround, or absolute -->
 *     <!-- or, substitute gx:altitudeMode: clampToSeaFloor, relativeToSeaFloor -->
 *   <coordinates>...</coordinates>             <!-- lon,lat[,alt] tuples --> 
 * </LinearRing>

 * 
 * Extends: 
 *
 * 
 * Contained By: 
 *
 *
 *
 *
 * 
 * 
 * 
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "LinearRingType", propOrder = {
    "extrude",
    "tessellate",
    "altitudeMode",
    "coordinates",
    "linearRingSimpleExtension",
    "linearRingObjectExtension"
})
@XmlRootElement(name = "LinearRing", namespace = "http://www.opengis.net/kml/2.2")
public class LinearRing
    extends Geometry
    implements Cloneable
{

    /**
     * {@code }
     * 

     * Boolean value. Specifies whether to connect the LineString to the ground. To extrude 
     * a LineString, the altitude mode must be either relativeToGround, relativeToSeaFloor, 
     * or absolute. The vertices in the LineString are extruded toward the center of the 
     * Earth's sphere. 
     * 

     * 

     * Boolean value. Specifies whether to connect the LinearRing to the ground. To extrude 
     * this geometry, the altitude mode must be either relativeToGround, relativeToSeaFloor, 
     * or absolute. Only the vertices of the LinearRing are extruded, not the center of 
     * the geometry. The vertices are extruded toward the center of the Earth's sphere. 
     * 

     * 

     * Boolean value. Specifies whether to connect the Polygon to the ground. To extrude 
     * a Polygon, the altitude mode must be either relativeToGround, relativeToSeaFloor, 
     * or absolute. Only the vertices are extruded, not the geometry itself (for example, 
     * a rectangle turns into a box with five faces. The vertices of the Polygon are extruded 
     * toward the center of the Earth's sphere. 
     * 

     * 

     * Boolean value. Specifies whether to connect the point to the ground with a line. 
     * To extrude a Point, the value for altitudeMode must be either relativeToGround, 
     * relativeToSeaFloor, or absolute. The point is extruded toward the center of the 
     * Earth's sphere. 
     * 

     * 
     * 
     * 
     */
    @XmlElement(defaultValue = "0")
    @XmlJavaTypeAdapter(BooleanConverter.class)
    protected Boolean extrude;
    /**
     * {@code }
     * 

     * Boolean value. Specifies whether to allow the LineString to follow the terrain. 
     * To enable tessellation, the altitude mode must be clampToGround or clampToSeaFloor. 
     * Very large LineStrings should enable tessellation so that they follow the curvature 
     * of the earth (otherwise, they may go underground and be hidden). 
     * 

     * 

     * Boolean value. Specifies whether to allow the LinearRing to follow the terrain. 
     * To enable tessellation, the value for altitudeMode must be clampToGround or clampToSeaFloor. 
     * Very large LinearRings should enable tessellation so that they follow the curvature 
     * of the earth (otherwise, they may go underground and be hidden). 
     * 

     * 

     * Boolean value. Specifies whether to allow the Polygon to follow the terrain. To 
     * enable tessellation, the Polygon must have an altitude mode of clampToGround or 
     * clampToSeaFloor. Very large Polygons should enable tessellation so that they follow 
     * the curvature of the earth (otherwise, they may go underground and be hidden). 
     * 

     * 
     * 
     * 
     */
    @XmlElement(defaultValue = "0")
    @XmlJavaTypeAdapter(BooleanConverter.class)
    protected Boolean tessellate;
    /**
     * AltitudeMode
     * 

     * clampToGround, relativeToGround, absolute 
     * 

     * 
     * See Also: 
     * See LookAt and {@code }
     * 
     * 
     * 
     */
    @XmlElement(defaultValue = "clampToGround")
    protected AltitudeMode altitudeMode;
    /**
     * coordinates (required)
     * 

     * A single tuple consisting of floating point values for longitude, latitude, and 
     * altitude (in that order). Longitude and latitude values are in degrees, where longitude 
     * gt −180 and lteq 180 latitude gteq −90 and lteq 90 altitude values (optional) are in meters
     * above sea level 
     * 

     * 

     * Do not include spaces between the three values that describe a coordinate. 
     * 

     * 

     * Two or more coordinate tuples, each consisting of floating point values for longitude, 
     * latitude, and altitude. The altitude component is optional. Insert a space between 
     * tuples. Do not include spaces within a tuple. 
     * 

     * 
     * 
     * 
     */

    @XmlElement(namespace = "http://www.opengis.net/kml/2.2", type = String.class)
    @XmlJavaTypeAdapter(CoordinatesConverter.class)
    protected List coordinates;
    @XmlElement(name = "LinearRingSimpleExtensionGroup")
    @XmlSchemaType(name = "anySimpleType")
    protected List linearRingSimpleExtension;
    /**
     * {@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 = "LinearRingObjectExtensionGroup")
    protected List linearRingObjectExtension;

    public LinearRing() {
        super();
    }

    /**
     * 
     * @return
     *     possible object is
     *     {@link Boolean}
     *     
     */
    public Boolean isExtrude() {
        return extrude;
    }

    /**
     *
     * 
     * @param value
     *     allowed object is
     *     {@link Boolean}
     *     
     */
    public void setExtrude(Boolean value) {
        this.extrude = value;
    }

    /**
     * 
     * @return
     *     possible object is
     *     {@link Boolean}
     *     
     */
    public Boolean isTessellate() {
        return tessellate;
    }

    /**
     *
     * 
     * @param value
     *     allowed object is
     *     {@link Boolean}
     *     
     */
    public void setTessellate(Boolean value) {
        this.tessellate = value;
    }

    /**
     *
     * 
     * @return
     *     possible object is
     *     {@code <}{@link Object}{@code >}
     *     {@code <}{@link de.micromata.opengis.kml.v_2_2_0.AltitudeMode}{@code >}
     *     
     *     
     */
    public AltitudeMode getAltitudeMode() {
        return altitudeMode;
    }

    /**
     *
     * 
     * @param value
     *     allowed object is
     *     {@code <}{@link Object}{@code >}
     *     {@code <}{@link de.micromata.opengis.kml.v_2_2_0.AltitudeMode}{@code >}
     *     
     *     
     */
    public void setAltitudeMode(AltitudeMode value) {
        this.altitudeMode = value;
    }

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

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

    /**
     *
     * 
     */
    public List getCoordinates() {
        if (coordinates == null) {
            coordinates = new ArrayList();
        }
        return coordinates;
    }

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

    public void setCoordinates(final List coordinates) {
        this.coordinates = coordinates;
    }

    /**
     * add a value to the coordinates property collection
     * 
     * @param longitude
     *     required parameter
     * @param latitude
     *     required parameter
     * @return
     *     true (as general contract of Collection.add). 
     */
    public LinearRing addToCoordinates(final double longitude, final double latitude) {
        this.getCoordinates().add(new Coordinate(longitude, latitude));
        return this;
    }

    /**
     * add a value to the coordinates property collection
     * 
     * @param longitude
     *     required parameter
     * @param latitude
     *     required parameter
     * @param altitude
     *     required parameter
     * @return
     *     true (as general contract of Collection.add). 
     */
    public LinearRing addToCoordinates(final double longitude, final double latitude, final double altitude) {
        this.getCoordinates().add(new Coordinate(longitude, latitude, altitude));
        return this;
    }

    /**
     * add a value to the coordinates property collection
     * 
     * @param coordinates
     *     required parameter
     * @return
     *     true (as general contract of Collection.add). 
     */
    public LinearRing addToCoordinates(final String coordinates) {
        this.getCoordinates().add(new Coordinate(coordinates));
        return this;
    }

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

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

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

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

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

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

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

    @Obvious
    @Override
    public LinearRing addToGeometrySimpleExtension(final Object geometrySimpleExtension) {
        super.getGeometrySimpleExtension().add(geometrySimpleExtension);
        return this;
    }

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

    @Obvious
    @Override
    public LinearRing addToGeometryObjectExtension(final AbstractObject geometryObjectExtension) {
        super.getGeometryObjectExtension().add(geometryObjectExtension);
        return this;
    }

    /**
     * fluent setter
     *
     * 
     * @param extrude
     *     required parameter
     */
    public LinearRing withExtrude(final Boolean extrude) {
        this.setExtrude(extrude);
        return this;
    }

    /**
     * fluent setter
     *
     * 
     * @param tessellate
     *     required parameter
     */
    public LinearRing withTessellate(final Boolean tessellate) {
        this.setTessellate(tessellate);
        return this;
    }

    /**
     * fluent setter
     *
     * 
     * @param altitudeMode
     *     required parameter
     */
    public LinearRing withAltitudeMode(final  AltitudeMode altitudeMode) {
        this.setAltitudeMode(altitudeMode);
        return this;
    }

    /**
     * fluent setter
     *
     * 
     * @param coordinates
     *     required parameter
     */
    public LinearRing withCoordinates(final List coordinates) {
        this.setCoordinates(coordinates);
        return this;
    }

    /**
     * fluent setter
     *
     * 
     * @param linearRingSimpleExtension
     *     required parameter
     */
    public LinearRing withLinearRingSimpleExtension(final List linearRingSimpleExtension) {
        this.setLinearRingSimpleExtension(linearRingSimpleExtension);
        return this;
    }

    /**
     * fluent setter
     *
     * 
     * @param linearRingObjectExtension
     *     required parameter
     */
    public LinearRing withLinearRingObjectExtension(final List linearRingObjectExtension) {
        this.setLinearRingObjectExtension(linearRingObjectExtension);
        return this;
    }

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

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

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

    @Obvious
    @Override
    public LinearRing withGeometrySimpleExtension(final List geometrySimpleExtension) {
        super.withGeometrySimpleExtension(geometrySimpleExtension);
        return this;
    }

    @Obvious
    @Override
    public LinearRing withGeometryObjectExtension(final List geometryObjectExtension) {
        super.withGeometryObjectExtension(geometryObjectExtension);
        return this;
    }

    /**
     * Creates a new instance of {@link List}{@code <}{@link Coordinate}{@code >} and set it to this.coordinates.
     * 
     * This method is a short version for:
     * {@code
     * List newValue = new List();
     * this.setCoordinates(newValue); }
     * 
     * 
     */
    public List createAndSetCoordinates() {
        List newValue = new ArrayList();
        this.setCoordinates(newValue);
        return newValue;
    }

    @Override
    public LinearRing clone() {
        LinearRing copy;
        copy = ((LinearRing) super.clone());
        copy.coordinates = new ArrayList((getCoordinates().size()));
        for (Coordinate iter: coordinates) {
            copy.coordinates.add(iter.clone());
        }
        copy.linearRingSimpleExtension = new ArrayList((getLinearRingSimpleExtension().size()));
        for (Object iter: linearRingSimpleExtension) {
            copy.linearRingSimpleExtension.add(iter);
        }
        copy.linearRingObjectExtension = new ArrayList((getLinearRingObjectExtension().size()));
        for (AbstractObject iter: linearRingObjectExtension) {
            copy.linearRingObjectExtension.add(iter.clone());
        }
        return copy;
    }

}
 















© 2015 - 2024 Weber Informatics LLC | Privacy Policy