de.micromata.opengis.kml.v_2_2_0
Class Point

java.lang.Object
  extended by de.micromata.opengis.kml.v_2_2_0.AbstractObject
      extended by de.micromata.opengis.kml.v_2_2_0.Geometry
          extended by de.micromata.opengis.kml.v_2_2_0.Point
All Implemented Interfaces:
java.lang.Cloneable

public class Point
extends Geometry
implements java.lang.Cloneable

A geographic location defined by longitude, latitude, and (optional) altitude. When a Point is contained by a Placemark, the point itself determines the position of the Placemark's name and icon. When a Point is extruded, it is connected to the ground with a line. This "tether" uses the current LineStyle.

The element acts as a inside a element. It draws an icon to mark the position of the PhotoOverlay. The icon drawn is specified by the and fields, just as it is for .

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


Field Summary
protected  AltitudeMode altitudeMode
          AltitudeMode
protected  java.util.List<Coordinate> coordinates
           (required)
protected  java.lang.Boolean extrude
          
protected  java.util.List<AbstractObject> pointObjectExtension
          
protected  java.util.List<java.lang.Object> pointSimpleExtension
           
 
Fields inherited from class de.micromata.opengis.kml.v_2_2_0.Geometry
geometryObjectExtension, geometrySimpleExtension
 
Fields inherited from class de.micromata.opengis.kml.v_2_2_0.AbstractObject
id, objectSimpleExtension, targetId
 
Constructor Summary
Point()
           
 
Method Summary
 Point addToCoordinates(double longitude, double latitude)
          add a value to the coordinates property collection
 Point addToCoordinates(double longitude, double latitude, double altitude)
          add a value to the coordinates property collection
 Point addToCoordinates(java.lang.String coordinates)
          add a value to the coordinates property collection
 Point addToGeometryObjectExtension(AbstractObject geometryObjectExtension)
          add a value to the geometryObjectExtension property collection
 Point addToGeometrySimpleExtension(java.lang.Object geometrySimpleExtension)
          add a value to the geometrySimpleExtension property collection
 Point addToObjectSimpleExtension(java.lang.Object objectSimpleExtension)
          add a value to the objectSimpleExtension property collection
 Point addToPointObjectExtension(AbstractObject pointObjectExtension)
          add a value to the pointObjectExtension property collection
 Point addToPointSimpleExtension(java.lang.Object pointSimpleExtension)
          add a value to the pointSimpleExtension property collection
 Point clone()
           
 java.util.List<Coordinate> createAndSetCoordinates()
          Creates a new instance of List<Coordinate and set it to this.coordinates.
 boolean equals(java.lang.Object obj)
           
 AltitudeMode getAltitudeMode()
           
 java.util.List<Coordinate> getCoordinates()
           
 java.util.List<AbstractObject> getPointObjectExtension()
           
 java.util.List<java.lang.Object> getPointSimpleExtension()
           
 int hashCode()
           
 java.lang.Boolean isExtrude()
           
 void setAltitudeMode(AltitudeMode value)
           
 void setCoordinates(java.util.List<Coordinate> coordinates)
           
 void setExtrude(java.lang.Boolean value)
           
 void setGeometryObjectExtension(java.util.List<AbstractObject> geometryObjectExtension)
           
 void setGeometrySimpleExtension(java.util.List<java.lang.Object> geometrySimpleExtension)
           
 void setObjectSimpleExtension(java.util.List<java.lang.Object> objectSimpleExtension)
           
 void setPointObjectExtension(java.util.List<AbstractObject> pointObjectExtension)
           
 void setPointSimpleExtension(java.util.List<java.lang.Object> pointSimpleExtension)
           
 Point withAltitudeMode(AltitudeMode altitudeMode)
          fluent setter
 Point withCoordinates(java.util.List<Coordinate> coordinates)
          fluent setter
 Point withExtrude(java.lang.Boolean extrude)
          fluent setter
 Point withGeometryObjectExtension(java.util.List<AbstractObject> geometryObjectExtension)
          fluent setter
 Point withGeometrySimpleExtension(java.util.List<java.lang.Object> geometrySimpleExtension)
          fluent setter
 Point withId(java.lang.String id)
          fluent setter
 Point withObjectSimpleExtension(java.util.List<java.lang.Object> objectSimpleExtension)
          fluent setter
 Point withPointObjectExtension(java.util.List<AbstractObject> pointObjectExtension)
          fluent setter
 Point withPointSimpleExtension(java.util.List<java.lang.Object> pointSimpleExtension)
          fluent setter
 Point withTargetId(java.lang.String targetId)
          fluent setter
 
