Package com.luciad.format.kml22.model.feature

Class TLcdKML22Placemark

java.lang.Object
com.luciad.datamodel.TLcdDataObject
com.luciad.format.kml22.model.TLcdKML22AbstractObject
com.luciad.format.kml22.model.feature.TLcdKML22AbstractFeature
com.luciad.format.kml22.model.feature.TLcdKML22Placemark
All Implemented Interfaces:
ILcdDataObject, ILcdBounded, ILcdEditableShapeList, ILcdShape, ILcdShapeList, ILcdTimeBounded, ILcdCache, ILcdCloneable, ILcdDeepCloneable, Serializable, Cloneable
public class TLcdKML22Placemark extends TLcdKML22AbstractFeature implements ILcdEditableShapeList
Domain class modeling the KML PlacemarkType type.

OGC KML Specification description: 

 This element can be used wherever the following element is referenced:

  -kml:AbstractFeatureGroup

 A kml:Placemark is a kml:AbstractFeatureGroup with an associated
 kml:AbstractGeometryGroup.
 A kml:Placemark with a kml:Point geometry should be drawn with an icon to mark the
 kml:Placemark in the geographic view. The point itself determines the position of the
 kml:Placemark's name and display icon.
 kml:Placemark should contain a kml:AbstractGeometryGroup element outside of an
 update context, that is when not a descendant of kml:Update.

