TLcdKML22Link (LuciadLightspeed API documentation)

java.lang.Object
- com.luciad.datamodel.TLcdDataObject
- - com.luciad.format.kml22.model.TLcdKML22AbstractObject
  - - com.luciad.format.kml22.model.util.TLcdKML22BasicLink
    - - com.luciad.format.kml22.model.util.TLcdKML22Link

All Implemented Interfaces:

ILcdDataObject, ILcdCache, ILcdCloneable, ILcdDeepCloneable, Cloneable
```
public class TLcdKML22Link
extends TLcdKML22BasicLink
implements ILcdCache
```
Domain class modeling the KML LinkType type.

Since:

10.0

Field Summary

Fields
Modifier and Type	Field and Description
`static TLcdDataProperty`	`BASIC_LINK_OBJECT_EXTENSION_GROUP_PROPERTY` Data property that maps to the `BasicLinkObjectExtensionGroup` element.
`static TLcdDataProperty`	`BASIC_LINK_SIMPLE_EXTENSION_GROUP_PROPERTY` Data property that maps to the `BasicLinkSimpleExtensionGroup` element.
`static TLcdDataProperty`	`HREF_PROPERTY` Data property that maps to the `href` element.
`static TLcdDataProperty`	`HTTP_QUERY_PROPERTY` Data property that maps to the `httpQuery` element.
`static QName`	`ICON`
`static QName`	`LINK`
`static TLcdDataProperty`	`LINK_OBJECT_EXTENSION_GROUP_PROPERTY` Data property that maps to the `LinkObjectExtensionGroup` element.
`static TLcdDataProperty`	`LINK_SIMPLE_EXTENSION_GROUP_PROPERTY` Data property that maps to the `LinkSimpleExtensionGroup` element.
`static TLcdDataProperty`	`REFRESH_INTERVAL_PROPERTY` Data property that maps to the `refreshInterval` element.
`static TLcdDataProperty`	`REFRESH_MODE_PROPERTY` Data property that maps to the `refreshMode` element.
`static TLcdDataProperty`	`TYPE_PROPERTY` Data property that holds the type of this instance.
`static QName`	`URL` Url deprecated in 2.2
`static TLcdDataProperty`	`VIEW_BOUND_SCALE_PROPERTY` Data property that maps to the `viewBoundScale` element.
`static TLcdDataProperty`	`VIEW_FORMAT_PROPERTY` Data property that maps to the `viewFormat` element.
`static TLcdDataProperty`	`VIEW_REFRESH_MODE_PROPERTY` Data property that maps to the `viewRefreshMode` element.
`static TLcdDataProperty`	`VIEW_REFRESH_TIME_PROPERTY` Data property that maps to the `viewRefreshTime` 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 and Description

TLcdKML22Link(TLcdDataType aType)
Creates a new TLcdKML22Link with a custom TLcdDataType.

