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

Class TLcdKML22AbstractFeature

java.lang.Object
com.luciad.datamodel.TLcdDataObject
com.luciad.format.kml22.model.TLcdKML22AbstractObject
com.luciad.format.kml22.model.feature.TLcdKML22AbstractFeature
All Implemented Interfaces:
ILcdDataObject, ILcdTimeBounded, ILcdCache, ILcdCloneable, ILcdDeepCloneable, Cloneable
Direct Known Subclasses:
TLcdKML22AbstractContainer, TLcdKML22AbstractOverlay, TLcdKML22NetworkLink, TLcdKML22Placemark
public class TLcdKML22AbstractFeature extends TLcdKML22AbstractObject implements ILcdTimeBounded, ILcdCache
Domain class modeling the KML AbstractFeatureType type.

OGC KML Specification description: 

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

  -kml:AbstractObjectGroup

 The following elements can be used wherever this element is referenced:

  -kml:AbstractContainerGroup
  -kml:Document
  -kml:Folder
  -kml:AbstractOverlayGroup
  -kml:GroundOverlay
  -kml:ScreenOverlay
  -kml:PhotoOverlay
  -kml:Placemark
  -kml:NetworkLink

Since:
10.0

  • Field Details Link icon

    • NAME_PROPERTY Link icon

      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 Link icon

      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 Link icon

      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 Link icon

      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 Link icon

      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 Link icon

      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 Link icon

      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 Link icon

      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 Link icon

      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 Link icon

      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 Link icon

      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 Link icon

      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 Link icon

      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 Link icon

      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 Link icon

      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 Link icon

      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 Link icon

      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 Link icon

    • TLcdKML22AbstractFeature Link icon

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

  • Method Details Link icon

    • getVisibility Link icon

      public Boolean getVisibility()
      Returns the value of the property that maps to the visibility element.
      Returns:
      the value of the VISIBILITY_PROPERTY property.

    • getKMLSourceName Link icon

      public String getKMLSourceName()
      Gets the source name of the originating KML document of this abstract feature.
      Returns:
      The source name of the document of which this abstract feature originates from.

    • setKMLSourceName Link icon

      public void setKMLSourceName(String aSourceName)
      Sets the source name of the originating KML document of this abstract feature.
      Parameters:
      aSourceName - the new source name of the document in which this abstract feature resides

    • getInnerStyleSelector Link icon

      public TLcdKML22AbstractStyleSelector getInnerStyleSelector()
      Returns the inner styleselector of this abstract feature, or null if the abstract feature doesn't have an inner styleselector.
      Returns:
      Either a style in the form of ILcdFeatured, or null if the abstract feature has no styleselector.

    • getTimeBounds Link icon

      public ILcdTimeBounds getTimeBounds()
      Description copied from interface: ILcdTimeBounded
      Returns the ILcdTimeBounds by which this object is bounded.
      Specified by:
      getTimeBounds in interface ILcdTimeBounded
      Returns:
      the ILcdTimeBounds by which this object is bounded.

    • insertIntoCache Link icon

      public void insertIntoCache(Object aKey, Object aObject)
      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, ...).
      aObject - the Object to be cached.

    • getCachedObject Link icon

      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.

    • removeCachedObject Link icon

      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 Link icon

      public void clearCache()
      Description copied from interface: ILcdCache
      Clears the cache.
      Specified by:
      clearCache in interface ILcdCache

    • clone Link icon

      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 TLcdDataObject
      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

    • getName Link icon

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

    • setName Link icon

      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 Link icon

      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 Link icon

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

    • setOpen Link icon

      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 Link icon

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

    • setAuthor Link icon

      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 Link icon

      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 Link icon

      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 Link icon

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

    • setAddress Link icon

      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 Link icon

      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 Link icon

      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 Link icon

      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 Link icon

      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 Link icon

      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 Link icon

      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 Link icon

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

    • setDescription Link icon

      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 Link icon

      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 Link icon

      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 Link icon

      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 Link icon

      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 Link icon

      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 Link icon

      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 Link icon

      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 Link icon

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

    • setRegion Link icon

      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 Link icon

      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 Link icon

      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.