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

Class TLcdKML22AbstractOverlay

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.TLcdKML22AbstractOverlay

All Implemented Interfaces:

ILcdDataObject, ILcdTimeBounded, ILcdCache, ILcdCloneable, ILcdDeepCloneable, Cloneable

Direct Known Subclasses:

TLcdKML22GroundOverlay, TLcdKML22PhotoOverlay, TLcdKML22ScreenOverlay

public class TLcdKML22AbstractOverlay
extends TLcdKML22AbstractFeature

Domain class modeling the KML AbstractOverlayType type.

Since:

10.0

Field Summary

Fields

Modifier and Type	Field	Description
static final TLcdDataProperty	ABSTRACT_FEATURE_OBJECT_EXTENSION_GROUP_PROPERTY	Data property that maps to the AbstractFeatureObjectExtensionGroup element.
static final TLcdDataProperty	ABSTRACT_FEATURE_SIMPLE_EXTENSION_GROUP_PROPERTY	Data property that maps to the AbstractFeatureSimpleExtensionGroup element.
static final TLcdDataProperty	ABSTRACT_OVERLAY_OBJECT_EXTENSION_GROUP_PROPERTY	Data property that maps to the AbstractOverlayObjectExtensionGroup element.
static final TLcdDataProperty	ABSTRACT_OVERLAY_SIMPLE_EXTENSION_GROUP_PROPERTY	Data property that maps to the AbstractOverlaySimpleExtensionGroup element.
static final TLcdDataProperty	ABSTRACT_STYLE_SELECTOR_GROUP_PROPERTY	Data property that maps to the AbstractStyleSelectorGroup element.
static final TLcdDataProperty	ABSTRACT_TIME_PRIMITIVE_GROUP_PROPERTY	Data property that maps to the AbstractTimePrimitiveGroup element.
static final TLcdDataProperty	ABSTRACT_VIEW_GROUP_PROPERTY	Data property that maps to the AbstractViewGroup element.
static final TLcdDataProperty	ADDRESS_DETAILS_PROPERTY	Data property that maps to the AddressDetails element.
static final TLcdDataProperty	ADDRESS_PROPERTY	Data property that maps to the address element.
static final TLcdDataProperty	ATOM_LINK_PROPERTY	Data property that maps to the link element.
static final TLcdDataProperty	AUTHOR_PROPERTY	Data property that maps to the author element.
static final TLcdDataProperty	COLOR_PROPERTY	Data property that maps to the color element.
static final TLcdDataProperty	DESCRIPTION_PROPERTY	Data property that maps to the description element.
static final TLcdDataProperty	DRAW_ORDER_PROPERTY	Data property that maps to the drawOrder element.
static final TLcdDataProperty	EXTENDED_DATA_PROPERTY	Data property that maps to the choice between the Metadata and ExtendedData elements.
static final TLcdDataProperty	IMAGE_LINK_PROPERTY	Data property that maps to the Icon element.
static final TLcdDataProperty	NAME_PROPERTY	Data property that maps to the name element.
static final TLcdDataProperty	OPEN_PROPERTY	Data property that maps to the open element.
static final TLcdDataProperty	PHONE_NUMBER_PROPERTY	Data property that maps to the phoneNumber element.
static final TLcdDataProperty	REGION_PROPERTY	Data property that maps to the Region element.
static final TLcdDataProperty	SNIPPET_PROPERTY	Data property that maps to the choice between the Snippet and snippet elements.
static final TLcdDataProperty	STYLE_URL_PROPERTY	Data property that maps to the styleUrl element.
static final TLcdDataProperty	VISIBILITY_PROPERTY	Data property that maps to the visibility element.

Fields inherited from class com.luciad.format.kml22.model.TLcdKML22AbstractObject

ID_PROPERTY, OBJECT_SIMPLE_EXTENSION_GROUP_PROPERTY, TARGET_ID_PROPERTY

Constructor Summary

Constructors

Constructor	Description
TLcdKML22AbstractOverlay(TLcdDataType aType)	Creates a new TLcdKML22AbstractOverlay with a custom TLcdDataType.

Method Summary

