Container (a Java API for Kml 2.2.1 API)

java.lang.Object
- de.micromata.opengis.kml.v_2_2_0.AbstractObject
- - de.micromata.opengis.kml.v_2_2_0.Feature
  - - de.micromata.opengis.kml.v_2_2_0.Container

All Implemented Interfaces:: Cloneable

Direct Known Subclasses:: Document, Folder

public abstract class Container
extends Feature
implements Cloneable

This is an abstract element and cannot be used directly in a KML file. A Container element holds one or more Features and allows the creation of nested hierarchies.

Syntax:

<!-- abstract element; do not create -->
 <!-- Container id="ID" -->              <!-- Document,Folder -->                 
   <!-- inherited from Feature element -->
   <name>...</name>                      <!-- string -->
   <visibility>1</visibility>            <!-- boolean -->
   <open>0</open>                        <!-- boolean -->
   <address>...</address>                <!-- string -->
   <AddressDetails xmlns="urn:oasis:names:tc:ciq:xsdschema:xAL:2.0">...
      </AddressDetails>                 <!-- string -->
   <phoneNumber>...</phoneNumber>        <!-- string -->
  <Snippet maxLines="2">...</Snippet>   <!-- string -->
   <description>...</description>        <!-- string -->
   <AbstractView>...</AbstractView>      <!-- LookAt or Camera -->
   <TimePrimitive>...</TimePrimitive>
   <styleUrl>...</styleUrl>              <!-- anyURI -->
   <StyleSelector>...</StyleSelector>
   <Region>...</Region>
   <Metadata>...</Metadata>
   <atom:author>...<atom:author>   <!-- xmlns:atom="http://www.w3.org/2005/Atom" -->
   <atom:link>...</atom:link>
 
   <!-- specific to Container --> 
  <!-- 0 or more Features --> 
 <!-- /Container -->

