com.luciad.ogc.wmts.client

LuciadLightspeedClass TLcdWMTSDataSource.Builder

java.lang.Object

com.luciad.ogc.wmts.client.TLcdWMTSDataSource.Builder

Enclosing class:

TLcdWMTSDataSource

public static class TLcdWMTSDataSource.Builder
extends java.lang.Object

A builder to create TLcdWMTSDataSource instances.

By default, all values are null. You have to at least specify a URI.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
TLcdWMTSDataSource.Builder	all(TLcdWMTSDataSource aDataSource) Initialized this builder to the values of the given TLcdWMTSDataSource.
TLcdWMTSDataSource	build() Create the TLcdWMTSDataSource instance that corresponds to the values in this builder.
TLcdWMTSDataSource.Builder	dimension(java.lang.String aDimension, java.lang.String aValue) Specify a value for a specific dimension.
TLcdWMTSDataSource.Builder	format(java.lang.String aFormat) Specify the format of the loaded tiles.
TLcdWMTSDataSource.Builder	layer(java.lang.String aLayerId) Specify the ID of the WMTS layer to load.
TLcdWMTSDataSource.Builder	style(java.lang.String aStyleId) Specify the ID of the style to use.
TLcdWMTSDataSource.Builder	uri(java.lang.String aUri) Specify the URI of the WMTS server.
TLcdWMTSDataSource.Builder	uri(java.net.URI aUri) Specify the URI of the WMTS server.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

uri

public TLcdWMTSDataSource.Builder uri(java.net.URI aUri)

Specify the URI of the WMTS server.

If the URI's query parameters contain layer, data (= alternative for layer), style or format parameters, those are set on this builder as well. For example, http://hostname:8080/Luciad/wmts?layer=myLayer specifies myLayer.

Parameters:

aUri - The URI of the WMTS

Returns:

this

uri

public TLcdWMTSDataSource.Builder uri(java.lang.String aUri)

Specify the URI of the WMTS server.

Parameters:

aUri - The URI of the WMTS

Returns:

this

layer

public TLcdWMTSDataSource.Builder layer(java.lang.String aLayerId)

Specify the ID of the WMTS layer to load.

Leave out, or pass null to indicate all available layers should be loaded.

Use TLcdWMTSClient.getLayers() to query the available layers.

Parameters:

aLayerId - A WMTS layer id.

Returns:

this

style

public TLcdWMTSDataSource.Builder style(java.lang.String aStyleId)

Specify the ID of the style to use.

Leave out, or pass null to indicate the default style should be used.

Use TLcdWMTSClient.getLayers() and TLcdWMTSLayer.getStyles() for the available styles.

Parameters:

aStyleId - A style id.

Returns:

this

format

public TLcdWMTSDataSource.Builder format(java.lang.String aFormat)

Specify the format of the loaded tiles.

Leave out, or pass null to auto-detect the format to use.

Use TLcdWMTSClient.getLayers() and TLcdWMTSLayer.getFormats() for the available formats.

Parameters:

aFormat - A format

Returns:

this

dimension

public TLcdWMTSDataSource.Builder dimension(java.lang.String aDimension,
                                            java.lang.String aValue)

Specify a value for a specific dimension.

Leave out to use the default value for the dimension.

Use TLcdWMTSClient.getLayers() and TLcdWMTSLayer.getDimensions() for the available dimensions.

Parameters:

aDimension - A dimension identifier

aValue - A value to use for this dimension

Returns:

this

all

public TLcdWMTSDataSource.Builder all(TLcdWMTSDataSource aDataSource)

Initialized this builder to the values of the given TLcdWMTSDataSource.

Parameters:

aDataSource - The data source instance to copy

Returns:

this

build

public TLcdWMTSDataSource build()

Create the TLcdWMTSDataSource instance that corresponds to the values in this builder.

You have to at least specify a uri(java.net.URI) before building the instance.

Returns:

A new instance