com.luciad.format.kml22.util

LuciadLightspeedClass TLcdKML22ResourceDescriptor

java.lang.Object

com.luciad.format.kml22.util.TLcdKML22ResourceDescriptor

public class TLcdKML22ResourceDescriptor
extends Object

A descriptor for KML resources.

This class can be used as a generic way to define any KML resource. The equals() and hashCode have been overridden so that two TLcdKML22ResourceDescriptor instances are equal when their internal states are equal.

Since:

10.0

Constructor Summary

Constructors

Constructor and Description
TLcdKML22ResourceDescriptor(String aHref, String aKMLSourceName) Creates a new resource descriptor with the given parameters
TLcdKML22ResourceDescriptor(TLcdKML22Link aLink, Map<String,String> aParameters) Creates a new resource descriptor with the given parameters

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getHref() Gets the href to the resource, if available.
String	getKMLSourceName() Returns an absolute reference to the KML document that requested the resource, if available.
TLcdKML22Link	getLink() Gets a link to the resource, if available.
Map<String,String>	getParameters() Returns the parameters used to retrieve the resource, if available.
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

TLcdKML22ResourceDescriptor

public TLcdKML22ResourceDescriptor(String aHref,
                                   String aKMLSourceName)

Creates a new resource descriptor with the given parameters

Parameters:

aHref - An href to the resource. Can be absolute or relative.

aKMLSourceName - The original document that links to the resource. If aHref is given in a relative manner, this parameter should not be null, so the resource can correctly be identified.

TLcdKML22ResourceDescriptor

public TLcdKML22ResourceDescriptor(TLcdKML22Link aLink,
                                   Map<String,String> aParameters)

Creates a new resource descriptor with the given parameters

Parameters:

aLink - A link to the object, if relevant. Can be null.

aParameters - The parameters used to retrieve the resource.

Method Detail

getHref

public String getHref()

Gets the href to the resource, if available.

Returns:

the href to the resource, or null.

getLink

public TLcdKML22Link getLink()

Gets a link to the resource, if available.

Returns:

A TLcdKML22Link, or null.

getParameters

public Map<String,String> getParameters()

Returns the parameters used to retrieve the resource, if available.

Returns:

A Map of parameters used to retrieve the resource, of null.

getKMLSourceName

public String getKMLSourceName()

Returns an absolute reference to the KML document that requested the resource, if available.

Returns:

an absolute reference to the KML document that requested the resource, or null.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object