de.micromata.opengis.kml.v_2_2_0
Class Placemark

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

public class Placemark
extends Feature
implements java.lang.Cloneable

A Placemark is a Feature with associated Geometry. In Google Earth, a Placemark appears as a list item in the Places panel. A Placemark with a Point has an icon associated with it that marks a point on the Earth in the 3D viewer. (In the Google Earth 3D viewer, a Point Placemark is the only object you can click or roll over. Other Geometry objects do not have an icon in the 3D viewer. To give the user something to click in the 3D viewer, you would need to create a MultiGeometry object that contains both a Point and the other Geometry object.)

Syntax:
<Placemark id="ID">
   <!-- inherited from Feature element -->
   <name>...</name>                      <!-- string -->
   <visibility>1</visibility>            <!-- boolean -->
   <open>0</open>                        <!-- boolean -->
   <atom:author>...<atom:author>         <!-- xmlns:atom -->
   <atom:link>...</atom:link>            <!-- xmlns:atom -->
   <address>...</address>                <!-- string -->
   <xal:AddressDetails>...</xal:AddressDetails>  <!-- xmlns:xal -->
<phoneNumber>...</phoneNumber> <!-- string -->
<Snippet maxLines="2">...</Snippet> <!-- string --> <description>...</description> <!-- string --> <AbstractView>...</AbstractView> <!-- Camera or LookAt --> <TimePrimitive>...</TimePrimitive> <styleUrl>...</styleUrl> <!-- anyURI --> <StyleSelector>...</StyleSelector> <Region>...</Region> <Metadata>...</Metadata> <!-- deprecated in KML 2.2 --> <ExtendedData>...</ExtendedData> <!-- new in KML 2.2 -->
<!-- specific to Placemark element --> <Geometry>...</Geometry> </Placemark>
Extends:


Field Summary
protected  Geometry geometry
          
protected  java.util.List<AbstractObject> placemarkObjectExtension
          
protected  java.util.List<java.lang.Object> placemarkSimpleExtension
           
 
Fields inherited from class de.micromata.opengis.kml.v_2_2_0.Feature
abstractView, address, atomAuthor, atomLink, description, extendedData, featureObjectExtension, featureSimpleExtension, metadata, name, open, phoneNumber, region, snippet, snippetd, styleSelector, styleUrl, timePrimitive, visibility, xalAddressDetails
 
Fields inherited from class de.micromata.opengis.kml.v_2_2_0.AbstractObject
id, objectSimpleExtension, targetId
 
