de.micromata.opengis.kml.v_2_2_0

Class NetworkLinkControl

java.lang.Object

de.micromata.opengis.kml.v_2_2_0.NetworkLinkControl

All Implemented Interfaces:

java.lang.Cloneable

public class NetworkLinkControl
extends java.lang.Object
implements java.lang.Cloneable

Controls the behavior of files fetched by a .

Syntax:

<NetworkLinkControl>
   <minRefreshPeriod>0</minRefreshPeriod>           <!-- float -->
   <maxSessionLength>-1</maxSessionLength>          <!-- float --> 
   <cookie>...</cookie>                             <!-- string -->                             
   <message>...</message>                           <!-- string -->
   <linkName>...</linkName>                         <!-- string -->                          
   <linkDescription>...</linkDescription>           <!-- string -->              
   <linkSnippet maxLines="2">...</linkSnippet>      <!-- string -->                      
   <expires>...</expires>                           <!-- kml:dateTime -->
   <Update>...</Update>                             <!-- Change,Create,Delete -->
   <AbstractView>...</AbstractView>                 <!-- LookAt or Camera -->
 </NetworkLinkControl>

See Also:

Field Summary

Fields

Modifier and Type	Field and Description
protected AbstractView	abstractView Defines a viewpoint associated with any element derived from Feature.
protected java.lang.String	cookie Use this element to append a string to the URL query on the next refresh of the network link.
protected java.lang.String	expires You can specify a date/time at which the link should be refreshed.
protected java.lang.String	linkDescription You can control the description of the network link from the server, so that changes made to the description on the client side are overridden by the server.
protected java.lang.String	linkName You can control the name of the network link from the server, so that changes made to the name on the client side are overridden by the server.
protected Snippet	linkSnippet You can control the snippet for the network link from the server, so that changes made to the snippet on the client side are overridden by the server.
protected double	maxSessionLength Specified in seconds, is the maximum amount of time for which the client NetworkLink can remain connected.
protected java.lang.String	message You can deliver a pop-up message, such as usage guidelines for your network link.
protected double	minRefreshPeriod Specified in seconds, is the minimum allowed time between fetches of the file.
protected java.util.List<AbstractObject>	networkLinkControlObjectExtension
protected java.util.List<java.lang.Object>	networkLinkControlSimpleExtension
protected Update	update Specifies an addition, change, or deletion to KML data that has already been loaded using the specified URL.

Constructor Summary

Constructors

Constructor and Description
NetworkLinkControl()

Method Summary

Modifier and Type	Method and Description
NetworkLinkControl	addToNetworkLinkControlObjectExtension(AbstractObject networkLinkControlObjectExtension) add a value to the networkLinkControlObjectExtension property collection
NetworkLinkControl	addToNetworkLinkControlSimpleExtension(java.lang.Object networkLinkControlSimpleExtension) add a value to the networkLinkControlSimpleExtension property collection
NetworkLinkControl	clone()
Camera	createAndSetCamera() Creates a new instance of Camera and set it to abstractView.
Snippet	createAndSetLinkSnippet() Creates a new instance of Snippet and set it to linkSnippet.
LookAt	createAndSetLookAt() Creates a new instance of LookAt and set it to abstractView.
Update	createAndSetUpdate(java.lang.String targetHref, java.util.List<java.lang.Object> createOrDeleteOrChange) Creates a new instance of Update and set it to update.
boolean	equals(java.lang.Object obj)
AbstractView	getAbstractView()
java.lang.String	getCookie()
java.lang.String	getExpires()
java.lang.String	getLinkDescription()
java.lang.String	getLinkName()
Snippet	getLinkSnippet()
double	getMaxSessionLength()
java.lang.String	getMessage()
double	getMinRefreshPeriod()
java.util.List<AbstractObject>	getNetworkLinkControlObjectExtension()
java.util.List<java.lang.Object>	getNetworkLinkControlSimpleExtension()
Update	getUpdate()
int	hashCode()
void	setAbstractView(AbstractView value)
void	setCookie(java.lang.String value)
void	setExpires(java.lang.String value)
void	setLinkDescription(java.lang.String value)
void	setLinkName(java.lang.String value)
void	setLinkSnippet(Snippet value)
void	setMaxSessionLength(double value)
void	setMessage(java.lang.String value)
void	setMinRefreshPeriod(double value)
void	setNetworkLinkControlObjectExtension(java.util.List<AbstractObject> networkLinkControlObjectExtension)
void	setNetworkLinkControlSimpleExtension(java.util.List<java.lang.Object> networkLinkControlSimpleExtension)
void	setUpdate(Update value)
NetworkLinkControl	withAbstractView(AbstractView abstractView) fluent setter
NetworkLinkControl	withCookie(java.lang.String cookie) fluent setter
NetworkLinkControl	withExpires(java.lang.String expires) fluent setter
NetworkLinkControl	withLinkDescription(java.lang.String linkDescription) fluent setter
NetworkLinkControl	withLinkName(java.lang.String linkName) fluent setter
NetworkLinkControl	withLinkSnippet(Snippet linkSnippet) fluent setter
NetworkLinkControl	withMaxSessionLength(double maxSessionLength) fluent setter
NetworkLinkControl	withMessage(java.lang.String message) fluent setter
NetworkLinkControl	withMinRefreshPeriod(double minRefreshPeriod) fluent setter
NetworkLinkControl	withNetworkLinkControlObjectExtension(java.util.List<AbstractObject> networkLinkControlObjectExtension) fluent setter
NetworkLinkControl	withNetworkLinkControlSimpleExtension(java.util.List<java.lang.Object> networkLinkControlSimpleExtension) fluent setter
NetworkLinkControl	withUpdate(Update update) fluent setter

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