Constructors
Constructor and Description
`TLcdKML22Link(TLcdDataType aType)` Creates a new `TLcdKML22Link` with a custom `TLcdDataType`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clearCache()` Clears the cache.
`TLcdDataObject`	`clone(Map aObjectDictionary)` Returns a deep clone of this object.
`Object`	`getCachedObject(Object aKey)` Looks up and returns the cached Object corresponding to the given key.
`String`	`getHref()` Returns the value of the property that maps to the `href` element.
`String`	`getHttpQuery()` Returns the value of the property that maps to the `httpQuery` element.
`Double`	`getRefreshInterval()` Returns the value of the property that maps to the `refreshInterval` element.
`ELcdKML22RefreshMode`	`getRefreshMode()` Returns the value of the property that maps to the `refreshMode` element.
`QName`	`getType()` Returns the value of the property that holds the type of this instance.
`Double`	`getViewBoundScale()` Returns the value of the property that maps to the `viewBoundScale` element.
`String`	`getViewFormat()` Returns the value of the property that maps to the `viewFormat` element.
`Set<String>`	`getViewFormatParameters()` Returns a set of strings used as parameter keys in the view format.
`ELcdKML22ViewRefreshMode`	`getViewRefreshMode()` Returns the value of the property that maps to the `viewRefreshMode` element.
`Double`	`getViewRefreshTime()` Returns the value of the property that maps to the `viewRefreshTime` element.
`void`	`insertIntoCache(Object aKey, Object aValue)` Inserts a cache Object corresponding to the given key Object.
`Object`	`removeCachedObject(Object aKey)` Looks up and removes the cached Object corresponding to the given key.
`void`	`setHref(String aValue)` Sets the value of the property that maps to the `href` element.
`void`	`setHttpQuery(String aValue)` Sets the value of the property that maps to the `httpQuery` element.
`void`	`setRefreshInterval(Double aValue)` Sets the value of the property that maps to the `refreshInterval` element.
`void`	`setRefreshMode(ELcdKML22RefreshMode aValue)` Sets the value of the property that maps to the `refreshMode` element.
`void`	`setType(QName aValue)` Sets the value of the property that holds the type of this instance.
`void`	`setViewBoundScale(Double aValue)` Sets the value of the property that maps to the `viewBoundScale` element.
`void`	`setViewFormat(String aValue)` Sets the value of the property that maps to the `viewFormat` element.
`void`	`setViewRefreshMode(ELcdKML22ViewRefreshMode aValue)` Sets the value of the property that maps to the `viewRefreshMode` element.
`void`	`setViewRefreshTime(Double aValue)` Sets the value of the property that maps to the `viewRefreshTime` element.

Methods inherited from class com.luciad.format.kml22.model.util.TLcdKML22BasicLink
getKMLSourceName, 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 Detail
  - REFRESH_MODE_PROPERTY
```
public static final TLcdDataProperty REFRESH_MODE_PROPERTY
```
    Data property that maps to the refreshMode element. The possible values for this property are instances of ELcdKML22RefreshMode.
  - REFRESH_INTERVAL_PROPERTY
```
public static final TLcdDataProperty REFRESH_INTERVAL_PROPERTY
```
    Data property that maps to the refreshInterval element. The possible values for this property are instances of Double.
  - VIEW_REFRESH_MODE_PROPERTY
```
public static final TLcdDataProperty VIEW_REFRESH_MODE_PROPERTY
```
    Data property that maps to the viewRefreshMode element. The possible values for this property are instances of ELcdKML22ViewRefreshMode.
  - VIEW_REFRESH_TIME_PROPERTY
```
public static final TLcdDataProperty VIEW_REFRESH_TIME_PROPERTY
```
    Data property that maps to the viewRefreshTime element. The possible values for this property are instances of Double.
  - VIEW_BOUND_SCALE_PROPERTY
```
public static final TLcdDataProperty VIEW_BOUND_SCALE_PROPERTY
```
    Data property that maps to the viewBoundScale element. The possible values for this property are instances of Double.
  - VIEW_FORMAT_PROPERTY
```
public static final TLcdDataProperty VIEW_FORMAT_PROPERTY
```
    Data property that maps to the viewFormat element. The possible values for this property are instances of String.
  - HTTP_QUERY_PROPERTY
```
public static final TLcdDataProperty HTTP_QUERY_PROPERTY
```
    Data property that maps to the httpQuery element. The possible values for this property are instances of String.
  - LINK_SIMPLE_EXTENSION_GROUP_PROPERTY
```
public static final TLcdDataProperty LINK_SIMPLE_EXTENSION_GROUP_PROPERTY
```
    Data property that maps to the LinkSimpleExtensionGroup element. The possible values for this property are instances of List<String>.
  - LINK_OBJECT_EXTENSION_GROUP_PROPERTY
```
public static final TLcdDataProperty LINK_OBJECT_EXTENSION_GROUP_PROPERTY
```
    Data property that maps to the LinkObjectExtensionGroup element. The possible values for this property are instances of List<TLcdKML22AbstractObject>.
  - TYPE_PROPERTY
```
public static final TLcdDataProperty TYPE_PROPERTY
```
    Data property that holds the type of this instance. The possible values for this property are the public QName constants defined in this class.
  - LINK
```
public static final QName LINK
```
  - ICON
```
public static final QName ICON
```
  - URL
```
public static final QName URL
```
    Url deprecated in 2.2
  - HREF_PROPERTY
```
public static final TLcdDataProperty HREF_PROPERTY
```
    Data property that maps to the href element. The possible values for this property are instances of String.
  - BASIC_LINK_SIMPLE_EXTENSION_GROUP_PROPERTY
```
public static final TLcdDataProperty BASIC_LINK_SIMPLE_EXTENSION_GROUP_PROPERTY
```
    Data property that maps to the BasicLinkSimpleExtensionGroup element. The possible values for this property are instances of List<String>.
  - BASIC_LINK_OBJECT_EXTENSION_GROUP_PROPERTY
```
public static final TLcdDataProperty BASIC_LINK_OBJECT_EXTENSION_GROUP_PROPERTY
```
    Data property that maps to the BasicLinkObjectExtensionGroup element. The possible values for this property are instances of List<TLcdKML22AbstractObject>.
- Constructor Detail
  - TLcdKML22Link
```
public TLcdKML22Link(TLcdDataType aType)
```
    Creates a new TLcdKML22Link with a custom TLcdDataType.
    
    Parameters:
    
    aType - a custom TLcdDataType
- Method Detail
  - insertIntoCache
```
public void insertIntoCache(Object aKey,
                            Object aValue)
