TLcdWMSDataSource (LuciadLightspeed API documentation)

java.lang.Object
- com.luciad.wms.client.model.TLcdWMSDataSource

All Implemented Interfaces:

ILcdDataSource
```
public final class TLcdWMSDataSource
extends Object
implements ILcdDataSource
```
Data source representation for a WMS, with one or more layers.
The WMS data source requires as a minimum:
- The URI location of the WMS.
- One or more layers or a Styled Layer Descriptor.
By default the data source is configured to request images from the WMS server with a transparent background.
Since:

2017.0

See Also:

TLcdOGCWMSProxyModelDecoder.decodeSource(com.luciad.model.ILcdDataSource)

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`TLcdWMSDataSource.Builder` A builder to create `TLcdWMSDataSource` instances.
`static class`	`TLcdWMSDataSource.Layer` Representation of a WMS layer.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TLcdWMSDataSource.Builder`	`asBuilder()` Returns a `builder` pre-initialized with the values of this instance.
`boolean`	`equals(Object aObject)`
`String`	`getDescription()` Returns a string description of the data source.
`String`	`getFormat()` Returns the format that should be used when decoding the WMS layer.
`List<TLcdWMSDataSource.Layer>`	`getLayers()` Returns the list of WMS layers to load.
`String`	`getStyledLayerDescriptor()` Returns the Styled Layer Descriptor.
`URI`	`getURI()` Returns the URI of the WMS server.
`int`	`hashCode()`
`boolean`	`isInvertXYForEPSG4326()` Returns true if the bounding box coordinates should be inverted in case the world reference of the request is EPSG:4326 and the WMS version is 1.3.0.
`boolean`	`isTransparent()` Returns if the WMS is request to return an image with a transparent background.
`static TLcdWMSDataSource.Builder`	`newBuilder()` Returns a `builder` to create new instances.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - getDescription
```
public String getDescription()
```
    Description copied from interface: ILcdDataSource
    
    Returns a string description of the data source. This will typically be used in a GUI, or in error and warning messages.
    
    Specified by:
    
    getDescription in interface ILcdDataSource
    
    Returns:
    
    a String describing the data source.
  - newBuilder
```
public static TLcdWMSDataSource.Builder newBuilder()
```
    Returns a builder to create new instances.
    
    Returns:
    
    A builder.
  - asBuilder
```
public TLcdWMSDataSource.Builder asBuilder()
```
    Returns a builder pre-initialized with the values of this instance.
    
    Returns:
    
    A builder initialized to copy this object.
  - getURI
```
public URI getURI()
```
    Returns the URI of the WMS server.
    
    Returns:
    
    The URI of the WMS server.
  - getLayers
```
public List<TLcdWMSDataSource.Layer> getLayers()
```
    Returns the list of WMS layers to load. The layers are ordered from bottom to top.
    
    Returns:
    
    the list of WMS layers to load.
  - getFormat
```
public String getFormat()
```
    Returns the format that should be used when decoding the WMS layer.
    A null return value indicates the format should be auto-detected.
    
    Returns:
    
    The format to use, possibly null.
  - getStyledLayerDescriptor
```
public String getStyledLayerDescriptor()
```
    Returns the Styled Layer Descriptor. May be null.
    
    Returns:
    
    the Styled Layer Descriptor. May be null.
  - isTransparent
```
public boolean isTransparent()
```
    Returns if the WMS is request to return an image with a transparent background.
    
    Returns:
    
    if the WMS is request to return an image with a transparent background.
    
    See Also:
    
    ALcdWMSProxy.isBackgroundImageTransparent()
  - isInvertXYForEPSG4326
```
public boolean isInvertXYForEPSG4326()
```
    Returns true if the bounding box coordinates should be inverted in case the world reference of the request is EPSG:4326 and the WMS version is 1.3.0. This means that instead of x=lon and y=lat, x=lat and y=lon will be used.
    
    Returns:
    
    True if coordinates are inverted for EPSG:4326.
    
    See Also:
    
    ALcdWMSProxy.isInvertXYForEPSG4326()
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object aObject)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

LuciadLightspeedClass TLcdWMSDataSource

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getDescription

newBuilder

asBuilder

getURI

getLayers

getFormat

getStyledLayerDescriptor

isTransparent

isInvertXYForEPSG4326

toString

equals

hashCode