Package com.luciad.format.kml22.model.util

Class TLcdKML22Link

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 Details

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

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

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

  • Constructor Details

    • TLcdKML22Link

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

  • Method Details

    • 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:

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