Constructor Summary
Placemark()
           
 
Method Summary
 Placemark addToFeatureObjectExtension(AbstractObject featureObjectExtension)
          add a value to the featureObjectExtension property collection
 Placemark addToFeatureSimpleExtension(java.lang.Object featureSimpleExtension)
          add a value to the featureSimpleExtension property collection
 Placemark addToObjectSimpleExtension(java.lang.Object objectSimpleExtension)
          add a value to the objectSimpleExtension property collection
 Placemark addToPlacemarkObjectExtension(AbstractObject placemarkObjectExtension)
          add a value to the placemarkObjectExtension property collection
 Placemark addToPlacemarkSimpleExtension(java.lang.Object placemarkSimpleExtension)
          add a value to the placemarkSimpleExtension property collection
 Placemark addToStyleSelector(StyleSelector styleSelector)
          add a value to the styleSelector property collection
 Placemark clone()
           
 LinearRing createAndSetLinearRing()
          Creates a new instance of LinearRing and set it to geometry.
 LineString createAndSetLineString()
          Creates a new instance of LineString and set it to geometry.
 Model createAndSetModel()
          Creates a new instance of Model and set it to geometry.
 MultiGeometry createAndSetMultiGeometry()
          Creates a new instance of MultiGeometry and set it to geometry.
 Point createAndSetPoint()
          Creates a new instance of Point and set it to geometry.
 Polygon createAndSetPolygon()
          Creates a new instance of Polygon and set it to geometry.
 boolean equals(java.lang.Object obj)
           
 Geometry getGeometry()
           
 java.util.List<AbstractObject> getPlacemarkObjectExtension()
           
 java.util.List<java.lang.Object> getPlacemarkSimpleExtension()
           
 int hashCode()
           
 void setFeatureObjectExtension(java.util.List<AbstractObject> featureObjectExtension)
           
 void setFeatureSimpleExtension(java.util.List<java.lang.Object> featureSimpleExtension)
           
 void setGeometry(Geometry value)
           
 void setObjectSimpleExtension(java.util.List<java.lang.Object> objectSimpleExtension)
           
 void setPlacemarkObjectExtension(java.util.List<AbstractObject> placemarkObjectExtension)
           
 void setPlacemarkSimpleExtension(java.util.List<java.lang.Object> placemarkSimpleExtension)
           
 void setStyleSelector(java.util.List<StyleSelector> styleSelector)
           
 Placemark withAbstractView(AbstractView abstractView)
          fluent setter
 Placemark withAddress(java.lang.String address)
          fluent setter
 Placemark withAtomAuthor(Author atomAuthor)
          fluent setter
 Placemark withAtomLink(Link atomLink)
          fluent setter
 Placemark withDescription(java.lang.String description)
          fluent setter
 Placemark withExtendedData(ExtendedData extendedData)
          fluent setter
 Placemark withFeatureObjectExtension(java.util.List<AbstractObject> featureObjectExtension)
          fluent setter
 Placemark withFeatureSimpleExtension(java.util.List<java.lang.Object> featureSimpleExtension)
          fluent setter
 Placemark withGeometry(Geometry geometry)
          fluent setter
 Placemark withId(java.lang.String id)
          fluent setter
 Placemark withMetadata(Metadata metadata)
          fluent setter
 Placemark withName(java.lang.String name)
          fluent setter
 Placemark withObjectSimpleExtension(java.util.List<java.lang.Object> objectSimpleExtension)
          fluent setter
 Placemark withOpen(java.lang.Boolean open)
          fluent setter
 Placemark withPhoneNumber(java.lang.String phoneNumber)
          fluent setter
 Placemark withPlacemarkObjectExtension(java.util.List<AbstractObject> placemarkObjectExtension)
          fluent setter
 Placemark withPlacemarkSimpleExtension(java.util.List<java.lang.Object> placemarkSimpleExtension)
          fluent setter
 Placemark withRegion(Region region)
          fluent setter
 Placemark withSnippet(Snippet snippet)
          fluent setter
 Placemark withSnippetd(java.lang.String snippetd)
          fluent setter
 Placemark withStyleSelector(java.util.List<StyleSelector> styleSelector)
          fluent setter
 Placemark withStyleUrl(java.lang.String styleUrl)
          fluent setter
 Placemark withTargetId(java.lang.String targetId)
          fluent setter
 Placemark withTimePrimitive(TimePrimitive timePrimitive)
          fluent setter
 Placemark withVisibility(java.lang.Boolean visibility)
          fluent setter
 Placemark withXalAddressDetails(AddressDetails xalAddressDetails)
          fluent setter
 
Methods inherited from class de.micromata.opengis.kml.v_2_2_0.Feature
createAndAddStyle, createAndAddStyleMap, createAndSetAtomAuthor, createAndSetAtomLink, createAndSetCamera, createAndSetExtendedData, createAndSetLookAt, createAndSetMetadata, createAndSetRegion, createAndSetSnippet, createAndSetTimeSpan, createAndSetTimeStamp, createAndSetXalAddressDetails, getAbstractView, getAddress, getAtomAuthor, getAtomLink, getDescription, getExtendedData, getFeatureObjectExtension, getFeatureSimpleExtension, getMetadata, getName, getPhoneNumber, getRegion, getSnippet, getSnippetd, getStyleSelector, getStyleUrl, getTimePrimitive, getXalAddressDetails, isOpen, isVisibility, setAbstractView, setAddress, setAtomAuthor, setAtomLink, setDescription, setExtendedData, setMetadata, setName, setOpen, setPhoneNumber, setRegion, setSnippet, setSnippetd, setStyleUrl, setTimePrimitive, setVisibility, setXalAddressDetails
 
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

geometry

protected Geometry geometry

This is an abstract element and cannot be used directly in a KML file. It provides a placeholder object for all derived Geometry objects.

Syntax:
<!-- abstract element; do not create -->
 <!-- Geometry id="ID" -->                 <!-- Point,LineString,LinearRing,
                                                Polygon,MultiGeometry,Model -->
 <!-- /Geometry -->
Extends:


placemarkSimpleExtension

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

placemarkObjectExtension

protected java.util.List<AbstractObject> placemarkObjectExtension

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

Placemark

public Placemark()
Method Detail

getGeometry

public Geometry getGeometry()
Returns:
possible object is <Point <LinearRing <Geometry <Model <LineString <Polygon <MultiGeometry
See Also:
geometry

setGeometry

public void setGeometry(Geometry value)
Parameters:
value - allowed object is <Point <LinearRing <Geometry <Model <LineString <Polygon <MultiGeometry
See Also:
geometry

getPlacemarkSimpleExtension

public java.util.List<java.lang.Object> getPlacemarkSimpleExtension()
See Also:
placemarkSimpleExtension

getPlacemarkObjectExtension

public java.util.List<AbstractObject> getPlacemarkObjectExtension()
See Also:
placemarkObjectExtension

hashCode

public int hashCode()
Overrides:
hashCode in class Feature

equals

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

createAndSetModel