Modifier and Type	Method	Description
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.
Color	getColor()	Returns the value of the property that maps to the color element.
String	getDescription()	Returns the value of the property that maps to the description element.
Integer	getDrawOrder()	Returns the value of the property that maps to the drawOrder element.
ILcdDataObject	getExtendedData()	Returns the value of the property that maps to the choice between the Metadata and ExtendedData elements.
TLcdKML22Link	getImageLink()	Returns the value of the property that maps to the Icon element.
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.
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.
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	setColor(Color aValue)	Sets the value of the property that maps to the color element.
void	setDescription(String aValue)	Sets the value of the property that maps to the description element.
void	setDrawOrder(Integer aValue)	Sets the value of the property that maps to the drawOrder element.
void	setExtendedData(ILcdDataObject aValue)	Sets the value of the property that maps to the choice between the Metadata and ExtendedData elements.
void	setImageLink(TLcdKML22Link aValue)	Sets the value of the property that maps to the Icon element.
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.
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.

Methods inherited from class com.luciad.format.kml22.model.feature.TLcdKML22AbstractFeature

clearCache, clone, getCachedObject, getInnerStyleSelector, getKMLSourceName, getTimeBounds, getVisibility, insertIntoCache, removeCachedObject, setKMLSourceName

Methods inherited from class com.luciad.format.kml22.model.TLcdKML22AbstractObject

getId, getTargetId, setId, setTargetId

Methods inherited from class com.luciad.datamodel.TLcdDataObject

clone, getDataType, getValue, getValue, hasValue, hasValue, setValue, setValue, toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

COLOR_PROPERTY

public static final TLcdDataProperty COLOR_PROPERTY

Data property that maps to the color element. The possible values for this property are instances of Color.

DRAW_ORDER_PROPERTY

public static final TLcdDataProperty DRAW_ORDER_PROPERTY

Data property that maps to the drawOrder element. The possible values for this property are instances of Integer.

IMAGE_LINK_PROPERTY

public static final TLcdDataProperty IMAGE_LINK_PROPERTY

Data property that maps to the Icon element. The possible values for this property are instances of TLcdKML22Link.

ABSTRACT_OVERLAY_SIMPLE_EXTENSION_GROUP_PROPERTY

public static final TLcdDataProperty ABSTRACT_OVERLAY_SIMPLE_EXTENSION_GROUP_PROPERTY

Data property that maps to the AbstractOverlaySimpleExtensionGroup element. The possible values for this property are instances of List<String>.

ABSTRACT_OVERLAY_OBJECT_EXTENSION_GROUP_PROPERTY

public static final TLcdDataProperty ABSTRACT_OVERLAY_OBJECT_EXTENSION_GROUP_PROPERTY

Data property that maps to the AbstractOverlayObjectExtensionGroup 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.

ATOM_LINK_PROPERTY

public static final TLcdDataProperty ATOM_LINK_PROPERTY

Data property that maps to the link 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

• TLcdKML22Snippet
• String

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

• TLcdKML22Metadata
• TLcdKML22ExtendedData

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

TLcdKML22AbstractOverlay

public TLcdKML22AbstractOverlay(TLcdDataType aType)

Creates a new TLcdKML22AbstractOverlay with a custom TLcdDataType.

Parameters:

aType - a custom TLcdDataType

Method Details

getColor

public Color getColor()

Returns the value of the property that maps to the color element.

Returns:

the value of the COLOR_PROPERTY property.

setColor

public void setColor(Color aValue)

Sets the value of the property that maps to the color element.

Parameters:

aValue - the value to set for the COLOR_PROPERTY property.

getDrawOrder

public Integer getDrawOrder()

Returns the value of the property that maps to the drawOrder element.

Returns:

the value of the DRAW_ORDER_PROPERTY property.

setDrawOrder

public void setDrawOrder(Integer aValue)

Sets the value of the property that maps to the drawOrder element.

Parameters:

aValue - the value to set for the DRAW_ORDER_PROPERTY property.

getImageLink

public TLcdKML22Link getImageLink()

Returns the value of the property that maps to the Icon element.

Returns:

the value of the IMAGE_LINK_PROPERTY property.

setImageLink

public void setImageLink(TLcdKML22Link aValue)

Sets the value of the property that maps to the Icon element.

Parameters:

aValue - the value to set for the IMAGE_LINK_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

• TLcdKML22Snippet
• String

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

• TLcdKML22Snippet
• String

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

• TLcdKML22Metadata
• TLcdKML22ExtendedData

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

• TLcdKML22Metadata
• TLcdKML22ExtendedData

Parameters:

aValue - the value to set for the EXTENDED_DATA_PROPERTY property.