```
    Description copied from interface: ILcdCache
    
    Inserts a cache Object corresponding to the given key Object.
    
    Specified by:
    
    insertIntoCache in interface ILcdCache
    
    Parameters:
    
    aKey - the key Object that will be used to identify the Object. The key must therefore be a unique identifier, typically the caller itself: insertIntoCache(this, ...).
    
    aValue - the Object to be cached.
  - removeCachedObject
```
public Object removeCachedObject(Object aKey)
```
    Description copied from interface: ILcdCache
    
    Looks up and removes the cached Object corresponding to the given key.
    
    Specified by:
    
    removeCachedObject in interface ILcdCache
    
    Parameters:
    
    aKey - the key Object that was used for storing the cache Object.
    
    Returns:
    
    the cached Object, or null if there was no Object corresponding to the given key.
  - clearCache
```
public void clearCache()
```
    Description copied from interface: ILcdCache
    
    Clears the cache.
    
    Specified by:
    
    clearCache in interface ILcdCache
  - getCachedObject
```
public Object getCachedObject(Object aKey)
```
    Description copied from interface: ILcdCache
    
    Looks up and returns the cached Object corresponding to the given key.
    
    Specified by:
    
    getCachedObject in interface ILcdCache
    
    Parameters:
    
    aKey - the key Object that was used for storing the cache Object.
    
    Returns:
    
    the cached Object, or null if there is no Object corresponding to the given key.
  - getRefreshInterval
```
public Double getRefreshInterval()
```
    Returns the value of the property that maps to the refreshInterval element.
    
    Returns:
    
    the value of the REFRESH_INTERVAL_PROPERTY property.
  - getViewBoundScale
```
public Double getViewBoundScale()
```
    Returns the value of the property that maps to the viewBoundScale element.
    
    Returns:
    
    the value of the VIEW_BOUND_SCALE_PROPERTY property.
  - getViewRefreshTime
```
public Double getViewRefreshTime()
```
    Returns the value of the property that maps to the viewRefreshTime element.
    
    Returns:
    
    the value of the VIEW_REFRESH_TIME_PROPERTY property.
  - getViewFormatParameters
```
public Set<String> getViewFormatParameters()
```
    Returns a set of strings used as parameter keys in the view format.
    
    Returns:
    
    A set of strings used as parameter keys in the view format.
    
    See Also:
    
    getViewFormat()
  - 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 TLcdKML22BasicLink
    
    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
  - getRefreshMode
```
public ELcdKML22RefreshMode getRefreshMode()
```
    Returns the value of the property that maps to the refreshMode element.
    
    Returns:
    
    the value of the REFRESH_MODE_PROPERTY property.
  - setRefreshMode
```
public void setRefreshMode(ELcdKML22RefreshMode aValue)
```
    Sets the value of the property that maps to the refreshMode element.
    
    Parameters:
    
    aValue - the value to set for the REFRESH_MODE_PROPERTY property.
  - setRefreshInterval
```
public void setRefreshInterval(Double aValue)
```
    Sets the value of the property that maps to the refreshInterval element.
    
    Parameters:
    
    aValue - the value to set for the REFRESH_INTERVAL_PROPERTY property.
  - getViewRefreshMode
```
public ELcdKML22ViewRefreshMode getViewRefreshMode()
```
    Returns the value of the property that maps to the viewRefreshMode element.
    
    Returns:
    
    the value of the VIEW_REFRESH_MODE_PROPERTY property.
  - setViewRefreshMode
```
public void setViewRefreshMode(ELcdKML22ViewRefreshMode aValue)
```
    Sets the value of the property that maps to the viewRefreshMode element.
    
    Parameters:
    
    aValue - the value to set for the VIEW_REFRESH_MODE_PROPERTY property.
  - setViewRefreshTime
```
public void setViewRefreshTime(Double aValue)
```
    Sets the value of the property that maps to the viewRefreshTime element.
    
    Parameters:
    
    aValue - the value to set for the VIEW_REFRESH_TIME_PROPERTY property.
  - setViewBoundScale
```
public void setViewBoundScale(Double aValue)
```
    Sets the value of the property that maps to the viewBoundScale element.
    
    Parameters:
    
    aValue - the value to set for the VIEW_BOUND_SCALE_PROPERTY property.
  - getViewFormat
```
public String getViewFormat()
```
    Returns the value of the property that maps to the viewFormat element.
    
    Returns:
    
    the value of the VIEW_FORMAT_PROPERTY property.
  - setViewFormat
```
public void setViewFormat(String aValue)
```
    Sets the value of the property that maps to the viewFormat element.
    
    Parameters:
    
    aValue - the value to set for the VIEW_FORMAT_PROPERTY property.
  - getHttpQuery
```
public String getHttpQuery()
```
    Returns the value of the property that maps to the httpQuery element.
    
    Returns:
    
    the value of the HTTP_QUERY_PROPERTY property.
  - setHttpQuery
```
public void setHttpQuery(String aValue)
```
    Sets the value of the property that maps to the httpQuery element.
    
    Parameters:
    
    aValue - the value to set for the HTTP_QUERY_PROPERTY property.
  - getType
```
public QName getType()
```
    Returns the value of the property that holds the type of this instance.
    The possible values for this property are the public QName constants defined in this class.
    
    Returns:
    
    the value of the TYPE_PROPERTY property.
  - setType
```
public void setType(QName aValue)
```
    Sets the value of the property that holds the type of this instance.
    The possible values for this property are the public QName constants defined in this class.
    
    Parameters:
    
    aValue - the value to set for the TYPE_PROPERTY property.
  - getHref
```
public String getHref()
```
    Returns the value of the property that maps to the href element.
    not anyURI due to $[x] substitution in PhotoOverlay
    
    Returns:
    
    the value of the HREF_PROPERTY property.
  - setHref
```
public void setHref(String aValue)
```
    Sets the value of the property that maps to the href element.
    not anyURI due to $[x] substitution in PhotoOverlay
    
    Parameters:
    
    aValue - the value to set for the HREF_PROPERTY property.

LuciadLightspeedClass TLcdKML22Link

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class com.luciad.format.kml22.model.util.TLcdKML22BasicLink

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

Methods inherited from class com.luciad.datamodel.TLcdDataObject

Methods inherited from class java.lang.Object

Field Detail

REFRESH_MODE_PROPERTY

REFRESH_INTERVAL_PROPERTY

VIEW_REFRESH_MODE_PROPERTY

VIEW_REFRESH_TIME_PROPERTY

VIEW_BOUND_SCALE_PROPERTY

VIEW_FORMAT_PROPERTY

HTTP_QUERY_PROPERTY

LINK_SIMPLE_EXTENSION_GROUP_PROPERTY

LINK_OBJECT_EXTENSION_GROUP_PROPERTY

TYPE_PROPERTY

LINK

ICON

URL

HREF_PROPERTY

BASIC_LINK_SIMPLE_EXTENSION_GROUP_PROPERTY

BASIC_LINK_OBJECT_EXTENSION_GROUP_PROPERTY

Constructor Detail

TLcdKML22Link

Method Detail

insertIntoCache

removeCachedObject

clearCache

getCachedObject

getRefreshInterval

getViewBoundScale

getViewRefreshTime

getViewFormatParameters

clone

getRefreshMode

setRefreshMode

setRefreshInterval

getViewRefreshMode

setViewRefreshMode

setViewRefreshTime

setViewBoundScale

getViewFormat

setViewFormat

getHttpQuery

setHttpQuery

getType

setType

getHref

setHref