Methods inherited from class de.micromata.opengis.kml.v_2_2_0.Geometry
getGeometryObjectExtension, getGeometrySimpleExtension
 
Methods inherited from class de.micromata.opengis.kml.v_2_2_0.AbstractObject
getId, getObjectSimpleExtension, getTargetId, setId, setTargetId
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

extrude

protected java.lang.Boolean extrude

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 must be either relativeToGround, relativeToSeaFloor, or absolute. The point is extruded toward the center of the Earth's sphere.


altitudeMode

protected AltitudeMode altitudeMode
AltitudeMode

clampToGround, relativeToGround, absolute

See Also: See and


coordinates

protected java.util.List<Coordinate> 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 ≥ −180 and <= 180 latitude ≥ −90 and ≤ 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.


pointSimpleExtension

protected java.util.List<java.lang.Object> pointSimpleExtension

pointObjectExtension

protected java.util.List<AbstractObject> pointObjectExtension

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 mechanism is to be used.

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

Constructor Detail

Point

public Point()
Method Detail

isExtrude

public java.lang.Boolean isExtrude()
Returns:
possible object is Boolean

setExtrude

public void setExtrude(java.lang.Boolean value)
Parameters:
value - allowed object is Boolean
See Also:
extrude

getAltitudeMode

public AltitudeMode getAltitudeMode()
Returns:
possible object is <Object <AltitudeMode <de.micromata.opengis.kml.v_2_2_0.gx.AltitudeMode
See Also:
altitudeMode

setAltitudeMode

public void setAltitudeMode(AltitudeMode value)
Parameters:
value - allowed object is <Object <AltitudeMode <de.micromata.opengis.kml.v_2_2_0.gx.AltitudeMode
See Also:
altitudeMode

getPointSimpleExtension

public java.util.List<java.lang.Object> getPointSimpleExtension()
See Also:
pointSimpleExtension

getPointObjectExtension

public java.util.List<AbstractObject> getPointObjectExtension()
See Also:
pointObjectExtension

getCoordinates

public java.util.List<Coordinate> getCoordinates()
See Also:
coordinates

hashCode

public int hashCode()
Overrides:
hashCode in class Geometry

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class Geometry

setCoordinates

public void setCoordinates(java.util.List<Coordinate> coordinates)
Parameters:
coordinates -
See Also:
coordinates

addToCoordinates

public Point addToCoordinates(double longitude,
                              double latitude)
add a value to the coordinates property collection

Parameters:
longitude - required parameter
latitude - required parameter
Returns:
true (as general contract of Collection.add).

addToCoordinates

public Point addToCoordinates(double longitude,
                              double latitude,
                              double altitude)
add a value to the coordinates property collection

Parameters:
altitude - required parameter
longitude - required parameter
latitude - required parameter
Returns:
true (as general contract of Collection.add).

addToCoordinates

public Point addToCoordinates(java.lang.String coordinates)
add a value to the coordinates property collection

Parameters:
coordinates - required parameter
Returns:
true (as general contract of Collection.add).

setPointSimpleExtension

public void setPointSimpleExtension(java.util.List<java.lang.Object> pointSimpleExtension)
Parameters:
pointSimpleExtension -
See Also:
pointSimpleExtension

addToPointSimpleExtension

public Point addToPointSimpleExtension(java.lang.Object pointSimpleExtension)
add a value to the pointSimpleExtension property collection

Parameters:
pointSimpleExtension - Objects of the following type are allowed in the list: Object
Returns:
true (as general contract of Collection.add).

setPointObjectExtension

public void setPointObjectExtension(java.util.List<AbstractObject> pointObjectExtension)
Parameters:
pointObjectExtension -
See Also:
pointObjectExtension

addToPointObjectExtension

public Point addToPointObjectExtension(AbstractObject pointObjectExtension)
add a value to the pointObjectExtension property collection

Parameters:
pointObjectExtension - Objects of the following type are allowed in the list: AbstractObject
Returns:
true (as general contract of Collection.add).

setObjectSimpleExtension

public void setObjectSimpleExtension(java.util.List<java.lang.Object> objectSimpleExtension)
Overrides:
setObjectSimpleExtension in class Geometry
See Also:
objectSimpleExtension

addToObjectSimpleExtension

