de.micromata.opengis.kml.v_2_2_0

Class Document

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

de.micromata.opengis.kml.v_2_2_0.Document

All Implemented Interfaces:

Cloneable

public class Document
extends Container
implements Cloneable

...

A Document is a container for features and styles. This element is required if your KML file uses shared styles. It is recommended that you use shared styles, which require the following steps:

Define all Styles in a Document. Assign a unique ID to each Style. Within a given Feature or StyleMap, reference the Style's ID using a element.

Do not put shared styles within a Folder.

Each Feature must explicitly reference the styles it uses in a element. For a Style that applies to a Document (such as ListStyle), the Document itself must explicitly reference the . For example:

Note that shared styles are not inherited by the Features in the Document.

The following example illustrates use of a shared style.

Syntax:

<Document id="ID">
   <!-- inherited from Feature element -->
   <name>...</name>                      <!-- string -->
   <visibility>1</visibility>            <!-- boolean -->
   <open>0</open>                        <!-- boolean -->
   <atom:author>...<atom:author>         <!-- xmlns:atom -->
   <atom:link>...</atom:link>            <!-- xmlns:atom -->
   <address>...</address>                <!-- string -->
   <xal:AddressDetails>...</xal:AddressDetails>  <!-- xmlns:xal -->
  <phoneNumber>...</phoneNumber>        <!-- string -->
  <Snippet maxLines="2">...</Snippet>   <!-- string -->
   <description>...</description>        <!-- string -->
   <AbstractView>...</AbstractView>      <!-- Camera or LookAt -->
   <TimePrimitive>...</TimePrimitive>
   <styleUrl>...</styleUrl>              <!-- anyURI -->
   <StyleSelector>...</StyleSelector>
   <Region>...</Region>
   <Metadata>...</Metadata>              <!-- deprecated in KML 2.2 -->
   <ExtendedData>...</ExtendedData>      <!-- new in KML 2.2 -->
 
   <!-- specific to Document -->
   <!-- 0 or more Schema elements -->
   <!-- 0 or more Feature elements -->
 </Document>

Extends:

Field Summary

Fields

Modifier and Type	Field and Description
protected List<AbstractObject>	documentObjectExtension
protected List<Object>	documentSimpleExtension
protected List<Feature>	feature This is an abstract element and cannot be used directly in a KML file.
protected List<Schema>	schema Specifies a custom KML schema that is used to add custom data to KML Features.

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

containerObjectExtension, 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
Document()

Method Summary

Methods

