de.micromata.opengis.kml.v_2_2_0
Class NetworkLink

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

All Implemented Interfaces:

java.lang.Cloneable

public class NetworkLink
extends Feature
implements java.lang.Cloneable

References a KML file or KMZ archive on a local or remote network. Use the element to specify the location of the KML file. Within that element, you can define the refresh options for updating the file, based on time and camera change. NetworkLinks can be used in combination with Regions to handle very large datasets efficiently.

Syntax:

<NetworkLink 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 NetworkLink -->
   <refreshVisibility>0</refreshVisibility> <!-- boolean -->
   <flyToView>0</flyToView>                 <!-- boolean -->
   <Link>...</Link>
 </NetworkLink>

Extends:

Field Summary

protected java.lang.Boolean	flyToView
protected Link	link (required).
protected java.util.List<AbstractObject>	networkLinkObjectExtension
protected java.util.List<java.lang.Object>	networkLinkSimpleExtension
protected java.lang.Boolean	refreshVisibility
protected Link	url Deprecated.

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

NetworkLink()

Method Summary

NetworkLink	addToFeatureObjectExtension(AbstractObject featureObjectExtension) add a value to the featureObjectExtension property collection
NetworkLink	addToFeatureSimpleExtension(java.lang.Object featureSimpleExtension) add a value to the featureSimpleExtension property collection
NetworkLink	addToNetworkLinkObjectExtension(AbstractObject networkLinkObjectExtension) add a value to the networkLinkObjectExtension property collection
NetworkLink	addToNetworkLinkSimpleExtension(java.lang.Object networkLinkSimpleExtension) add a value to the networkLinkSimpleExtension property collection
NetworkLink	addToObjectSimpleExtension(java.lang.Object objectSimpleExtension) add a value to the objectSimpleExtension property collection
NetworkLink	addToStyleSelector(StyleSelector styleSelector) add a value to the styleSelector property collection
NetworkLink	clone()
Link	createAndSetLink() Creates a new instance of Link and set it to link.
Link	createAndSetUrl() Creates a new instance of Link and set it to url.
boolean	equals(java.lang.Object obj)
Link	getLink()
java.util.List<AbstractObject>	getNetworkLinkObjectExtension()
java.util.List<java.lang.Object>	getNetworkLinkSimpleExtension()
Link	getUrl()
int	hashCode()
java.lang.Boolean	isFlyToView()
java.lang.Boolean	isRefreshVisibility()
void	setFeatureObjectExtension(java.util.List<AbstractObject> featureObjectExtension)
void	setFeatureSimpleExtension(java.util.List<java.lang.Object> featureSimpleExtension)
void	setFlyToView(java.lang.Boolean value)
void	setLink(Link value)
void	setNetworkLinkObjectExtension(java.util.List<AbstractObject> networkLinkObjectExtension)
void	setNetworkLinkSimpleExtension(java.util.List<java.lang.Object> networkLinkSimpleExtension)
void	setObjectSimpleExtension(java.util.List<java.lang.Object> objectSimpleExtension)
void	setRefreshVisibility(java.lang.Boolean value)
void	setStyleSelector(java.util.List<StyleSelector> styleSelector)
void	setUrl(Link value)
NetworkLink	withAbstractView(AbstractView abstractView) fluent setter
NetworkLink	withAddress(java.lang.String address) fluent setter
NetworkLink	withAtomAuthor(Author atomAuthor) fluent setter
NetworkLink	withAtomLink(Link atomLink) fluent setter
NetworkLink	withDescription(java.lang.String description) fluent setter
NetworkLink	withExtendedData(ExtendedData extendedData) fluent setter
NetworkLink	withFeatureObjectExtension(java.util.List<AbstractObject> featureObjectExtension) fluent setter
NetworkLink	withFeatureSimpleExtension(java.util.List<java.lang.Object> featureSimpleExtension) fluent setter
NetworkLink	withFlyToView(java.lang.Boolean flyToView) fluent setter
NetworkLink	withId(java.lang.String id) fluent setter
NetworkLink	withLink(Link link) fluent setter
NetworkLink	withMetadata(Metadata metadata) fluent setter
NetworkLink	withName(java.lang.String name) fluent setter
NetworkLink	withNetworkLinkObjectExtension(java.util.List<AbstractObject> networkLinkObjectExtension) fluent setter
NetworkLink	withNetworkLinkSimpleExtension(java.util.List<java.lang.Object> networkLinkSimpleExtension) fluent setter
NetworkLink	withObjectSimpleExtension(java.util.List<java.lang.Object> objectSimpleExtension) fluent setter
NetworkLink	withOpen(java.lang.Boolean open) fluent setter
NetworkLink	withPhoneNumber(java.lang.String phoneNumber) fluent setter
NetworkLink	withRefreshVisibility(java.lang.Boolean refreshVisibility) fluent setter
NetworkLink	withRegion(Region region) fluent setter
NetworkLink	withSnippet(Snippet snippet) fluent setter
NetworkLink	withSnippetd(java.lang.String snippetd) fluent setter
NetworkLink	withStyleSelector(java.util.List<StyleSelector> styleSelector) fluent setter
NetworkLink	withStyleUrl(java.lang.String styleUrl) fluent setter
NetworkLink	withTargetId(java.lang.String targetId) fluent setter
NetworkLink	withTimePrimitive(TimePrimitive timePrimitive) fluent setter
NetworkLink	withUrl(Link url) fluent setter
NetworkLink	withVisibility(java.lang.Boolean visibility) fluent setter
NetworkLink	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

