de.micromata.opengis.kml.v_2_2_0
Class Container

java.lang.Object
  extended by de.micromata.opengis.kml.v_2_2_0.AbstractObject
      extended by de.micromata.opengis.kml.v_2_2_0.Feature
          extended by de.micromata.opengis.kml.v_2_2_0.Container
All Implemented Interfaces:
java.lang.Cloneable
Direct Known Subclasses:
Document, Folder

public abstract class Container
extends Feature
implements java.lang.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
protected  java.util.List<AbstractObject> containerObjectExtension
          
protected  java.util.List<java.lang.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
Container()
           
 
Method Summary
 Container addToContainerObjectExtension(AbstractObject containerObjectExtension)
          add a value to the containerObjectExtension property collection
 Container addToContainerSimpleExtension(java.lang.Object containerSimpleExtension)
          add a value to the containerSimpleExtension property collection
 Container addToFeatureObjectExtension(AbstractObject featureObjectExtension)
          add a value to the featureObjectExtension property collection
 Container addToFeatureSimpleExtension(java.lang.Object featureSimpleExtension)
          add a value to the featureSimpleExtension property collection
 Container addToObjectSimpleExtension(java.lang.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(java.lang.Object obj)
           
 java.util.List<AbstractObject> getContainerObjectExtension()
           
 java.util.List<java.lang.Object> getContainerSimpleExtension()
           
 int hashCode()
           
 void setContainerObjectExtension(java.util.List<AbstractObject> containerObjectExtension)
           
 void setContainerSimpleExtension(java.util.List<java.lang.Object> containerSimpleExtension)
           
 void setFeatureObjectExtension(java.util.List<AbstractObject> featureObjectExtension)
           
 void setFeatureSimpleExtension(java.util.List<java.lang.Object> featureSimpleExtension)
           
 void setObjectSimpleExtension(java.util.List<java.lang.Object> objectSimpleExtension)
           
 void setStyleSelector(java.util.List<StyleSelector> styleSelector)
           
 Container withAbstractView(AbstractView abstractView)
          fluent setter
 Container withAddress(java.lang.String address)
          fluent setter
 Container withAtomAuthor(Author atomAuthor)
          fluent setter
 Container withAtomLink(Link atomLink)
          fluent setter
 Container withContainerObjectExtension(java.util.List<AbstractObject> containerObjectExtension)
          fluent setter
 Container withContainerSimpleExtension(java.util.List<java.lang.Object> containerSimpleExtension)
          fluent setter
 Container withDescription(java.lang.String description)
          fluent setter
 Container withExtendedData(ExtendedData extendedData)
          fluent setter
 Container withFeatureObjectExtension(java.util.List<AbstractObject> featureObjectExtension)
          fluent setter
 Container withFeatureSimpleExtension(java.util.List<java.lang.Object> featureSimpleExtension)
          fluent setter
 Container withId(java.lang.String id)
          fluent setter
 Container withMetadata(Metadata metadata)
          fluent setter
 Container withName(java.lang.String name)
          fluent setter
 Container withObjectSimpleExtension(java.util.List<java.lang.Object> objectSimpleExtension)
          fluent setter
 Container withOpen(java.lang.Boolean open)
          fluent setter
 Container withPhoneNumber(java.lang.String phoneNumber)
          fluent setter
 Container withRegion(Region region)
          fluent setter
 Container withSnippet(Snippet snippet)
          fluent setter
 Container withSnippetd(java.lang.String snippetd)
          fluent setter
 Container withStyleSelector(java.util.List<StyleSelector> styleSelector)
          fluent setter
 Container withStyleUrl(java.lang.String styleUrl)
          fluent setter
 Container withTargetId(java.lang.String targetId)
          fluent setter
 Container withTimePrimitive(TimePrimitive timePrimitive)
          fluent setter
 Container withVisibility(java.lang.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 java.util.List<java.lang.Object> containerSimpleExtension

containerObjectExtension

protected java.util.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:
<!-- abstract element; do not create -->
 <!-- Object id="ID" targetId="NCName" -->
 <!-- /Object> -->

Constructor Detail

Container

public Container()
Method Detail

getContainerSimpleExtension

public java.util.List<java.lang.Object> getContainerSimpleExtension()
See Also:
containerSimpleExtension

getContainerObjectExtension

public java.util.List<AbstractObject> getContainerObjectExtension()
See Also:
containerObjectExtension

hashCode

public int hashCode()
Overrides:
hashCode in class Feature

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class Feature

setContainerSimpleExtension

public void setContainerSimpleExtension(java.util.List<java.lang.Object> containerSimpleExtension)
Parameters:
containerSimpleExtension -
See Also:
containerSimpleExtension

addToContainerSimpleExtension

public Container addToContainerSimpleExtension(java.lang.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(java.util.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(java.util.List<java.lang.Object> objectSimpleExtension)
Overrides:
setObjectSimpleExtension in class Feature
See Also:
objectSimpleExtension

addToObjectSimpleExtension

public Container addToObjectSimpleExtension(java.lang.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(java.util.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: <StyleSelectorJAXBElement<StyleMapJAXBElement<Style
Returns:
true (as general contract of Collection.add).

setFeatureSimpleExtension

public void setFeatureSimpleExtension(java.util.List<java.lang.Object> featureSimpleExtension)
Overrides:
setFeatureSimpleExtension in class Feature
See Also:
featureSimpleExtension

addToFeatureSimpleExtension

public Container addToFeatureSimpleExtension(java.lang.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: <ObjectJAXBElement<Boolean
Returns:
true (as general contract of Collection.add).

setFeatureObjectExtension

public void setFeatureObjectExtension(java.util.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(java.util.List<java.lang.Object> containerSimpleExtension)
fluent setter

Parameters:
containerSimpleExtension - required parameter
See Also:
#setContainerSimpleExtension(List)

withContainerObjectExtension

public Container withContainerObjectExtension(java.util.List<AbstractObject> containerObjectExtension)
fluent setter

Parameters:
containerObjectExtension - required parameter
See Also:
#setContainerObjectExtension(List)

withObjectSimpleExtension

public Container withObjectSimpleExtension(java.util.List<java.lang.Object> objectSimpleExtension)
Description copied from class: AbstractObject
fluent setter

Overrides:
withObjectSimpleExtension in class Feature
Parameters:
objectSimpleExtension - required parameter
See Also:
#setObjectSimpleExtension(List)

withId

public Container withId(java.lang.String id)
Description copied from class: AbstractObject
fluent setter

Overrides:
withId in class Feature
Parameters:
id - required parameter
See Also:
AbstractObject.setId(String)

withTargetId

public Container withTargetId(java.lang.String targetId)
Description copied from class: AbstractObject
fluent setter

Overrides:
withTargetId in class Feature
Parameters:
targetId - required parameter
See Also:
AbstractObject.setTargetId(String)

withName

public Container withName(java.lang.String name)
Description copied from class: Feature
fluent setter

Overrides:
withName in class Feature
Parameters:
name - required parameter
See Also:
Feature.setName(String)

withVisibility

public Container withVisibility(java.lang.Boolean visibility)
Description copied from class: Feature
fluent setter

Overrides:
withVisibility in class Feature
Parameters:
visibility - required parameter
See Also:
Feature.setVisibility(Boolean)

withOpen

public Container withOpen(java.lang.Boolean open)
Description copied from class: Feature
fluent setter

Overrides:
withOpen in class Feature
Parameters:
open - required parameter
See Also:
Feature.setOpen(Boolean)

withAtomAuthor

public Container withAtomAuthor(Author atomAuthor)
Description copied from class: Feature
fluent setter

Overrides:
withAtomAuthor in class Feature
Parameters:
atomAuthor - required parameter
See Also:
Feature.setAtomAuthor(Author)

withAtomLink

public Container withAtomLink(Link atomLink)
Description copied from class: Feature
fluent setter

Overrides:
withAtomLink in class Feature
Parameters:
atomLink - required parameter
See Also:
Feature.setAtomLink(Link)

withAddress

public Container withAddress(java.lang.String address)
Description copied from class: Feature
fluent setter

Overrides:
withAddress in class Feature
Parameters:
address - required parameter
See Also:
Feature.setAddress(String)

withXalAddressDetails

public Container withXalAddressDetails(AddressDetails xalAddressDetails)
Description copied from class: Feature
fluent setter

Overrides:
withXalAddressDetails in class Feature
Parameters:
xalAddressDetails - required parameter
See Also:
Feature.setXalAddressDetails(AddressDetails)

withPhoneNumber

public Container withPhoneNumber(java.lang.String phoneNumber)
Description copied from class: Feature
fluent setter

Overrides:
withPhoneNumber in class Feature
Parameters:
phoneNumber - required parameter
See Also:
Feature.setPhoneNumber(String)

withSnippet

public Container withSnippet(Snippet snippet)
Description copied from class: Feature
fluent setter

Overrides:
withSnippet in class Feature
Parameters:
snippet - required parameter
See Also:
Feature.setSnippet(Snippet)

withSnippetd

public Container withSnippetd(java.lang.String snippetd)
Description copied from class: Feature
fluent setter

Overrides:
withSnippetd in class Feature
Parameters:
snippetd - required parameter
See Also:
Feature.setSnippetd(String)

withDescription

public Container withDescription(java.lang.String description)
Description copied from class: Feature
fluent setter

Overrides:
withDescription in class Feature
Parameters:
description - required parameter
See Also:
Feature.setDescription(String)

withAbstractView

public Container withAbstractView(AbstractView abstractView)
Description copied from class: Feature
fluent setter

Overrides:
withAbstractView in class Feature
Parameters:
abstractView - required parameter
See Also:
Feature.setAbstractView(AbstractView)

withTimePrimitive

public Container withTimePrimitive(TimePrimitive timePrimitive)
Description copied from class: Feature
fluent setter

Overrides:
withTimePrimitive in class Feature
Parameters:
timePrimitive - required parameter
See Also:
Feature.setTimePrimitive(TimePrimitive)

withStyleUrl

public Container withStyleUrl(java.lang.String styleUrl)
Description copied from class: Feature
fluent setter

Overrides:
withStyleUrl in class Feature
Parameters:
styleUrl - required parameter
See Also:
Feature.setStyleUrl(String)

withStyleSelector

public Container withStyleSelector(java.util.List<StyleSelector> styleSelector)
Description copied from class: Feature
fluent setter

Overrides:
withStyleSelector in class Feature
Parameters:
styleSelector - required parameter
See Also:
#setStyleSelector(List)

withRegion

public Container withRegion(Region region)
Description copied from class: Feature
fluent setter

Overrides:
withRegion in class Feature
Parameters:
region - required parameter
See Also:
Feature.setRegion(Region)

withMetadata

public Container withMetadata(Metadata metadata)
Description copied from class: Feature
fluent setter

Overrides:
withMetadata in class Feature
Parameters:
metadata - required parameter
See Also:
Feature.setMetadata(Metadata)

withExtendedData

public Container withExtendedData(ExtendedData extendedData)
Description copied from class: Feature
fluent setter

Overrides:
withExtendedData in class Feature
Parameters:
extendedData - required parameter
See Also:
Feature.setExtendedData(ExtendedData)

withFeatureSimpleExtension

public Container withFeatureSimpleExtension(java.util.List<java.lang.Object> featureSimpleExtension)
Description copied from class: Feature
fluent setter

Overrides:
withFeatureSimpleExtension in class Feature
Parameters:
featureSimpleExtension - required parameter
See Also:
#setFeatureSimpleExtension(List)

withFeatureObjectExtension

public Container withFeatureObjectExtension(java.util.List<AbstractObject> featureObjectExtension)
Description copied from class: Feature
fluent setter

Overrides:
withFeatureObjectExtension in class Feature
Parameters:
featureObjectExtension - required parameter
See Also:
#setFeatureObjectExtension(List)

clone

public Container clone()
Overrides:
clone in class Feature