Modifier and Type	Method and Description
Document	addToContainerObjectExtension(AbstractObject containerObjectExtension) add a value to the containerObjectExtension property collection
Document	addToContainerSimpleExtension(Object containerSimpleExtension) add a value to the containerSimpleExtension property collection
Document	addToDocumentObjectExtension(AbstractObject documentObjectExtension) add a value to the documentObjectExtension property collection
Document	addToDocumentSimpleExtension(Object documentSimpleExtension) add a value to the documentSimpleExtension property collection
Document	addToFeature(Feature feature) add a value to the feature property collection
Document	addToFeatureObjectExtension(AbstractObject featureObjectExtension) add a value to the featureObjectExtension property collection
Document	addToFeatureSimpleExtension(Object featureSimpleExtension) add a value to the featureSimpleExtension property collection
Document	addToObjectSimpleExtension(Object objectSimpleExtension) add a value to the objectSimpleExtension property collection
Document	addToSchema(Schema schema) add a value to the schema property collection
Document	addToStyleSelector(StyleSelector styleSelector) add a value to the styleSelector property collection
Document	clone()
Document	createAndAddDocument() Creates a new instance of Document and adds it to feature.
Folder	createAndAddFolder() Creates a new instance of Folder and adds it to feature.
GroundOverlay	createAndAddGroundOverlay() Creates a new instance of GroundOverlay and adds it to feature.
NetworkLink	createAndAddNetworkLink() Creates a new instance of NetworkLink and adds it to feature.
PhotoOverlay	createAndAddPhotoOverlay() Creates a new instance of PhotoOverlay and adds it to feature.
Placemark	createAndAddPlacemark() Creates a new instance of Placemark and adds it to feature.
Schema	createAndAddSchema() Creates a new instance of Schema and adds it to schema.
ScreenOverlay	createAndAddScreenOverlay() Creates a new instance of ScreenOverlay and adds it to feature.
Tour	createAndAddTour() Creates a new instance of Tour and adds it to feature.
boolean	equals(Object obj)
List<AbstractObject>	getDocumentObjectExtension()
List<Object>	getDocumentSimpleExtension()
List<Feature>	getFeature()
List<Schema>	getSchema()
int	hashCode()
void	setContainerObjectExtension(List<AbstractObject> containerObjectExtension)
void	setContainerSimpleExtension(List<Object> containerSimpleExtension)
void	setDocumentObjectExtension(List<AbstractObject> documentObjectExtension)
void	setDocumentSimpleExtension(List<Object> documentSimpleExtension)
void	setFeature(List<Feature> feature)
void	setFeatureObjectExtension(List<AbstractObject> featureObjectExtension)
void	setFeatureSimpleExtension(List<Object> featureSimpleExtension)
void	setObjectSimpleExtension(List<Object> objectSimpleExtension)
void	setSchema(List<Schema> schema)
void	setStyleSelector(List<StyleSelector> styleSelector)
Document	withAbstractView(AbstractView abstractView) fluent setter
Document	withAddress(String address) fluent setter
Document	withAtomAuthor(Author atomAuthor) fluent setter
Document	withAtomLink(Link atomLink) fluent setter
Document	withContainerObjectExtension(List<AbstractObject> containerObjectExtension) fluent setter
Document	withContainerSimpleExtension(List<Object> containerSimpleExtension) fluent setter
Document	withDescription(String description) fluent setter
Document	withDocumentObjectExtension(List<AbstractObject> documentObjectExtension) fluent setter
Document	withDocumentSimpleExtension(List<Object> documentSimpleExtension) fluent setter
Document	withExtendedData(ExtendedData extendedData) fluent setter
Document	withFeature(List<Feature> feature) fluent setter
Document	withFeatureObjectExtension(List<AbstractObject> featureObjectExtension) fluent setter
Document	withFeatureSimpleExtension(List<Object> featureSimpleExtension) fluent setter
Document	withId(String id) fluent setter
Document	withMetadata(Metadata metadata) fluent setter
Document	withName(String name) fluent setter
Document	withObjectSimpleExtension(List<Object> objectSimpleExtension) fluent setter
Document	withOpen(Boolean open) fluent setter
Document	withPhoneNumber(String phoneNumber) fluent setter
Document	withRegion(Region region) fluent setter
Document	withSchema(List<Schema> schema) fluent setter
Document	withSnippet(Snippet snippet) fluent setter
Document	withSnippetd(String snippetd) fluent setter
Document	withStyleSelector(List<StyleSelector> styleSelector) fluent setter
Document	withStyleUrl(String styleUrl) fluent setter
Document	withTargetId(String targetId) fluent setter
Document	withTimePrimitive(TimePrimitive timePrimitive) fluent setter
Document	withVisibility(Boolean visibility) fluent setter
Document	withXalAddressDetails(AddressDetails xalAddressDetails) fluent setter

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

getContainerObjectExtension, getContainerSimpleExtension

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

schema

protected List<Schema> schema

Specifies a custom KML schema that is used to add custom data to KML Features. The "id" attribute is required and must be unique within the KML file. is always a child of .

Syntax:

<Schema name="string" id="ID">
   <SimpleField type="string" name="string">
     <displayName>...</displayName>            <!-- string -->
   </SimpleField>
 </Schema>

Extends:

feature

protected List<Feature> feature

This is an abstract element and cannot be used directly in a KML file. The following diagram shows how some of a Feature's elements appear in Google Earth.

Syntax:

<!-- abstract element; do not create -->
 <!-- Feature id="ID" -->                <!-- Document,Folder,
                                              NetworkLink,Placemark,
                                              GroundOverlay,PhotoOverlay,ScreenOverlay -->
   <name>...</name>                      <!-- string -->
   <visibility>1</visibility>            <!-- boolean -->
   <open>0</open>                        <!-- boolean -->
   <atom:author>...<atom:author>         <!-- xmlns:atom -->
   <atom:link>...</atom:link>            <!-- xmlns:atom -->
   <address>...</address>                <!-- string -->
   <xal:AddressDetails>...</xal:AddressDetails>  <!-- xmlns:xal -->
  <phoneNumber>...</phoneNumber>        <!-- string -->
  <Snippet maxLines="2">...</Snippet>   <!-- string -->
   <description>...</description>        <!-- string -->
   <AbstractView>...</AbstractView>      <!-- Camera or LookAt -->
   <TimePrimitive>...</TimePrimitive>    <!-- TimeStamp or TimeSpan -->
   <styleUrl>...</styleUrl>              <!-- anyURI -->
   <StyleSelector>...</StyleSelector>
   <Region>...</Region>
   <Metadata>...</Metadata>              <!-- deprecated in KML 2.2 -->
   <ExtendedData>...</ExtendedData>      <!-- new in KML 2.2 -->
<-- /Feature -->

Extends:

documentSimpleExtension

protected List<Object> documentSimpleExtension

documentObjectExtension

protected List<AbstractObject> documentObjectExtension