refreshVisibility

protected java.lang.Boolean refreshVisibility

Boolean value. A value of 0 leaves the visibility of features within the control of the Google Earth user. Set the value to 1 to reset the visibility of features each time the NetworkLink is refreshed. For example, suppose a Placemark within the linked KML file has set to 1 and the NetworkLink has set to 1. When the file is first loaded into Google Earth, the user can clear the check box next to the item to turn off display in the 3D viewer. However, when the NetworkLink is refreshed, the Placemark will be made visible again, since its original visibility state was TRUE.

flyToView

protected java.lang.Boolean flyToView

Boolean value. A value of 1 causes Google Earth to fly to the view of the LookAt or Camera in the NetworkLinkControl (if it exists). If the NetworkLinkControl does not contain an AbstractView element, Google Earth flies to the LookAt or Camera element in the Feature child within the element in the refreshed file. If the element does not have a LookAt or Camera specified, the view is unchanged. For example, Google Earth would fly to the view of the parent Document, not the of the Placemarks contained within the Document.

url

@Deprecated
protected Link url

Deprecated.

link

protected Link link

(required). see .

specifies the location of any of the following:

If the file specified in is a local file, the and elements are not used.

KML files fetched by network links Image files used in any Overlay (the element specifies the image in an Overlay; has the same fields as ) Model files used in the element

Specifies the URL of the website containing this KML or KMZ file. Be sure to include the namespace for this element in any KML file that uses it: xmlns:atom="http://www.w3.org/2005/Atom" (see the sample that follows).

Specifies the file to load and optional refresh parameters. See .

The element replaces the element of contained in earlier KML releases and adds functionality for the element (introduced in KML 2.1). In Google Earth releases 3.0 and earlier, the element is ignored.

The file is conditionally loaded and refreshed, depending on the refresh parameters supplied here. Two different sets of refresh parameters can be specified: one set is based on time ( and ) and one is based on the current "camera" view ( and ). In addition, Link specifies whether to scale the bounding box parameters that are sent to the server ( and provides a set of optional viewing parameters that can be sent to the server () as well as a set of optional parameters containing version and language information.

Tip: To display the top-level Folder or Document within a Network Link in the List View, assign an ID to the Folder or Document. Without this ID, only the child object names are displayed in the List View.

When a file is fetched, the URL that is sent to the server is composed of three pieces of information:

the href (Hypertext Reference) that specifies the file to load. an arbitrary format string that is created from (a) parameters that you specify in the element or (b) bounding box parameters (this is the default and is used if no element is included in the file). a second format string that is specified in the element.

Syntax:

<Link id="ID">
   <!-- specific to Link -->
   <href>...</href>                      <!-- string -->
   <refreshMode>onChange</refreshMode>   
     <!-- refreshModeEnum: onChange, onInterval, or onExpire -->   
   <refreshInterval>4</refreshInterval>  <!-- float -->
   <viewRefreshMode>never</viewRefreshMode> 
     <!-- viewRefreshModeEnum: never, onStop, onRequest, onRegion -->
   <viewRefreshTime>4</viewRefreshTime>  <!-- float -->
   <viewBoundScale>1</viewBoundScale>    <!-- float -->
   <viewFormat>BBOX=[bboxWest],[bboxSouth],[bboxEast],[bboxNorth]</viewFormat>
                                         <!-- string -->
   <httpQuery>...</httpQuery>            <!-- string -->
 </Link>

Extends:

networkLinkSimpleExtension

protected java.util.List<java.lang.Object> networkLinkSimpleExtension

networkLinkObjectExtension

protected java.util.List<AbstractObject> networkLinkObjectExtension