public Model createAndSetModel()
Creates a new instance of Model and set it to geometry. This method is a short version for: Model model = new Model(); this.setGeometry(model);


createAndSetPoint

public Point createAndSetPoint()
Creates a new instance of Point and set it to geometry. This method is a short version for: Point point = new Point(); this.setGeometry(point);


createAndSetPolygon

public Polygon createAndSetPolygon()
Creates a new instance of Polygon and set it to geometry. This method is a short version for: Polygon polygon = new Polygon(); this.setGeometry(polygon);


createAndSetLinearRing

public LinearRing createAndSetLinearRing()
Creates a new instance of LinearRing and set it to geometry. This method is a short version for: LinearRing linearRing = new LinearRing(); this.setGeometry(linearRing);


createAndSetMultiGeometry

public MultiGeometry createAndSetMultiGeometry()
Creates a new instance of MultiGeometry and set it to geometry. This method is a short version for: MultiGeometry multiGeometry = new MultiGeometry(); this.setGeometry(multiGeometry);


createAndSetLineString

public LineString createAndSetLineString()
Creates a new instance of LineString and set it to geometry. This method is a short version for: LineString lineString = new LineString(); this.setGeometry(lineString);


setPlacemarkSimpleExtension

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

addToPlacemarkSimpleExtension

public Placemark addToPlacemarkSimpleExtension(java.lang.Object placemarkSimpleExtension)
add a value to the placemarkSimpleExtension property collection

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

setPlacemarkObjectExtension

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

addToPlacemarkObjectExtension

public Placemark addToPlacemarkObjectExtension(AbstractObject placemarkObjectExtension)
add a value to the placemarkObjectExtension property collection

Parameters:
placemarkObjectExtension - 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 Feature
See Also:
objectSimpleExtension

addToObjectSimpleExtension

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

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

setStyleSelector

public void setStyleSelector(java.util.List<StyleSelector> styleSelector)
Overrides:
setStyleSelector in class Feature
See Also:
styleSelector

addToStyleSelector

public Placemark addToStyleSelector(StyleSelector styleSelector)
Description copied from class: Feature
add a value to the styleSelector property collection

Overrides:
addToStyleSelector in class Feature
Parameters:
styleSelector - Objects of the following type are allowed in the list: <StyleSelectorJAXBElement<StyleMapJAXBElement<Style
Returns:
true (as general contract of Collection.add).

setFeatureSimpleExtension

public void setFeatureSimpleExtension(java.util.List<java.lang.Object> featureSimpleExtension)
Overrides:
setFeatureSimpleExtension in class Feature
See Also:
featureSimpleExtension

addToFeatureSimpleExtension

public Placemark addToFeatureSimpleExtension(java.lang.Object featureSimpleExtension)
Description copied from class: Feature
add a value to the featureSimpleExtension property collection

Overrides:
addToFeatureSimpleExtension in class Feature
Parameters:
featureSimpleExtension - Objects of the following type are allowed in the list: <ObjectJAXBElement<Boolean
Returns:
true (as general contract of Collection.add).

setFeatureObjectExtension

public void setFeatureObjectExtension(java.util.List<AbstractObject> featureObjectExtension)
Overrides:
setFeatureObjectExtension in class Feature
See Also:
featureObjectExtension

addToFeatureObjectExtension

public Placemark addToFeatureObjectExtension(AbstractObject featureObjectExtension)
Description copied from class: Feature
add a value to the featureObjectExtension property collection

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

withGeometry

public Placemark withGeometry(Geometry geometry)
fluent setter

Parameters:
geometry - required parameter
See Also:
setGeometry(Geometry)

withPlacemarkSimpleExtension

public Placemark withPlacemarkSimpleExtension(java.util.List<java.lang.Object> placemarkSimpleExtension)
fluent setter

Parameters:
placemarkSimpleExtension - required parameter
See Also:
#setPlacemarkSimpleExtension(List)

withPlacemarkObjectExtension

public Placemark withPlacemarkObjectExtension(java.util.List<AbstractObject> placemarkObjectExtension)
fluent setter

Parameters:
placemarkObjectExtension - required parameter
See Also:
#setPlacemarkObjectExtension(List)

withObjectSimpleExtension

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

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

withId

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

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

withTargetId

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

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

withName

public Placemark withName(java.lang.String name)
Description copied from class: Feature
fluent setter

Overrides:
withName in class Feature
Parameters:
name - required parameter
See Also:
Feature.setName(String)

withVisibility

public Placemark withVisibility(java.lang.Boolean visibility)
Description copied from class: Feature
fluent setter

Overrides:
withVisibility in class Feature
Parameters:
visibility - required parameter
See Also:
Feature.setVisibility(Boolean)

withOpen

public Placemark withOpen(java.lang.Boolean open)
Description copied from class: Feature
fluent setter