Extends:

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<AbstractObject>`	`containerObjectExtension`
`protected List<Object>`	`containerSimpleExtension`

Fields inherited from class de.micromata.opengis.kml.v_2_2_0.Feature
abstractView, address, atomAuthor, atomLink, description, extendedData, featureObjectExtension, featureSimpleExtension, metadata, name, open, phoneNumber, region, snippet, snippetd, styleSelector, styleUrl, timePrimitive, visibility, xalAddressDetails

Fields inherited from class de.micromata.opengis.kml.v_2_2_0.AbstractObject
id, objectSimpleExtension, targetId

Constructor Summary

Constructors
Constructor and Description

Container()

Constructors
Constructor and Description
`Container()`

Method Summary

Methods
Modifier and Type	Method and Description
`Container`	`addToContainerObjectExtension(AbstractObject containerObjectExtension)` add a value to the containerObjectExtension property collection
`Container`	`addToContainerSimpleExtension(Object containerSimpleExtension)` add a value to the containerSimpleExtension property collection
`Container`	`addToFeatureObjectExtension(AbstractObject featureObjectExtension)` add a value to the featureObjectExtension property collection
`Container`	`addToFeatureSimpleExtension(Object featureSimpleExtension)` add a value to the featureSimpleExtension property collection
`Container`	`addToObjectSimpleExtension(Object objectSimpleExtension)` add a value to the objectSimpleExtension property collection
`Container`	`addToStyleSelector(StyleSelector styleSelector)` add a value to the styleSelector property collection
`Container`	`clone()`
`boolean`	`equals(Object obj)`
`List<AbstractObject>`	`getContainerObjectExtension()`
`List<Object>`	`getContainerSimpleExtension()`
`int`	`hashCode()`
`void`	`setContainerObjectExtension(List<AbstractObject> containerObjectExtension)`
`void`	`setContainerSimpleExtension(List<Object> containerSimpleExtension)`
`void`	`setFeatureObjectExtension(List<AbstractObject> featureObjectExtension)`
`void`	`setFeatureSimpleExtension(List<Object> featureSimpleExtension)`
`void`	`setObjectSimpleExtension(List<Object> objectSimpleExtension)`
`void`	`setStyleSelector(List<StyleSelector> styleSelector)`
`Container`	`withAbstractView(AbstractView abstractView)` fluent setter
`Container`	`withAddress(String address)` fluent setter
`Container`	`withAtomAuthor(Author atomAuthor)` fluent setter
`Container`	`withAtomLink(Link atomLink)` fluent setter
`Container`	`withContainerObjectExtension(List<AbstractObject> containerObjectExtension)` fluent setter
`Container`	`withContainerSimpleExtension(List<Object> containerSimpleExtension)` fluent setter
`Container`	`withDescription(String description)` fluent setter
`Container`	`withExtendedData(ExtendedData extendedData)` fluent setter
`Container`	`withFeatureObjectExtension(List<AbstractObject> featureObjectExtension)` fluent setter
`Container`	`withFeatureSimpleExtension(List<Object> featureSimpleExtension)` fluent setter
`Container`	`withId(String id)` fluent setter
`Container`	`withMetadata(Metadata metadata)` fluent setter
`Container`	`withName(String name)` fluent setter
`Container`	`withObjectSimpleExtension(List<Object> objectSimpleExtension)` fluent setter
`Container`	`withOpen(Boolean open)` fluent setter
`Container`	`withPhoneNumber(String phoneNumber)` fluent setter
`Container`	`withRegion(Region region)` fluent setter
`Container`	`withSnippet(Snippet snippet)` fluent setter
`Container`	`withSnippetd(String snippetd)` fluent setter
`Container`	`withStyleSelector(List<StyleSelector> styleSelector)` fluent setter
`Container`	`withStyleUrl(String styleUrl)` fluent setter
`Container`	`withTargetId(String targetId)` fluent setter
`Container`	`withTimePrimitive(TimePrimitive timePrimitive)` fluent setter
`Container`	`withVisibility(Boolean visibility)` fluent setter
`Container`	`withXalAddressDetails(AddressDetails xalAddressDetails)` fluent setter

Methods inherited from class de.micromata.opengis.kml.v_2_2_0.Feature
createAndAddStyle, createAndAddStyleMap, createAndSetAtomAuthor, createAndSetAtomLink, createAndSetCamera, createAndSetExtendedData, createAndSetLookAt, createAndSetMetadata, createAndSetRegion, createAndSetSnippet, createAndSetTimeSpan, createAndSetTimeStamp, createAndSetXalAddressDetails, getAbstractView, getAddress, getAtomAuthor, getAtomLink, getDescription, getExtendedData, getFeatureObjectExtension, getFeatureSimpleExtension, getMetadata, getName, getPhoneNumber, getRegion, getSnippet, getSnippetd, getStyleSelector, getStyleUrl, getTimePrimitive, getXalAddressDetails, isOpen, isVisibility, setAbstractView, setAddress, setAtomAuthor, setAtomLink, setDescription, setExtendedData, setMetadata, setName, setOpen, setPhoneNumber, setRegion, setSnippet, setSnippetd, setStyleUrl, setTimePrimitive, setVisibility, setXalAddressDetails

Methods inherited from class de.micromata.opengis.kml.v_2_2_0.AbstractObject
getId, getObjectSimpleExtension, getTargetId, setId, setTargetId

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - containerSimpleExtension
```
protected List<Object> containerSimpleExtension
```
  - containerObjectExtension
```
protected List<AbstractObject> containerObjectExtension
```
    This is an abstract base class and cannot be used directly in a KML file. It provides the id attribute, which allows unique identification of a KML element, and the targetId attribute, which is used to reference objects that have already been loaded into Google Earth. The id attribute must be assigned if the mechanism is to be used.
    Syntax:
      
    
    Constructor Detail
    
    Container
    
    public Container()
    
    Method Detail
    
    getContainerSimpleExtension
    
    public List<Object> getContainerSimpleExtension()
    
    See Also:
    containerSimpleExtension
    
    getContainerObjectExtension
    
    public List<AbstractObject> getContainerObjectExtension()
    
    See Also:
    containerObjectExtension
    
    hashCode
    
    public int hashCode()
    
    Overrides:
    
    hashCode in class Feature
    
    equals
    
    public boolean equals(Object obj)
    
    Overrides:
    
    equals in class Feature
    
    setContainerSimpleExtension
    
    public void setContainerSimpleExtension(List<Object> containerSimpleExtension)
    
    Parameters:
    containerSimpleExtension -
    See Also:
    containerSimpleExtension
    
    addToContainerSimpleExtension
    
    public Container addToContainerSimpleExtension(Object containerSimpleExtension)
    
    add a value to the containerSimpleExtension property collection
    
    Parameters:
    containerSimpleExtension - Objects of the following type are allowed in the list: Object
    
    Returns:
    true (as general contract of Collection.add).
    
    setContainerObjectExtension
    
    public void setContainerObjectExtension(List<AbstractObject> containerObjectExtension)
    
    Parameters:
    containerObjectExtension -
    See Also:
    containerObjectExtension
    
    addToContainerObjectExtension
    
    public Container addToContainerObjectExtension(AbstractObject containerObjectExtension)
    
    add a value to the containerObjectExtension property collection
    
    Parameters:
    containerObjectExtension - Objects of the following type are allowed in the list: AbstractObject
    
    Returns:
    true (as general contract of Collection.add).
    
    setObjectSimpleExtension
    
    public void setObjectSimpleExtension(List<Object> objectSimpleExtension)
    
    Overrides:
    
    setObjectSimpleExtension in class Feature
    
    See Also:
    objectSimpleExtension
    
    addToObjectSimpleExtension
    
    public Container addToObjectSimpleExtension(Object objectSimpleExtension)
    
    Description copied from class: AbstractObject
    
    add a value to the objectSimpleExtension property collection
    
    Overrides:
    
    addToObjectSimpleExtension in class Feature
    
    Parameters:
    objectSimpleExtension - Objects of the following type are allowed in the list: Object
    
    Returns:
    true (as general contract of Collection.add).
    
    setStyleSelector
    
    public void setStyleSelector(List<StyleSelector> styleSelector)
    
    Overrides:
    
    setStyleSelector in class Feature
    
    See Also:
    styleSelector
    
    addToStyleSelector
    
    public Container addToStyleSelector(StyleSelector styleSelector)
    
    Description copied from class: Feature
    
    add a value to the styleSelector property collection
    
    Overrides:
    
    addToStyleSelector in class Feature
    
    Parameters:
    styleSelector - Objects of the following type are allowed in the list: <StyleJAXBElement<StyleSelectorJAXBElement<StyleMap
    
    Returns:
    true (as general contract of Collection.add).
    
    setFeatureSimpleExtension
    
    public void setFeatureSimpleExtension(List<Object> featureSimpleExtension)
    
    Overrides:
    
    setFeatureSimpleExtension in class Feature
    
    See Also:
    featureSimpleExtension
    
    addToFeatureSimpleExtension
    
    public Container addToFeatureSimpleExtension(Object featureSimpleExtension)
    
    Description copied from class: Feature
    
    add a value to the featureSimpleExtension property collection
    
    Overrides:
    
    addToFeatureSimpleExtension in class Feature
    
    Parameters:
    featureSimpleExtension - Objects of the following type are allowed in the list: <DoubleJAXBElement<ObjectJAXBElement<Boolean
    
    Returns:
    true (as general contract of Collection.add).
    
    setFeatureObjectExtension
    
    public void setFeatureObjectExtension(List<AbstractObject> featureObjectExtension)
    
    Overrides:
    
    setFeatureObjectExtension in class Feature
    
    See Also:
    featureObjectExtension
    
    addToFeatureObjectExtension
    
    public Container addToFeatureObjectExtension(AbstractObject featureObjectExtension)
    
    Description copied from class: Feature
    
    add a value to the featureObjectExtension property collection
    
    Overrides:
    
    addToFeatureObjectExtension in class Feature
    
    Parameters:
    featureObjectExtension - Objects of the following type are allowed in the list: AbstractObject
    
    Returns:
    true (as general contract of Collection.add).
    
    withContainerSimpleExtension
    
    public Container withContainerSimpleExtension(List<Object> containerSimpleExtension)
    
    fluent setter
    
    Parameters:
    containerSimpleExtension - required parameter
    See Also:
    #setContainerSimpleExtension(List

Class Container

Field Summary

Fields inherited from class de.micromata.opengis.kml.v_2_2_0.Feature

Fields inherited from class de.micromata.opengis.kml.v_2_2_0.AbstractObject

Constructor Summary

Method Summary

Methods inherited from class de.micromata.opengis.kml.v_2_2_0.Feature

Methods inherited from class de.micromata.opengis.kml.v_2_2_0.AbstractObject

Methods inherited from class java.lang.Object

Field Detail

containerSimpleExtension

containerObjectExtension

Constructor Detail

Container

Method Detail

getContainerSimpleExtension

getContainerObjectExtension

hashCode

equals

setContainerSimpleExtension

addToContainerSimpleExtension

setContainerObjectExtension

addToContainerObjectExtension

setObjectSimpleExtension

addToObjectSimpleExtension

setStyleSelector

addToStyleSelector

setFeatureSimpleExtension

addToFeatureSimpleExtension

setFeatureObjectExtension

addToFeatureObjectExtension

withContainerSimpleExtension

withContainerObjectExtension

withObjectSimpleExtension

withId

withTargetId

withName

withVisibility

withOpen

withAtomAuthor

withAtomLink

withAddress

withXalAddressDetails

withPhoneNumber

withSnippet

withSnippetd

withDescription

withAbstractView

withTimePrimitive

withStyleUrl

withStyleSelector

withRegion

withMetadata

withExtendedData

withFeatureSimpleExtension

withFeatureObjectExtension

clone