com.luciad.format.kml22.model

LuciadLightspeedClass TLcdKML22Parameters

java.lang.Object

com.luciad.format.kml22.model.TLcdKML22Parameters

All Implemented Interfaces:

ILcdMap<String,String>, Cloneable, Map<String,String>

public class TLcdKML22Parameters
extends Object
implements ILcdMap<String,String>, Cloneable

Map of KML parameters. For each parameter, a corresponding value is stored in this map. Listeners can be registered to this map to get notified of any changes to the parameters contained in it.

Note that properties don't update themselves. To update dynamic properties, use a parameter updater such as TLcdKML22GXYViewParametersUpdater for GXY views and TLspKML22ViewParametersUpdater for Lightspeed views.

The following parameter keys are part of the KML2.2 spec:
Static parameters:

• clientVersion
• kmlVersion
• clientName
• language

Dynamic parameters:

• lookatLon
• lookatLat
• lookatRange
• lookatTilt
• lookatHeading
• lookatTerrainLon
• lookatTerrainLat
• lookatTerrainAlt
• cameraLon
• cameraLat
• cameraAlt
• horizFov
• vertFov
• horizPixels
• vertPixels
• terrainEnabled

The following parameter keys are not part of the KML 2.2 specification:

• asynchronousAllowed

The "asynchronousAllowed" parameter can be set directly by invoking setAsynchronousAllowed(boolean). It has impact on how resources are handled by a dynamic KML model.

Since:

10.0

See Also:

TLcdKML22GXYViewParametersUpdater, TLcdPropertyChangeEvent

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
TLcdKML22Parameters() Creates an empty parameter map, with no parameters.

Method Summary

Modifier and Type	Method and Description
void	addMapListener(ILcdMapListener<String,String> aILcdMapListener) Register the listener aMapListener to be informed about changes in this map.
void	clear()
Object	clone()
boolean	containsKey(Object aKey)
boolean	containsValue(Object aValue)
Set<Map.Entry<String,String>>	entrySet()
boolean	equals(Object aObject)
String	get(Object aParameter) etrieves the value for the specified parameter.
int	hashCode()
boolean	isAsynchronousAllowed() Checks whether asynchronous operations are allowed.
boolean	isEmpty()
Set<String>	keySet()
String	put(String aParameter, String aValue)
void	putAll(Map<? extends String,? extends String> aMap)
String	remove(Object aKey)
void	removeMapListener(ILcdMapListener<String,String> aILcdMapListener) Unregister the listener aMapListener so it will no longer be informed about changes in this map.
void	setAsynchronousAllowed(boolean aAsynchronousAllowed) Sets the asynchronous allowed flag.
int	size()
Collection<String>	values()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

TLcdKML22Parameters

public TLcdKML22Parameters()

Creates an empty parameter map, with no parameters. By default it will set setAsynchronousAllowed(boolean) to true.

Method Detail

setAsynchronousAllowed

public void setAsynchronousAllowed(boolean aAsynchronousAllowed)

Sets the asynchronous allowed flag. This determines whether or not asynchronous operations are allowed. False is the recommended setting for servers.

Parameters:

aAsynchronousAllowed - if true, allows asynchronous behavior when retrieving links

Since:

2017.0

isAsynchronousAllowed

public boolean isAsynchronousAllowed()

Checks whether asynchronous operations are allowed.

Returns:

Whether or not asynchronous operations are allowed.

Since:

2017.0

put

public String put(String aParameter,
                  String aValue)

Specified by:

put in interface Map<String,String>

putAll

public void putAll(Map<? extends String,? extends String> aMap)

Specified by:

putAll in interface Map<String,String>

remove

public String remove(Object aKey)

Specified by:

remove in interface Map<String,String>

clear

public void clear()

Specified by:

clear in interface Map<String,String>

get

public String get(Object aParameter)

etrieves the value for the specified parameter.

Specified by:

get in interface Map<String,String>

Parameters:

aParameter - The name of the parameter.

Returns:

The value for the parameter parameter, or null if no value is stored in this map for the specified parameter.

containsKey

public boolean containsKey(Object aKey)

Specified by:

containsKey in interface Map<String,String>

containsValue

public boolean containsValue(Object aValue)

Specified by:

containsValue in interface Map<String,String>

keySet

public Set<String> keySet()

Specified by:

keySet in interface Map<String,String>

values

public Collection<String> values()

Specified by:

values in interface Map<String,String>

entrySet

public Set<Map.Entry<String,String>> entrySet()

Specified by:

entrySet in interface Map<String,String>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<String,String>

size

public int size()

Specified by:

size in interface Map<String,String>

addMapListener

public void addMapListener(ILcdMapListener<String,String> aILcdMapListener)

Description copied from interface: ILcdMap

Register the listener aMapListener to be informed about changes in this map.

Specified by:

addMapListener in interface ILcdMap<String,String>

Parameters:

aILcdMapListener - the listener

See Also:

ILcdMap.removeMapListener(ILcdMapListener)

removeMapListener

public void removeMapListener(ILcdMapListener<String,String> aILcdMapListener)

Description copied from interface: ILcdMap

Unregister the listener aMapListener so it will no longer be informed about changes in this map.

This method should do nothing when addMapListener was not registered previously.

Specified by:

removeMapListener in interface ILcdMap<String,String>

Parameters:

aILcdMapListener - the listener

See Also:

ILcdMap.addMapListener(ILcdMapListener)

clone

public Object clone()

Overrides:

clone in class Object

equals

public boolean equals(Object aObject)

Specified by:

equals in interface Map<String,String>

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<String,String>

Overrides:

hashCode in class Object