com.luciad.wms.sld.model

LuciadLightspeedClass TLcdSLDStyledLayerDescriptor

java.lang.Object

com.luciad.datamodel.TLcdDataObject

com.luciad.wms.sld.model.TLcdSLDStyledLayerDescriptor

All Implemented Interfaces:

ILcdDataObject, ILcdCloneable, ILcdDeepCloneable, Cloneable

public class TLcdSLDStyledLayerDescriptor
extends TLcdDataObject

A Styled Layer Descriptor contains a set of layers, which can be named or user-defined and can have additional styling information.

Since:

6.1

Constructor Summary

Constructors

Constructor and Description
TLcdSLDStyledLayerDescriptor() Creates a new TLcdSLDStyledLayerDescriptor instance.
TLcdSLDStyledLayerDescriptor(String aName, TLcdSLDDescription aDescription, String aVersion, ALcdSLDLayer[] aLayers) Creates a new TLcdSLDStyledLayerDescriptor instance with a given name, description, version and layer(s).
TLcdSLDStyledLayerDescriptor(TLcdDataType aDataType) Creates a new TLcdSLDStyledLayerDescriptor instance.

Method Summary

Modifier and Type	Method and Description
void	addLayer(ALcdSLDLayer aSLDLayer) Adds a layer to this Styled Layer Descriptor.
TLcdSLDDescription	getDescription() Returns the value of the property that maps to the Description element.
List<ALcdSLDLayer>	getLayer() Returns the value of the property that maps to the choice between the NamedLayer and UserLayer elements.
ALcdSLDLayer	getLayer(int aIndex) Returns the layer at the given index.
int	getLayerCount() Returns the number of layers within this Styled Layer Descriptor.
String	getName() Returns the value of the property that maps to the Name element.
String	getVersion() Returns the value of the property that maps to the version attribute.
void	removeLayer(ALcdSLDLayer aSLDLayer) Removes a layer from this Styled Layer Descriptor.
void	setDescription(TLcdSLDDescription aValue) Sets the value of the property that maps to the Description element.
void	setName(String aValue) Sets the value of the property that maps to the Name element.
void	setVersion(String aValue) Sets the value of the property that maps to the version attribute.

Methods inherited from class com.luciad.datamodel.TLcdDataObject

clone, clone, getDataType, getValue, getValue, hasValue, hasValue, setValue, setValue, toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TLcdSLDStyledLayerDescriptor

public TLcdSLDStyledLayerDescriptor()

Creates a new TLcdSLDStyledLayerDescriptor instance. The version will be set to the default version used by LuciadLightspeed which is currently 1.1.0. If a specific, fixed version is needed, it should be set explicitly.

TLcdSLDStyledLayerDescriptor

public TLcdSLDStyledLayerDescriptor(String aName,
                                    TLcdSLDDescription aDescription,
                                    String aVersion,
                                    ALcdSLDLayer[] aLayers)

Creates a new TLcdSLDStyledLayerDescriptor instance with a given name, description, version and layer(s).

Parameters:

aName - The name of the Styled Layer Descriptor.

aDescription - The description of the Styled Layer Descriptor.

aVersion - The version of the Styled Layer Descriptor. This should be 1.1.0 or 1.0.0.

aLayers - The layer(s) of the Styled Layer Descriptor.

TLcdSLDStyledLayerDescriptor

public TLcdSLDStyledLayerDescriptor(TLcdDataType aDataType)

Creates a new TLcdSLDStyledLayerDescriptor instance. The version will be set to the default version used by LuciadLightspeed which is currently 1.1.0. If a specific, fixed version is needed, it should be set explicitly.

Method Detail

getLayerCount

public int getLayerCount()

Returns the number of layers within this Styled Layer Descriptor.

Returns:

the number of layers within this Styled Layer Descriptor.

getLayer

public ALcdSLDLayer getLayer(int aIndex)

Returns the layer at the given index.

Parameters:

aIndex - The index of the layer to be retrieved.

Returns:

the layer at the given index.

addLayer

public void addLayer(ALcdSLDLayer aSLDLayer)

Adds a layer to this Styled Layer Descriptor.

Parameters:

aSLDLayer - the layer to be added.

removeLayer

public void removeLayer(ALcdSLDLayer aSLDLayer)

Removes a layer from this Styled Layer Descriptor.

Parameters:

aSLDLayer - the layer to be removed.

getVersion

public String getVersion()

Returns the value of the property that maps to the version attribute.

Returns:

the value of the VERSION_PROPERTY property.

setVersion

public void setVersion(String aValue)

Sets the value of the property that maps to the version attribute.

Parameters:

aValue - the value to set for the VERSION_PROPERTY property.

getName

public String getName()

Returns the value of the property that maps to the Name element.

Returns:

the value of the NAME_PROPERTY property.

setName

public void setName(String aValue)

Sets the value of the property that maps to the Name element.

Parameters:

aValue - the value to set for the NAME_PROPERTY property.

getDescription

public TLcdSLDDescription getDescription()

Returns the value of the property that maps to the Description element.

A "Description" gives human-readable descriptive information for the object it is included within.

Returns:

the value of the DESCRIPTION_PROPERTY property.

setDescription

public void setDescription(TLcdSLDDescription aValue)

Sets the value of the property that maps to the Description element.

A "Description" gives human-readable descriptive information for the object it is included within.

Parameters:

aValue - the value to set for the DESCRIPTION_PROPERTY property.

getLayer

public List<ALcdSLDLayer> getLayer()

Returns the value of the property that maps to the choice between the NamedLayer and UserLayer elements.

The possible values for this property are instances of java.util.List with elements of class

• TLcdSLDNamedLayer
• TLcdSLDUserLayer

Returns:

the value of the LAYER_PROPERTY property.