minRefreshPeriod

protected double minRefreshPeriod

Specified in seconds, is the minimum allowed time between fetches of the file. This parameter allows servers to throttle fetches of a particular file and to tailor refresh rates to the expected rate of change to the data. For example, a user might set a link refresh to 5 seconds, but you could set your minimum refresh period to 3600 to limit refresh updates to once every hour.

maxSessionLength

protected double maxSessionLength

Specified in seconds, is the maximum amount of time for which the client NetworkLink can remain connected. The default value of -1 indicates not to terminate the session explicitly.

cookie

protected java.lang.String cookie

Use this element to append a string to the URL query on the next refresh of the network link. You can use this data in your script to provide more intelligent handling on the server side, including version querying and conditional file delivery.

message

protected java.lang.String message

You can deliver a pop-up message, such as usage guidelines for your network link. The message appears when the network link is first loaded into Google Earth, or when it is changed in the network link control.

linkName

protected java.lang.String linkName

You can control the name of the network link from the server, so that changes made to the name on the client side are overridden by the server.

linkDescription

protected java.lang.String linkDescription

You can control the description of the network link from the server, so that changes made to the description on the client side are overridden by the server.

linkSnippet

protected Snippet linkSnippet

You can control the snippet for the network link from the server, so that changes made to the snippet on the client side are overridden by the server. has a maxLines attribute, an integer that specifies the maximum number of lines to display.

expires

protected java.lang.String expires

You can specify a date/time at which the link should be refreshed. This specification takes effect only if the in has a value of onExpire. See

update

protected Update update

Specifies an addition, change, or deletion to KML data that has already been loaded using the specified URL. The specifies the .kml or .kmz file whose data (within Google Earth) is to be modified. is always contained in a NetworkLinkControl. Furthermore, the file containing the NetworkLinkControl must have been loaded by a NetworkLink. See the "Topics in KML" page on Updates for a detailed example of how Update works.

With , you can specify any number of Change, Create, and Delete tags for a .kml file or .kmz archive that has previously been loaded with a network link. See .

Syntax:

<Update>
   <targetHref>...<targetHref>    <!-- URL -->
   <Change>...</Change>
   <Create>...</Create>
   <Delete>...</Delete>
 </Update>

Contained By:

abstractView

protected AbstractView abstractView

Defines a viewpoint associated with any element derived from Feature. See and .

This is an abstract element and cannot be used directly in a KML file. This element is extended by the and elements.

Syntax:

<!-- abstract element; do not create -->
 <!-- AbstractView -->                   <!-- Camera, LookAt -->                
   <!-- extends Object -->
   <TimePrimitive>...</TimePrimitive>                        <!-- gx:TimeSpan or gx:TimeStamp -->
 <-- /AbstractView -->

Extends:

networkLinkControlSimpleExtension

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

networkLinkControlObjectExtension

protected java.util.List<AbstractObject> networkLinkControlObjectExtension