Since:
10.0
See Also:

  • Field Details

    • ABSTRACT_GEOMETRY_GROUP_PROPERTY

      public static final TLcdDataProperty ABSTRACT_GEOMETRY_GROUP_PROPERTY
      Data property that maps to the AbstractGeometryGroup element. The possible values for this property are instances of TLcdKML22AbstractGeometry.

    • PLACEMARK_SIMPLE_EXTENSION_GROUP_PROPERTY

      public static final TLcdDataProperty PLACEMARK_SIMPLE_EXTENSION_GROUP_PROPERTY
      Data property that maps to the PlacemarkSimpleExtensionGroup element. The possible values for this property are instances of List<String>.

    • PLACEMARK_OBJECT_EXTENSION_GROUP_PROPERTY

      public static final TLcdDataProperty PLACEMARK_OBJECT_EXTENSION_GROUP_PROPERTY
      Data property that maps to the PlacemarkObjectExtensionGroup element. The possible values for this property are instances of List<TLcdKML22AbstractObject>.

    • NAME_PROPERTY

      public static final TLcdDataProperty NAME_PROPERTY
      Data property that maps to the name element. The possible values for this property are instances of String.

    • VISIBILITY_PROPERTY

      public static final TLcdDataProperty VISIBILITY_PROPERTY
      Data property that maps to the visibility element. The possible values for this property are instances of Boolean.

    • OPEN_PROPERTY

      public static final TLcdDataProperty OPEN_PROPERTY
      Data property that maps to the open element. The possible values for this property are instances of Boolean.

    • AUTHOR_PROPERTY

      public static final TLcdDataProperty AUTHOR_PROPERTY
      Data property that maps to the author element. The possible values for this property are instances of ILcdDataObject.

    • ADDRESS_PROPERTY

      public static final TLcdDataProperty ADDRESS_PROPERTY
      Data property that maps to the address element. The possible values for this property are instances of String.

    • ADDRESS_DETAILS_PROPERTY

      public static final TLcdDataProperty ADDRESS_DETAILS_PROPERTY
      Data property that maps to the AddressDetails element. The possible values for this property are instances of ILcdDataObject.

    • PHONE_NUMBER_PROPERTY

      public static final TLcdDataProperty PHONE_NUMBER_PROPERTY
      Data property that maps to the phoneNumber element. The possible values for this property are instances of String.

    • SNIPPET_PROPERTY

      public static final TLcdDataProperty SNIPPET_PROPERTY
      Data property that maps to the choice between the Snippet and snippet elements. The possible values for this property are instances of

    • DESCRIPTION_PROPERTY

      public static final TLcdDataProperty DESCRIPTION_PROPERTY
      Data property that maps to the description element. The possible values for this property are instances of String.

    • ABSTRACT_VIEW_GROUP_PROPERTY

      public static final TLcdDataProperty ABSTRACT_VIEW_GROUP_PROPERTY
      Data property that maps to the AbstractViewGroup element. The possible values for this property are instances of TLcdKML22AbstractView.

    • ABSTRACT_TIME_PRIMITIVE_GROUP_PROPERTY

      public static final TLcdDataProperty ABSTRACT_TIME_PRIMITIVE_GROUP_PROPERTY
      Data property that maps to the AbstractTimePrimitiveGroup element. The possible values for this property are instances of TLcdKML22AbstractTimePrimitive.

    • STYLE_URL_PROPERTY

      public static final TLcdDataProperty STYLE_URL_PROPERTY
      Data property that maps to the styleUrl element. The possible values for this property are instances of String.

    • ABSTRACT_STYLE_SELECTOR_GROUP_PROPERTY

      public static final TLcdDataProperty ABSTRACT_STYLE_SELECTOR_GROUP_PROPERTY
      Data property that maps to the AbstractStyleSelectorGroup element. The possible values for this property are instances of List<TLcdKML22AbstractStyleSelector>.

    • REGION_PROPERTY

      public static final TLcdDataProperty REGION_PROPERTY
      Data property that maps to the Region element. The possible values for this property are instances of TLcdKML22Region.

    • EXTENDED_DATA_PROPERTY

      public static final TLcdDataProperty EXTENDED_DATA_PROPERTY
      Data property that maps to the choice between the Metadata and ExtendedData elements. The possible values for this property are instances of

    • ABSTRACT_FEATURE_SIMPLE_EXTENSION_GROUP_PROPERTY

      public static final TLcdDataProperty ABSTRACT_FEATURE_SIMPLE_EXTENSION_GROUP_PROPERTY
      Data property that maps to the AbstractFeatureSimpleExtensionGroup element. The possible values for this property are instances of List<String>.

    • ABSTRACT_FEATURE_OBJECT_EXTENSION_GROUP_PROPERTY

      public static final TLcdDataProperty ABSTRACT_FEATURE_OBJECT_EXTENSION_GROUP_PROPERTY
      Data property that maps to the AbstractFeatureObjectExtensionGroup element. The possible values for this property are instances of List<TLcdKML22AbstractObject>.

  • Constructor Details

    • TLcdKML22Placemark

      public TLcdKML22Placemark(TLcdDataType aType)
      Creates a new TLcdKML22Placemark with a custom TLcdDataType.
      Parameters:
      aType - a custom TLcdDataType

  • Method Details

    • addShape

      public void addShape(int aIndex, ILcdShape aShape)
      Description copied from interface: ILcdEditableShapeList
      Inserts the specified shape at the specified position in this ILcdShapeList.
      Specified by:
      addShape in interface ILcdEditableShapeList
      Parameters:
      aIndex - the index at which the shape is to be inserted.
      aShape - the shape to be inserted.

    • addShape

      public void addShape(ILcdShape aShape)
      Description copied from interface: ILcdEditableShapeList
      Appends the specified shape to the end of this ILcdShapeList.
      Specified by:
      addShape in interface ILcdEditableShapeList
      Parameters:
      aShape - the shape to be appended to this ILcdShapeList.

    • addShapes

      public void addShapes(ILcdShape[] aShapes)
      Description copied from interface: ILcdEditableShapeList
      Appends the specified array of shapes to the end of this ILcdShapeList.
      Specified by:
      addShapes in interface ILcdEditableShapeList
      Parameters:
      aShapes - the array of shapes to be appended to this ILcdShapeList.

    • clearShapes

      public void clearShapes()
      Description copied from interface: ILcdEditableShapeList
      Removes all of the shapes from this ILcdShapeList.
      Specified by:
      clearShapes in interface ILcdEditableShapeList

    • removeShape

      public ILcdShape removeShape(int aIndex)
      Description copied from interface: ILcdEditableShapeList
      Removes the shape at the specified position in this ILcdShapeList. Shifts any subsequent shapes to the left. Returns the shape that was removed from this ILcdShapeList.
      Specified by:
      removeShape in interface ILcdEditableShapeList
      Parameters:
      aIndex - the index of the shape to removed.
      Returns:
      the shape previously at the specified position.

    • removeShape

      public boolean removeShape(ILcdShape aShape)
      Description copied from interface: ILcdEditableShapeList
      Removes the first occurrence of the specified shape in this ILcdShapeList. If this ILcdShapeList does not contain the shape, it is unchanged.
      Specified by:
      removeShape in interface ILcdEditableShapeList
      Parameters:
      aShape - the shape to be removed, if present.
      Returns:
      true if this ILcdShapeList contained the specified element.

    • removeShapes

      public void removeShapes(ILcdShape[] aShapes)
      Description copied from interface: ILcdEditableShapeList
      Removes all shapes from this ILcdShapeList that are contained in the specified array of shapes.
      Specified by:
      removeShapes in interface ILcdEditableShapeList
      Parameters:
      aShapes - the array of shapes to be removed from this ILcdShapeList.

    • setShape

      public ILcdShape setShape(int aIndex, ILcdShape aShape)
      Description copied from interface: ILcdEditableShapeList
      Replaces the shape at the specified position in this ILcdShapeList with the specified shape.
      Specified by:
      setShape in interface ILcdEditableShapeList
      Parameters:
      aIndex - index of shape to replace.
      aShape - the shape to be stored at the specified position.
      Returns:
      the shape previously at the specified position.

    • setShapes

      public void setShapes(ILcdShape[] aShapes)
      Description copied from interface: ILcdEditableShapeList
      Replace the list of shapes contained in this ILcdShapeList with the specified array of shapes.
      Specified by:
      setShapes in interface ILcdEditableShapeList
      Parameters:
      aShapes - the array of shapes to be stored in this ILcdShapeList.

    • shapeChanged

      public void shapeChanged(int aIndex)
      Description copied from interface: ILcdEditableShapeList
      Notifies this ILcdShapeList that the shape at the specified position has changed.
      Specified by:
      shapeChanged in interface ILcdEditableShapeList
      Parameters:
      aIndex - the index of the shape that has changed.

    • shapeChanged

      public void shapeChanged(ILcdShape aShape)
      Description copied from interface: ILcdEditableShapeList
      Notifies this ILcdShapeList that the specified shape has changed.
      Specified by:
      shapeChanged in interface ILcdEditableShapeList
      Parameters:
      aShape - the shape that has changed.

    • shapesChanged

      public void shapesChanged()
      Description copied from interface: ILcdEditableShapeList
      Notifies this ILcdShapeList that some (possibly all) of its shapes have changed.
      Specified by:
      shapesChanged in interface ILcdEditableShapeList

    • getShapeCount

      public int getShapeCount()
      Description copied from interface: ILcdShapeList
      Returns the number of ILcdShape objects in the list.
      Specified by:
      getShapeCount in interface ILcdShapeList
      Returns:
      the number of ILcdShape objects in the list.

    • getShape

      public ILcdShape getShape(int aIndex)
      Description copied from interface: ILcdShapeList
      Returns the ILcdShape at the given index.
      Specified by:
      getShape in interface ILcdShapeList
      Parameters:
      aIndex - a valid index in the list of ILcdShape objects.
      Returns:
      the ILcdShape at the given index.

    • contains2D

      public boolean contains2D(ILcdPoint aPoint)
      Description copied from interface: ILcdShape
      Checks whether this ILcdShape contains the given ILcdPoint in the 2D space. Only the first two dimensions of the ILcdShape and the ILcdPoint are considered.
      Specified by:
      contains2D in interface ILcdShape
      Parameters:
      aPoint - the ILcdPoint to test.
      Returns:
      the boolean result of the containment test.
      See Also:

    • contains3D

      public boolean contains3D(ILcdPoint aPoint)
      Description copied from interface: ILcdShape
      Checks whether this ILcdShape contains the given ILcdPoint in the 3D space.
      Specified by:
      contains3D in interface ILcdShape
      Parameters:
      aPoint - the ILcdPoint to test.
      Returns:
      the boolean result of the containment test.
      See Also:

    • contains3D

      public boolean contains3D(double aX, double aY, double aZ)
      Description copied from interface: ILcdShape
      Checks whether this ILcdShape contains the given point in the 3D space.
      Specified by:
      contains3D in interface ILcdShape
      Parameters:
      aX - the x coordinate of the point.
      aY - the y coordinate of the point.
      aZ - the z coordinate of the point.
      Returns:
      the boolean result of the containment test.

    • contains2D

      public boolean contains2D(double aX, double aY)
      Description copied from interface: ILcdShape
      Checks whether this ILcdShape contains the given point in the 2D space. Only the first two dimensions of the ILcdShape are considered.
      Specified by:
      contains2D in interface ILcdShape
      Parameters:
      aX - the x coordinate of the point.
      aY - the y coordinate of the point.
      Returns:
      the boolean result of the containment test.

    • getFocusPoint

      public ILcdPoint getFocusPoint()
      Description copied from interface: ILcdShape
      Returns the focus point of this ILcdShape.
      Specified by:
      getFocusPoint in interface ILcdShape
      Returns:
      the focus point of this ILcdShape.

    • clone

      public TLcdKML22Placemark clone()
      Description copied from class: TLcdDataObject
      Returns a deep clone of this object. This method delegates to TLcdDataObject.clone(Map).
      Specified by:
      clone in interface ILcdCloneable
      Overrides:
      clone in class TLcdDataObject
      Returns:
      a deep clone of this object
      See Also:

    • clone

      public TLcdDataObject clone(Map aObjectDictionary)
      Description copied from class: TLcdDataObject
      Returns a deep clone of this object. If the clone is not already present in the dictionary, a new instance if created as follows:
      • First, a new instance is created using Java's clone() mechanism.
      • Then, all properties of this object are cloned and set on the newly created instance. A property is cloned as follows:
        • If the property value is an ILcdDataObject, the value is cloned by first creating a new instance via the value.getDataType().newInstance() method, and then cloning its properties one by one.
        • If the value implements ILcdDeepCloneable or ILcdCloneable then this interface is used to clone the value.
        • Otherwise, the property value is copied by reference.
      Specified by:
      clone in interface ILcdDeepCloneable
      Overrides:
      clone in class TLcdKML22AbstractFeature
      Parameters:
      aObjectDictionary - the Object dictionary that keeps track of the objects for which a clone has already been made, and their corresponding clone Object.
      Returns:
      a deep clone of this object

    • getBounds

      public ILcdBounds getBounds()
      Description copied from interface: ILcdBounded
      Returns the ILcdBounds by which the geometry of this ILcdBounded object is bounded.

      If the geometry does not allow retrieving valid bounds (for example a polyline with 0 points) the return value is unspecified. It is highly recommended to return an undefined bounds. You can create undefined bounds using the default constructors of TLcdLonLatBounds or TLcdXYBounds.

      Specified by:
      getBounds in interface ILcdBounded
      Returns:
      the ILcdBounds by which the geometry of this ILcdBounded object is bounded.

    • getAbstractGeometryGroup

      public TLcdKML22AbstractGeometry getAbstractGeometryGroup()
      Returns the value of the property that maps to the AbstractGeometryGroup element.
      Returns:
      the value of the ABSTRACT_GEOMETRY_GROUP_PROPERTY property.

    • setAbstractGeometryGroup

      public void setAbstractGeometryGroup(TLcdKML22AbstractGeometry aValue)
      Sets the value of the property that maps to the AbstractGeometryGroup element.
      Parameters:
      aValue - the value to set for the ABSTRACT_GEOMETRY_GROUP_PROPERTY property.

    • getName

      public String getName()
      Returns the value of the property that maps to the name element.
      Returns:
      the value of the NAME_PROPERTY property.

    • setName

      public void setName(String aValue)
      Sets the value of the property that maps to the name element.
      Parameters:
      aValue - the value to set for the NAME_PROPERTY property.

    • setVisibility

      public void setVisibility(Boolean aValue)
      Sets the value of the property that maps to the visibility element.
      Parameters:
      aValue - the value to set for the VISIBILITY_PROPERTY property.

    • getOpen

      public Boolean getOpen()
      Returns the value of the property that maps to the open element.
      Returns:
      the value of the OPEN_PROPERTY property.

    • setOpen

      public void setOpen(Boolean aValue)
      Sets the value of the property that maps to the open element.
      Parameters:
      aValue - the value to set for the OPEN_PROPERTY property.

    • getAuthor

      public ILcdDataObject getAuthor()
      Returns the value of the property that maps to the author element.
      Returns:
      the value of the AUTHOR_PROPERTY property.

    • setAuthor

      public void setAuthor(ILcdDataObject aValue)
      Sets the value of the property that maps to the author element.
      Parameters:
      aValue - the value to set for the AUTHOR_PROPERTY property.

    • getAtomLink

      public ILcdDataObject getAtomLink()
      Returns the value of the property that maps to the link element.
      Returns:
      the value of the ATOM_LINK_PROPERTY property.

    • setAtomLink

      public void setAtomLink(ILcdDataObject aValue)
      Sets the value of the property that maps to the link element.
      Parameters:
      aValue - the value to set for the ATOM_LINK_PROPERTY property.

    • getAddress

      public String getAddress()
      Returns the value of the property that maps to the address element.
      Returns:
      the value of the ADDRESS_PROPERTY property.

    • setAddress

      public void setAddress(String aValue)
      Sets the value of the property that maps to the address element.
      Parameters:
      aValue - the value to set for the ADDRESS_PROPERTY property.

    • getAddressDetails

      public ILcdDataObject getAddressDetails()
      Returns the value of the property that maps to the AddressDetails element.

      This container defines the details of the address. Can define multiple addresses including tracking address history

      Returns:
      the value of the ADDRESS_DETAILS_PROPERTY property.

    • setAddressDetails

      public void setAddressDetails(ILcdDataObject aValue)
      Sets the value of the property that maps to the AddressDetails element.

      This container defines the details of the address. Can define multiple addresses including tracking address history

      Parameters:
      aValue - the value to set for the ADDRESS_DETAILS_PROPERTY property.

    • getPhoneNumber

      public String getPhoneNumber()
      Returns the value of the property that maps to the phoneNumber element.
      Returns:
      the value of the PHONE_NUMBER_PROPERTY property.

    • setPhoneNumber

      public void setPhoneNumber(String aValue)
      Sets the value of the property that maps to the phoneNumber element.
      Parameters:
      aValue - the value to set for the PHONE_NUMBER_PROPERTY property.

    • getSnippet

      public TLcdKML22Snippet getSnippet()
      Returns the value of the property that maps to the choice between the Snippet and snippet elements.

      The possible values for this property are instances of

      Returns:
      the value of the SNIPPET_PROPERTY property.

    • setSnippet

      public void setSnippet(TLcdKML22Snippet aValue)
      Sets the value of the property that maps to the choice between the Snippet and snippet elements.

      The possible values for this property are instances of

      Parameters:
      aValue - the value to set for the SNIPPET_PROPERTY property.

    • getDescription

      public String getDescription()
      Returns the value of the property that maps to the description element.
      Returns:
      the value of the DESCRIPTION_PROPERTY property.

    • setDescription

      public void setDescription(String aValue)
      Sets the value of the property that maps to the description element.
      Parameters:
      aValue - the value to set for the DESCRIPTION_PROPERTY property.

    • getAbstractViewGroup

      public TLcdKML22AbstractView getAbstractViewGroup()
      Returns the value of the property that maps to the AbstractViewGroup element.
      Returns:
      the value of the ABSTRACT_VIEW_GROUP_PROPERTY property.

    • setAbstractViewGroup

      public void setAbstractViewGroup(TLcdKML22AbstractView aValue)
      Sets the value of the property that maps to the AbstractViewGroup element.
      Parameters:
      aValue - the value to set for the ABSTRACT_VIEW_GROUP_PROPERTY property.

    • getAbstractTimePrimitiveGroup

      public TLcdKML22AbstractTimePrimitive getAbstractTimePrimitiveGroup()
      Returns the value of the property that maps to the AbstractTimePrimitiveGroup element.
      Returns:
      the value of the ABSTRACT_TIME_PRIMITIVE_GROUP_PROPERTY property.

    • setAbstractTimePrimitiveGroup

      public void setAbstractTimePrimitiveGroup(TLcdKML22AbstractTimePrimitive aValue)
      Sets the value of the property that maps to the AbstractTimePrimitiveGroup element.
      Parameters:
      aValue - the value to set for the ABSTRACT_TIME_PRIMITIVE_GROUP_PROPERTY property.

    • getStyleUrl

      public String getStyleUrl()
      Returns the value of the property that maps to the styleUrl element.
      Returns:
      the value of the STYLE_URL_PROPERTY property.

    • setStyleUrl

      public void setStyleUrl(String aValue)
      Sets the value of the property that maps to the styleUrl element.
      Parameters:
      aValue - the value to set for the STYLE_URL_PROPERTY property.

    • getAbstractStyleSelectorGroup

      public List<TLcdKML22AbstractStyleSelector> getAbstractStyleSelectorGroup()
      Returns the value of the property that maps to the AbstractStyleSelectorGroup element.
      Returns:
      the value of the ABSTRACT_STYLE_SELECTOR_GROUP_PROPERTY property.

    • getRegion

      public TLcdKML22Region getRegion()
      Returns the value of the property that maps to the Region element.
      Returns:
      the value of the REGION_PROPERTY property.

    • setRegion

      public void setRegion(TLcdKML22Region aValue)
      Sets the value of the property that maps to the Region element.
      Parameters:
      aValue - the value to set for the REGION_PROPERTY property.

    • getExtendedData

      public ILcdDataObject getExtendedData()
      Returns the value of the property that maps to the choice between the Metadata and ExtendedData elements.

      The possible values for this property are instances of

      Returns:
      the value of the EXTENDED_DATA_PROPERTY property.

    • setExtendedData

      public void setExtendedData(ILcdDataObject aValue)
      Sets the value of the property that maps to the choice between the Metadata and ExtendedData elements.

      The possible values for this property are instances of

      Parameters:
      aValue - the value to set for the EXTENDED_DATA_PROPERTY property.