com.luciad.ogc.wmts.client

LuciadLightspeedClass TLcdWMTSDataSource

java.lang.Object

com.luciad.ogc.wmts.client.TLcdWMTSDataSource

All Implemented Interfaces:

ILcdDataSource

public class TLcdWMTSDataSource
extends java.lang.Object
implements ILcdDataSource

ILcdDataSource to represent OGC WMTS data.

WMTS data is represented by:

• A URI. This is mandatory.
• A layer id. Optional, leave out to specify all available layers.
• A format. Optional, leave out to auto-detect the format.
• A style id. Optional, leave out to get the default style.

To discover the available layers and their styles and formats, use TLcdWMTSClient.getLayers().

Use newBuilder() to create a new instance.

Limitations on what WMTS layers are supported are described here.

Since:

2013.0

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TLcdWMTSDataSource.Builder A builder to create TLcdWMTSDataSource instances.

Method Summary

Modifier and Type	Method and Description
TLcdWMTSDataSource.Builder	asBuilder() Returns a builder pre-initialized with the values of this instance.
boolean	equals(java.lang.Object aO)
java.lang.String	getDescription() Returns a string description of the data source.
java.util.Map<java.lang.String,java.lang.String>	getDimensions() Returns the values for dimensions to be used when decoding the WMTS layer.
java.lang.String	getFormat() Returns the format that should be used when decoding the WMTS layer.
java.lang.String	getLayer() Returns the WMTS layer ID to load.
java.lang.String	getStyle() Returns the style ID that should be used when decoding the WMTS layer.
java.net.URI	getURI() Returns the URI of the WMTS server.
int	hashCode()
static TLcdWMTSDataSource.Builder	newBuilder() Returns a builder to create new instances.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

newBuilder

public static TLcdWMTSDataSource.Builder newBuilder()

Returns a builder to create new instances.

Returns:

A builder.

asBuilder

public TLcdWMTSDataSource.Builder asBuilder()

Returns a builder pre-initialized with the values of this instance.

Returns:

A builder initialized to copy this object.

getDescription

public java.lang.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.

getURI

public java.net.URI getURI()

Returns the URI of the WMTS server.

Returns:

The URI of the WMTS server.

getLayer

public java.lang.String getLayer()

Returns the WMTS layer ID to load.

A null return value indicates all available, layers should be loaded.

Returns:

A layer ID, possibly null.

getFormat

public java.lang.String getFormat()

Returns the format that should be used when decoding the WMTS layer.

A null return value indicates the format should be auto-detected.

Returns:

The format to use, possibly null.

getStyle

public java.lang.String getStyle()

Returns the style ID that should be used when decoding the WMTS layer.

A null return value indicates the default style should be used.

Returns:

The style ID to use, possibly null.

getDimensions

public java.util.Map<java.lang.String,java.lang.String> getDimensions()

Returns the values for dimensions to be used when decoding the WMTS layer.

Not all possible dimensions need to have values. If a dimension does not have a value associated, the default value will be used.

Returns:

The dimensions to use, possibly empty but never null.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object aO)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object