public Point addToObjectSimpleExtension(java.lang.Object objectSimpleExtension)
Description copied from class: AbstractObject
add a value to the objectSimpleExtension property collection

Overrides:
addToObjectSimpleExtension in class Geometry
Parameters:
objectSimpleExtension - Objects of the following type are allowed in the list: Object
Returns:
true (as general contract of Collection.add).

setGeometrySimpleExtension

public void setGeometrySimpleExtension(java.util.List<java.lang.Object> geometrySimpleExtension)
Overrides:
setGeometrySimpleExtension in class Geometry
See Also:
geometrySimpleExtension

addToGeometrySimpleExtension

public Point addToGeometrySimpleExtension(java.lang.Object geometrySimpleExtension)
Description copied from class: Geometry
add a value to the geometrySimpleExtension property collection

Overrides:
addToGeometrySimpleExtension in class Geometry
Parameters:
geometrySimpleExtension - Objects of the following type are allowed in the list: Object
Returns:
true (as general contract of Collection.add).

setGeometryObjectExtension

public void setGeometryObjectExtension(java.util.List<AbstractObject> geometryObjectExtension)
Overrides:
setGeometryObjectExtension in class Geometry
See Also:
geometryObjectExtension

addToGeometryObjectExtension

public Point addToGeometryObjectExtension(AbstractObject geometryObjectExtension)
Description copied from class: Geometry
add a value to the geometryObjectExtension property collection

Overrides:
addToGeometryObjectExtension in class Geometry
Parameters:
geometryObjectExtension - Objects of the following type are allowed in the list: AbstractObject
Returns:
true (as general contract of Collection.add).

withExtrude

public Point withExtrude(java.lang.Boolean extrude)
fluent setter

Parameters:
extrude - required parameter
See Also:
setExtrude(Boolean)

withAltitudeMode

public Point withAltitudeMode(AltitudeMode altitudeMode)
fluent setter

Parameters:
altitudeMode - required parameter
See Also:
#setAltitudeMode(Object)

withCoordinates

public Point withCoordinates(java.util.List<Coordinate> coordinates)
fluent setter

Parameters:
coordinates - required parameter
See Also:
#setCoordinates(List)

withPointSimpleExtension

public Point withPointSimpleExtension(java.util.List<java.lang.Object> pointSimpleExtension)
fluent setter

Parameters:
pointSimpleExtension - required parameter
See Also:
#setPointSimpleExtension(List)

withPointObjectExtension

public Point withPointObjectExtension(java.util.List<AbstractObject> pointObjectExtension)
fluent setter

Parameters:
pointObjectExtension - required parameter
See Also:
#setPointObjectExtension(List)

withObjectSimpleExtension

public Point withObjectSimpleExtension(java.util.List<java.lang.Object> objectSimpleExtension)
Description copied from class: AbstractObject
fluent setter

Overrides:
withObjectSimpleExtension in class Geometry
Parameters:
objectSimpleExtension - required parameter
See Also:
#setObjectSimpleExtension(List)

withId

public Point withId(java.lang.String id)
Description copied from class: AbstractObject
fluent setter

Overrides:
withId in class Geometry
Parameters:
id - required parameter
See Also:
AbstractObject.setId(String)

withTargetId

public Point withTargetId(java.lang.String targetId)
Description copied from class: AbstractObject
fluent setter

Overrides:
withTargetId in class Geometry
Parameters:
targetId - required parameter
See Also:
AbstractObject.setTargetId(String)

withGeometrySimpleExtension

public Point withGeometrySimpleExtension(java.util.List<java.lang.Object> geometrySimpleExtension)
Description copied from class: Geometry
fluent setter

Overrides:
withGeometrySimpleExtension in class Geometry
Parameters:
geometrySimpleExtension - required parameter
See Also:
#setGeometrySimpleExtension(List)

withGeometryObjectExtension

public Point withGeometryObjectExtension(java.util.List<AbstractObject> geometryObjectExtension)
Description copied from class: Geometry
fluent setter

Overrides:
withGeometryObjectExtension in class Geometry
Parameters:
geometryObjectExtension - required parameter
See Also:
#setGeometryObjectExtension(List)

createAndSetCoordinates

public java.util.List<Coordinate> createAndSetCoordinates()
Creates a new instance of List<Coordinate and set it to this.coordinates. This method is a short version for:
 
 List newValue = new List();
 this.setCoordinates(newValue); 
 


clone

public Point clone()
Overrides:
clone in class Geometry