Overrides:
withOpen in class Feature
Parameters:
open - required parameter
See Also:
Feature.setOpen(Boolean)

withAtomAuthor

public Placemark withAtomAuthor(Author atomAuthor)
Description copied from class: Feature
fluent setter

Overrides:
withAtomAuthor in class Feature
Parameters:
atomAuthor - required parameter
See Also:
Feature.setAtomAuthor(Author)

withAtomLink

public Placemark withAtomLink(Link atomLink)
Description copied from class: Feature
fluent setter

Overrides:
withAtomLink in class Feature
Parameters:
atomLink - required parameter
See Also:
Feature.setAtomLink(Link)

withAddress

public Placemark withAddress(java.lang.String address)
Description copied from class: Feature
fluent setter

Overrides:
withAddress in class Feature
Parameters:
address - required parameter
See Also:
Feature.setAddress(String)

withXalAddressDetails

public Placemark withXalAddressDetails(AddressDetails xalAddressDetails)
Description copied from class: Feature
fluent setter

Overrides:
withXalAddressDetails in class Feature
Parameters:
xalAddressDetails - required parameter
See Also:
Feature.setXalAddressDetails(AddressDetails)

withPhoneNumber

public Placemark withPhoneNumber(java.lang.String phoneNumber)
Description copied from class: Feature
fluent setter

Overrides:
withPhoneNumber in class Feature
Parameters:
phoneNumber - required parameter
See Also:
Feature.setPhoneNumber(String)

withSnippet

public Placemark withSnippet(Snippet snippet)
Description copied from class: Feature
fluent setter

Overrides:
withSnippet in class Feature
Parameters:
snippet - required parameter
See Also:
Feature.setSnippet(Snippet)

withSnippetd

public Placemark withSnippetd(java.lang.String snippetd)
Description copied from class: Feature
fluent setter

Overrides:
withSnippetd in class Feature
Parameters:
snippetd - required parameter
See Also:
Feature.setSnippetd(String)

withDescription

public Placemark withDescription(java.lang.String description)
Description copied from class: Feature
fluent setter

Overrides:
withDescription in class Feature
Parameters:
description - required parameter
See Also:
Feature.setDescription(String)

withAbstractView

public Placemark withAbstractView(AbstractView abstractView)
Description copied from class: Feature
fluent setter

Overrides:
withAbstractView in class Feature
Parameters:
abstractView - required parameter
See Also:
Feature.setAbstractView(AbstractView)

withTimePrimitive

public Placemark withTimePrimitive(TimePrimitive timePrimitive)
Description copied from class: Feature
fluent setter

Overrides:
withTimePrimitive in class Feature
Parameters:
timePrimitive - required parameter
See Also:
Feature.setTimePrimitive(TimePrimitive)

withStyleUrl

public Placemark withStyleUrl(java.lang.String styleUrl)
Description copied from class: Feature
fluent setter

Overrides:
withStyleUrl in class Feature
Parameters:
styleUrl - required parameter
See Also:
Feature.setStyleUrl(String)

withStyleSelector

public Placemark withStyleSelector(java.util.List<StyleSelector> styleSelector)
Description copied from class: Feature
fluent setter

Overrides:
withStyleSelector in class Feature
Parameters:
styleSelector - required parameter
See Also:
#setStyleSelector(List)

withRegion

public Placemark withRegion(Region region)
Description copied from class: Feature
fluent setter

Overrides:
withRegion in class Feature
Parameters:
region - required parameter
See Also:
Feature.setRegion(Region)

withMetadata

public Placemark withMetadata(Metadata metadata)
Description copied from class: Feature
fluent setter

Overrides:
withMetadata in class Feature
Parameters:
metadata - required parameter
See Also:
Feature.setMetadata(Metadata)

withExtendedData

public Placemark withExtendedData(ExtendedData extendedData)
Description copied from class: Feature
fluent setter

Overrides:
withExtendedData in class Feature
Parameters:
extendedData - required parameter
See Also:
Feature.setExtendedData(ExtendedData)

withFeatureSimpleExtension

public Placemark withFeatureSimpleExtension(java.util.List<java.lang.Object> featureSimpleExtension)
Description copied from class: Feature
fluent setter

Overrides:
withFeatureSimpleExtension in class Feature
Parameters:
featureSimpleExtension - required parameter
See Also:
#setFeatureSimpleExtension(List)

withFeatureObjectExtension

public Placemark withFeatureObjectExtension(java.util.List<AbstractObject> featureObjectExtension)
Description copied from class: Feature
fluent setter

Overrides:
withFeatureObjectExtension in class Feature
Parameters:
featureObjectExtension - required parameter
See Also:
#setFeatureObjectExtension(List)

clone

public Placemark clone()
Overrides:
clone in class Feature