public class TLcdKML22Placemark extends TLcdKML22AbstractFeature implements ILcdEditableShapeList
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.
Modifier and Type | Field and Description |
---|---|
static TLcdDataProperty |
ABSTRACT_FEATURE_OBJECT_EXTENSION_GROUP_PROPERTY
Data property that maps to the
AbstractFeatureObjectExtensionGroup element. |
static TLcdDataProperty |
ABSTRACT_FEATURE_SIMPLE_EXTENSION_GROUP_PROPERTY
Data property that maps to the
AbstractFeatureSimpleExtensionGroup element. |
static TLcdDataProperty |
ABSTRACT_GEOMETRY_GROUP_PROPERTY
Data property that maps to the
AbstractGeometryGroup element. |
static TLcdDataProperty |
ABSTRACT_STYLE_SELECTOR_GROUP_PROPERTY
Data property that maps to the
AbstractStyleSelectorGroup element. |
static TLcdDataProperty |
ABSTRACT_TIME_PRIMITIVE_GROUP_PROPERTY
Data property that maps to the
AbstractTimePrimitiveGroup element. |
static TLcdDataProperty |
ABSTRACT_VIEW_GROUP_PROPERTY
Data property that maps to the
AbstractViewGroup element. |
static TLcdDataProperty |
ADDRESS_DETAILS_PROPERTY
Data property that maps to the
AddressDetails element. |
static TLcdDataProperty |
ADDRESS_PROPERTY
Data property that maps to the
address element. |
static TLcdDataProperty |
ATOM_LINK_PROPERTY
Data property that maps to the
link element. |
static TLcdDataProperty |
AUTHOR_PROPERTY
Data property that maps to the
author element. |
static TLcdDataProperty |
DESCRIPTION_PROPERTY
Data property that maps to the
description element. |
static TLcdDataProperty |
EXTENDED_DATA_PROPERTY
Data property that maps to the choice between the
Metadata and ExtendedData elements. |
static TLcdDataProperty |
NAME_PROPERTY
Data property that maps to the
name element. |
static TLcdDataProperty |
OPEN_PROPERTY
Data property that maps to the
open element. |
static TLcdDataProperty |
PHONE_NUMBER_PROPERTY
Data property that maps to the
phoneNumber element. |
static TLcdDataProperty |
PLACEMARK_OBJECT_EXTENSION_GROUP_PROPERTY
Data property that maps to the
PlacemarkObjectExtensionGroup element. |
static TLcdDataProperty |
PLACEMARK_SIMPLE_EXTENSION_GROUP_PROPERTY
Data property that maps to the
PlacemarkSimpleExtensionGroup element. |
static TLcdDataProperty |
REGION_PROPERTY
Data property that maps to the
Region element. |
static TLcdDataProperty |
SNIPPET_PROPERTY
Data property that maps to the choice between the
Snippet and snippet elements. |
static TLcdDataProperty |
STYLE_URL_PROPERTY
Data property that maps to the
styleUrl element. |
static TLcdDataProperty |
VISIBILITY_PROPERTY
Data property that maps to the
visibility element. |
ID_PROPERTY, OBJECT_SIMPLE_EXTENSION_GROUP_PROPERTY, TARGET_ID_PROPERTY
Constructor and Description |
---|
TLcdKML22Placemark(TLcdDataType aType)
Creates a new
TLcdKML22Placemark with a custom TLcdDataType . |
Modifier and Type | Method and Description |
---|---|
void |
addShape(ILcdShape aShape)
Appends the specified shape to the end of this
ILcdShapeList . |
void |
addShape(int aIndex,
ILcdShape aShape)
Inserts the specified shape at the specified position in this
ILcdShapeList . |
void |
addShapes(ILcdShape[] aShapes)
Appends the specified array of shapes to the end of this
ILcdShapeList . |
void |
clearShapes()
Removes all of the shapes from this
ILcdShapeList . |
TLcdKML22Placemark |
clone()
Returns a deep clone of this object.
|
TLcdDataObject |
clone(Map aObjectDictionary)
Returns a deep clone of this object.
|
boolean |
contains2D(double aX,
double aY)
Checks whether this
ILcdShape contains the given point in
the 2D space. |
boolean |
contains2D(ILcdPoint aPoint)
Checks whether this
ILcdShape contains the given ILcdPoint in the 2D space. |
boolean |
contains3D(double aX,
double aY,
double aZ)
Checks whether this
ILcdShape contains the given point in
the 3D space. |
boolean |
contains3D(ILcdPoint aPoint)
Checks whether this
ILcdShape contains the given ILcdPoint in the 3D space. |
TLcdKML22AbstractGeometry |
getAbstractGeometryGroup()
Returns the value of the property that maps to the
AbstractGeometryGroup element. |
List<TLcdKML22AbstractStyleSelector> |
getAbstractStyleSelectorGroup()
Returns the value of the property that maps to the
AbstractStyleSelectorGroup element. |
TLcdKML22AbstractTimePrimitive |
getAbstractTimePrimitiveGroup()
Returns the value of the property that maps to the
AbstractTimePrimitiveGroup element. |
TLcdKML22AbstractView |
getAbstractViewGroup()
Returns the value of the property that maps to the
AbstractViewGroup element. |
String |
getAddress()
Returns the value of the property that maps to the
address element. |
ILcdDataObject |
getAddressDetails()
Returns the value of the property that maps to the
AddressDetails element. |
ILcdDataObject |
getAtomLink()
Returns the value of the property that maps to the
link element. |
ILcdDataObject |
getAuthor()
Returns the value of the property that maps to the
author element. |
ILcdBounds |
getBounds()
Returns the
ILcdBounds by which the geometry of this ILcdBounded object
is bounded. |
String |
getDescription()
Returns the value of the property that maps to the
description element. |
ILcdDataObject |
getExtendedData()
Returns the value of the property that maps to the choice between the
Metadata and ExtendedData elements. |
ILcdPoint |
getFocusPoint()
Returns the focus point of this
ILcdShape . |
String |
getName()
Returns the value of the property that maps to the
name element. |
Boolean |
getOpen()
Returns the value of the property that maps to the
open element. |
String |
getPhoneNumber()
Returns the value of the property that maps to the
phoneNumber element. |
TLcdKML22Region |
getRegion()
Returns the value of the property that maps to the
Region element. |
ILcdShape |
getShape(int aIndex)
Returns the
ILcdShape at the given index. |
int |
getShapeCount()
Returns the number of
ILcdShape objects in the list. |
TLcdKML22Snippet |
getSnippet()
Returns the value of the property that maps to the choice between the
Snippet and snippet elements. |
String |
getStyleUrl()
Returns the value of the property that maps to the
styleUrl element. |
boolean |
removeShape(ILcdShape aShape)
Removes the first occurrence of the specified shape in this
ILcdShapeList . |
ILcdShape |
removeShape(int aIndex)
Removes the shape at the specified position in this
ILcdShapeList . |
void |
removeShapes(ILcdShape[] aShapes)
Removes all shapes from this
ILcdShapeList that are contained in the specified
array of shapes. |
void |
setAbstractGeometryGroup(TLcdKML22AbstractGeometry aValue)
Sets the value of the property that maps to the
AbstractGeometryGroup element. |
void |
setAbstractTimePrimitiveGroup(TLcdKML22AbstractTimePrimitive aValue)
Sets the value of the property that maps to the
AbstractTimePrimitiveGroup element. |
void |
setAbstractViewGroup(TLcdKML22AbstractView aValue)
Sets the value of the property that maps to the
AbstractViewGroup element. |
void |
setAddress(String aValue)
Sets the value of the property that maps to the
address element. |
void |
setAddressDetails(ILcdDataObject aValue)
Sets the value of the property that maps to the
AddressDetails element. |
void |
setAtomLink(ILcdDataObject aValue)
Sets the value of the property that maps to the
link element. |
void |
setAuthor(ILcdDataObject aValue)
Sets the value of the property that maps to the
author element. |
void |
setDescription(String aValue)
Sets the value of the property that maps to the
description element. |
void |
setExtendedData(ILcdDataObject aValue)
Sets the value of the property that maps to the choice between the
Metadata and ExtendedData elements. |
void |
setName(String aValue)
Sets the value of the property that maps to the
name element. |
void |
setOpen(Boolean aValue)
Sets the value of the property that maps to the
open element. |
void |
setPhoneNumber(String aValue)
Sets the value of the property that maps to the
phoneNumber element. |
void |
setRegion(TLcdKML22Region aValue)
Sets the value of the property that maps to the
Region element. |
ILcdShape |
setShape(int aIndex,
ILcdShape aShape)
Replaces the shape at the specified position in this
ILcdShapeList with the
specified shape. |
void |
setShapes(ILcdShape[] aShapes)
Replace the list of shapes contained in this
ILcdShapeList with the specified
array of shapes. |
void |
setSnippet(TLcdKML22Snippet aValue)
Sets the value of the property that maps to the choice between the
Snippet and snippet elements. |
void |
setStyleUrl(String aValue)
Sets the value of the property that maps to the
styleUrl element. |
void |
setVisibility(Boolean aValue)
Sets the value of the property that maps to the
visibility element. |
void |
shapeChanged(ILcdShape aShape)
Notifies this
ILcdShapeList that the specified shape has changed. |
void |
shapeChanged(int aIndex)
Notifies this
ILcdShapeList that the shape at the specified position has changed. |
void |
shapesChanged()
Notifies this
ILcdShapeList that some (possibly all) of its shapes have changed. |
clearCache, getCachedObject, getInnerStyleSelector, getKMLSourceName, getTimeBounds, getVisibility, insertIntoCache, removeCachedObject, setKMLSourceName
getId, getTargetId, setId, setTargetId
getDataType, getValue, getValue, hasValue, hasValue, setValue, setValue, toString
public static final TLcdDataProperty ABSTRACT_GEOMETRY_GROUP_PROPERTY
AbstractGeometryGroup
element.
The possible values for this property are instances of TLcdKML22AbstractGeometry
.public static final TLcdDataProperty PLACEMARK_SIMPLE_EXTENSION_GROUP_PROPERTY
PlacemarkSimpleExtensionGroup
element.
The possible values for this property are instances of List<String>
.public static final TLcdDataProperty PLACEMARK_OBJECT_EXTENSION_GROUP_PROPERTY
PlacemarkObjectExtensionGroup
element.
The possible values for this property are instances of List<TLcdKML22AbstractObject>
.public static final TLcdDataProperty NAME_PROPERTY
name
element.
The possible values for this property are instances of String
.public static final TLcdDataProperty VISIBILITY_PROPERTY
visibility
element.
The possible values for this property are instances of Boolean
.public static final TLcdDataProperty OPEN_PROPERTY
open
element.
The possible values for this property are instances of Boolean
.public static final TLcdDataProperty AUTHOR_PROPERTY
author
element.
The possible values for this property are instances of ILcdDataObject
.public static final TLcdDataProperty ATOM_LINK_PROPERTY
link
element.
The possible values for this property are instances of ILcdDataObject
.public static final TLcdDataProperty ADDRESS_PROPERTY
address
element.
The possible values for this property are instances of String
.public static final TLcdDataProperty ADDRESS_DETAILS_PROPERTY
AddressDetails
element.
The possible values for this property are instances of ILcdDataObject
.public static final TLcdDataProperty PHONE_NUMBER_PROPERTY
phoneNumber
element.
The possible values for this property are instances of String
.public static final TLcdDataProperty SNIPPET_PROPERTY
Snippet
and snippet
elements.
The possible values for this property are instances of
TLcdKML22Snippet
String
public static final TLcdDataProperty DESCRIPTION_PROPERTY
description
element.
The possible values for this property are instances of String
.public static final TLcdDataProperty ABSTRACT_VIEW_GROUP_PROPERTY
AbstractViewGroup
element.
The possible values for this property are instances of TLcdKML22AbstractView
.public static final TLcdDataProperty ABSTRACT_TIME_PRIMITIVE_GROUP_PROPERTY
AbstractTimePrimitiveGroup
element.
The possible values for this property are instances of TLcdKML22AbstractTimePrimitive
.public static final TLcdDataProperty STYLE_URL_PROPERTY
styleUrl
element.
The possible values for this property are instances of String
.public static final TLcdDataProperty ABSTRACT_STYLE_SELECTOR_GROUP_PROPERTY
AbstractStyleSelectorGroup
element.
The possible values for this property are instances of List<TLcdKML22AbstractStyleSelector>
.public static final TLcdDataProperty REGION_PROPERTY
Region
element.
The possible values for this property are instances of TLcdKML22Region
.public static final TLcdDataProperty EXTENDED_DATA_PROPERTY
Metadata
and ExtendedData
elements.
The possible values for this property are instances of
public static final TLcdDataProperty ABSTRACT_FEATURE_SIMPLE_EXTENSION_GROUP_PROPERTY
AbstractFeatureSimpleExtensionGroup
element.
The possible values for this property are instances of List<String>
.public static final TLcdDataProperty ABSTRACT_FEATURE_OBJECT_EXTENSION_GROUP_PROPERTY
AbstractFeatureObjectExtensionGroup
element.
The possible values for this property are instances of List<TLcdKML22AbstractObject>
.public TLcdKML22Placemark(TLcdDataType aType)
TLcdKML22Placemark
with a custom TLcdDataType
.aType
- a custom TLcdDataType
public void addShape(int aIndex, ILcdShape aShape)
ILcdEditableShapeList
ILcdShapeList
.addShape
in interface ILcdEditableShapeList
aIndex
- the index at which the shape is to be inserted.aShape
- the shape to be inserted.public void addShape(ILcdShape aShape)
ILcdEditableShapeList
ILcdShapeList
.addShape
in interface ILcdEditableShapeList
aShape
- the shape to be appended to this ILcdShapeList
.public void addShapes(ILcdShape[] aShapes)
ILcdEditableShapeList
ILcdShapeList
.addShapes
in interface ILcdEditableShapeList
aShapes
- the array of shapes to be appended to this ILcdShapeList
.public void clearShapes()
ILcdEditableShapeList
ILcdShapeList
.clearShapes
in interface ILcdEditableShapeList
public ILcdShape removeShape(int aIndex)
ILcdEditableShapeList
ILcdShapeList
. Shifts any
subsequent shapes to the left. Returns the shape that was removed from this
ILcdShapeList
.removeShape
in interface ILcdEditableShapeList
aIndex
- the index of the shape to removed.public boolean removeShape(ILcdShape aShape)
ILcdEditableShapeList
ILcdShapeList
. If this
ILcdShapeList
does not contain the shape, it is unchanged.removeShape
in interface ILcdEditableShapeList
aShape
- the shape to be removed, if present.true
if this ILcdShapeList
contained the specified element.public void removeShapes(ILcdShape[] aShapes)
ILcdEditableShapeList
ILcdShapeList
that are contained in the specified
array of shapes.removeShapes
in interface ILcdEditableShapeList
aShapes
- the array of shapes to be removed from this ILcdShapeList
.public ILcdShape setShape(int aIndex, ILcdShape aShape)
ILcdEditableShapeList
ILcdShapeList
with the
specified shape.setShape
in interface ILcdEditableShapeList
aIndex
- index of shape to replace.aShape
- the shape to be stored at the specified position.public void setShapes(ILcdShape[] aShapes)
ILcdEditableShapeList
ILcdShapeList
with the specified
array of shapes.setShapes
in interface ILcdEditableShapeList
aShapes
- the array of shapes to be stored in this ILcdShapeList
.public void shapeChanged(int aIndex)
ILcdEditableShapeList
ILcdShapeList
that the shape at the specified position has changed.shapeChanged
in interface ILcdEditableShapeList
aIndex
- the index of the shape that has changed.public void shapeChanged(ILcdShape aShape)
ILcdEditableShapeList
ILcdShapeList
that the specified shape has changed.shapeChanged
in interface ILcdEditableShapeList
aShape
- the shape that has changed.public void shapesChanged()
ILcdEditableShapeList
ILcdShapeList
that some (possibly all) of its shapes have changed.shapesChanged
in interface ILcdEditableShapeList
public int getShapeCount()
ILcdShapeList
ILcdShape
objects in the list.getShapeCount
in interface ILcdShapeList
ILcdShape
objects in the list.public ILcdShape getShape(int aIndex)
ILcdShapeList
ILcdShape
at the given index.getShape
in interface ILcdShapeList
aIndex
- a valid index in the list of ILcdShape
objects.ILcdShape
at the given index.public boolean contains2D(ILcdPoint aPoint)
ILcdShape
ILcdShape
contains the given ILcdPoint
in the 2D space.
Only the first two dimensions of the ILcdShape
and the ILcdPoint
are considered.contains2D
in interface ILcdShape
aPoint
- the ILcdPoint
to test.ILcdShape.contains2D(double, double)
public boolean contains3D(ILcdPoint aPoint)
ILcdShape
ILcdShape
contains the given ILcdPoint
in the 3D space.contains3D
in interface ILcdShape
aPoint
- the ILcdPoint
to test.ILcdShape.contains3D(double, double, double)
public boolean contains3D(double aX, double aY, double aZ)
ILcdShape
ILcdShape
contains the given point in
the 3D space.contains3D
in interface ILcdShape
aX
- the x coordinate of the point.aY
- the y coordinate of the point.aZ
- the z coordinate of the point.public boolean contains2D(double aX, double aY)
ILcdShape
ILcdShape
contains the given point in
the 2D space. Only the first two dimensions of the ILcdShape
are considered.contains2D
in interface ILcdShape
aX
- the x coordinate of the point.aY
- the y coordinate of the point.public ILcdPoint getFocusPoint()
ILcdShape
ILcdShape
.getFocusPoint
in interface ILcdShape
ILcdShape
.public TLcdKML22Placemark clone()
TLcdDataObject
TLcdDataObject.clone(Map)
.clone
in interface ILcdCloneable
clone
in class TLcdDataObject
Object.clone()
public TLcdDataObject clone(Map aObjectDictionary)
TLcdDataObject
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.ILcdDeepCloneable
or
ILcdCloneable
then this interface is used to clone the value.clone
in interface ILcdDeepCloneable
clone
in class TLcdKML22AbstractFeature
aObjectDictionary
- the Object dictionary that keeps track of the objects for which a clone has already been made,
and their corresponding clone Object.public ILcdBounds getBounds()
ILcdBounded
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
.
getBounds
in interface ILcdBounded
ILcdBounds
by which the geometry of this ILcdBounded
object
is bounded.public TLcdKML22AbstractGeometry getAbstractGeometryGroup()
AbstractGeometryGroup
element.ABSTRACT_GEOMETRY_GROUP_PROPERTY
property.public void setAbstractGeometryGroup(TLcdKML22AbstractGeometry aValue)
AbstractGeometryGroup
element.aValue
- the value to set for the ABSTRACT_GEOMETRY_GROUP_PROPERTY
property.public String getName()
name
element.NAME_PROPERTY
property.public void setName(String aValue)
name
element.aValue
- the value to set for the NAME_PROPERTY
property.public void setVisibility(Boolean aValue)
visibility
element.aValue
- the value to set for the VISIBILITY_PROPERTY
property.public Boolean getOpen()
open
element.OPEN_PROPERTY
property.public void setOpen(Boolean aValue)
open
element.aValue
- the value to set for the OPEN_PROPERTY
property.public ILcdDataObject getAuthor()
author
element.AUTHOR_PROPERTY
property.public void setAuthor(ILcdDataObject aValue)
author
element.aValue
- the value to set for the AUTHOR_PROPERTY
property.public ILcdDataObject getAtomLink()
link
element.ATOM_LINK_PROPERTY
property.public void setAtomLink(ILcdDataObject aValue)
link
element.aValue
- the value to set for the ATOM_LINK_PROPERTY
property.public String getAddress()
address
element.ADDRESS_PROPERTY
property.public void setAddress(String aValue)
address
element.aValue
- the value to set for the ADDRESS_PROPERTY
property.public ILcdDataObject getAddressDetails()
AddressDetails
element.
This container defines the details of the address. Can define multiple addresses including tracking address history
ADDRESS_DETAILS_PROPERTY
property.public void setAddressDetails(ILcdDataObject aValue)
AddressDetails
element.
This container defines the details of the address. Can define multiple addresses including tracking address history
aValue
- the value to set for the ADDRESS_DETAILS_PROPERTY
property.public String getPhoneNumber()
phoneNumber
element.PHONE_NUMBER_PROPERTY
property.public void setPhoneNumber(String aValue)
phoneNumber
element.aValue
- the value to set for the PHONE_NUMBER_PROPERTY
property.public TLcdKML22Snippet getSnippet()
Snippet
and snippet
elements.
The possible values for this property are instances of
TLcdKML22Snippet
String
SNIPPET_PROPERTY
property.public void setSnippet(TLcdKML22Snippet aValue)
Snippet
and snippet
elements.
The possible values for this property are instances of
TLcdKML22Snippet
String
aValue
- the value to set for the SNIPPET_PROPERTY
property.public String getDescription()
description
element.DESCRIPTION_PROPERTY
property.public void setDescription(String aValue)
description
element.aValue
- the value to set for the DESCRIPTION_PROPERTY
property.public TLcdKML22AbstractView getAbstractViewGroup()
AbstractViewGroup
element.ABSTRACT_VIEW_GROUP_PROPERTY
property.public void setAbstractViewGroup(TLcdKML22AbstractView aValue)
AbstractViewGroup
element.aValue
- the value to set for the ABSTRACT_VIEW_GROUP_PROPERTY
property.public TLcdKML22AbstractTimePrimitive getAbstractTimePrimitiveGroup()
AbstractTimePrimitiveGroup
element.ABSTRACT_TIME_PRIMITIVE_GROUP_PROPERTY
property.public void setAbstractTimePrimitiveGroup(TLcdKML22AbstractTimePrimitive aValue)
AbstractTimePrimitiveGroup
element.aValue
- the value to set for the ABSTRACT_TIME_PRIMITIVE_GROUP_PROPERTY
property.public String getStyleUrl()
styleUrl
element.STYLE_URL_PROPERTY
property.public void setStyleUrl(String aValue)
styleUrl
element.aValue
- the value to set for the STYLE_URL_PROPERTY
property.public List<TLcdKML22AbstractStyleSelector> getAbstractStyleSelectorGroup()
AbstractStyleSelectorGroup
element.ABSTRACT_STYLE_SELECTOR_GROUP_PROPERTY
property.public TLcdKML22Region getRegion()
Region
element.REGION_PROPERTY
property.public void setRegion(TLcdKML22Region aValue)
Region
element.aValue
- the value to set for the REGION_PROPERTY
property.public ILcdDataObject getExtendedData()
Metadata
and ExtendedData
elements.
The possible values for this property are instances of
EXTENDED_DATA_PROPERTY
property.public void setExtendedData(ILcdDataObject aValue)
Metadata
and ExtendedData
elements.
The possible values for this property are instances of
aValue
- the value to set for the EXTENDED_DATA_PROPERTY
property.