AbstractGetTileRequest (Geotools modules 27-SNAPSHOT API)

Object
- AbstractRequest
- - AbstractWMTSRequest
  - - AbstractGetTileRequest

All Implemented Interfaces:

Request, GetTileRequest

Direct Known Subclasses:

WMTSSpecification.GetTileRequest
```
public abstract class AbstractGetTileRequest
extends AbstractWMTSRequest
implements GetTileRequest
```
(Based on existing work by rgould for WMS service)

Author:

ian, Emanuele Tajariol (etj at geo-solutions dot it)

Field Summary

Fields
Modifier and Type	Field and Description
`protected WMTSCapabilities`	`capabilities`
`protected WMTSLayer`	`layer`
`static String`	`LAYER`
`static String`	`STYLE`
`protected String`	`styleName`
`static String`	`TILECOL`
`static String`	`TILEMATRIX`
`static String`	`TILEMATRIXSET`
`static String`	`TILEROW`
`protected WMTSServiceType`	`type`

Fields inherited from class AbstractRequest
EXCEPTION_XML, hints, onlineResource, properties

Fields inherited from interface Request
REQUEST, SERVICE, VERSION, WMTVER

Constructor Summary

Constructors
Constructor and Description
`AbstractGetTileRequest(URL onlineResource, Properties properties)` Constructs a GetMapRequest.
`AbstractGetTileRequest(URL onlineResource, Properties properties, HTTPClient client)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`Response`	`createResponse(HTTPResponse response)` Each Request must know how to create it's counterpart Response.
`protected abstract String`	`createTemplateUrl(String tileMatrixSetName)` The templateUrl should contain {TileMatrix}, {TileRow} and {TileCol}.
`CoordinateReferenceSystem`	`getCrs()`
`URL`	`getFinalURL()` Once the properties of the request are configured, this will return the URL that points to the server and contains all of the appropriate name/value parameters.
`String`	`getFormat()`
`Map<String,String>`	`getHeaders()` HTTP headers required for some WMTS *
`Set<Tile>`	`getTiles()` Compute the set of tiles needed to generate the image.
`protected void`	`initRequest()`
`protected abstract void`	`initVersion()` Sets up the version number for this request.
`void`	`setCRS(CoordinateReferenceSystem coordinateReferenceSystem)`
`void`	`setFormat(String format)`
`void`	`setLayer(WMTSLayer layer)`
`void`	`setRequestedBBox(ReferencedEnvelope requestedBBox)`
`void`	`setRequestedHeight(int height)`
`void`	`setRequestedTime(String requestedTime)`
`void`	`setRequestedWidth(int width)`
`void`	`setStyle(String styleName)`

Methods inherited from class AbstractWMTSRequest
initService

Methods inherited from class AbstractRequest
getPostContentType, getProperties, getRequestHints, performPostOutput, processKey, requiresPost, setProperty, setRequestHints

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface Request
getPostContentType, getProperties, getRequestHints, performPostOutput, requiresPost, setProperty, setRequestHints

- Field Detail
  - LAYER
```
public static final String LAYER
```
    See Also:
    
    Constant Field Values
  - STYLE
```
public static final String STYLE
```
    See Also:
    
    Constant Field Values
  - TILECOL
```
public static final String TILECOL
```
    See Also:
    
    Constant Field Values
  - TILEROW
```
public static final String TILEROW
```
    See Also:
    
    Constant Field Values
  - TILEMATRIX
```
public static final String TILEMATRIX
```
    See Also:
    
    Constant Field Values
  - TILEMATRIXSET
```
public static final String TILEMATRIXSET
```
    See Also:
    
    Constant Field Values
  - layer
```
protected WMTSLayer layer
```
  - styleName
```
protected String styleName
```
  - type
```
protected WMTSServiceType type
```
  - capabilities
```
protected WMTSCapabilities capabilities
```
- Constructor Detail
  - AbstractGetTileRequest
```
public AbstractGetTileRequest(URL onlineResource,
                              Properties properties)
```
    Constructs a GetMapRequest. The data passed in represents valid values that can be used.
    
    Parameters:
    
    onlineResource - the location that the request should be applied to
    
    properties - pre-set properties to be used. Can be null.
  - AbstractGetTileRequest
```
public AbstractGetTileRequest(URL onlineResource,
                              Properties properties,
                              HTTPClient client)
```
- Method Detail
  - initVersion
```
protected abstract void initVersion()
```
    Description copied from class: AbstractRequest
    
    Sets up the version number for this request. Typically something like setProperty("VERSION", "1.1.1");
    
    Specified by:
    
    initVersion in class AbstractRequest
  - initRequest
```
protected void initRequest()
```
    Specified by:
    
    initRequest in class AbstractRequest
  - createResponse
```
public Response createResponse(HTTPResponse response)
                        throws ServiceException,
                               IOException
```
    Description copied from interface: Request
    
    Each Request must know how to create it's counterpart Response. Given the content type and input stream (containin the response data), this method must return an appropriate Response object.
    
    Specified by:
    
    createResponse in interface Request
    
    Throws:
    
    ServiceException
    
    IOException
  - setLayer
```
public void setLayer(WMTSLayer layer)
```
    Specified by:
    
    setLayer in interface GetTileRequest
  - setStyle
```
public void setStyle(String styleName)
```
    Specified by:
    
    setStyle in interface GetTileRequest
  - getFormat
```
public String getFormat()
```
  - setFormat
```
public void setFormat(String format)
```
    Specified by:
    
    setFormat in interface GetTileRequest
  - setRequestedHeight
```
public void setRequestedHeight(int height)
```
    Specified by:
    
    setRequestedHeight in interface GetTileRequest
  - setRequestedWidth
```
public void setRequestedWidth(int width)
```
    Specified by:
    
    setRequestedWidth in interface GetTileRequest
  - setRequestedBBox
```
public void setRequestedBBox(ReferencedEnvelope requestedBBox)
```
    Specified by:
    
    setRequestedBBox in interface GetTileRequest
  - setRequestedTime
```
public void setRequestedTime(String requestedTime)
```
    Specified by:
    
    setRequestedTime in interface GetTileRequest
  - getHeaders
```
public Map<String,String> getHeaders()
```
    Description copied from interface: GetTileRequest
    
    HTTP headers required for some WMTS *
    
    Specified by:
    
    getHeaders in interface GetTileRequest
  - getCrs
```
public CoordinateReferenceSystem getCrs()
```
    Returns:
    
    the crs
  - setCRS
```
public void setCRS(CoordinateReferenceSystem coordinateReferenceSystem)
```
    Specified by:
    
    setCRS in interface GetTileRequest
  - getTiles
```
public Set<Tile> getTiles()
                   throws ServiceException
```
    Compute the set of tiles needed to generate the image.
    
    Specified by:
    
    getTiles in interface GetTileRequest
    
    Throws:
    
    ServiceException
  - createTemplateUrl
```
protected abstract String createTemplateUrl(String tileMatrixSetName)
```
    The templateUrl should contain {TileMatrix}, {TileRow} and {TileCol}.
    The rest of the url should constitute a sufficient url to request a tile.
    
    Parameters:
    
    tileMatrixSetName -
    
    Returns:
  - getFinalURL
```
public URL getFinalURL()
```
    Description copied from interface: Request
    
    Once the properties of the request are configured, this will return the URL that points to the server and contains all of the appropriate name/value parameters.
    
    Specified by:
    
    getFinalURL in interface Request
    
    Overrides:
    
    getFinalURL in class AbstractRequest
    
    Returns:
    
    a URL that can be used to issue the request
    
    See Also:
    
    org.geotools.data.wms.request.Request#getFinalURL()

Class AbstractGetTileRequest

Field Summary

Fields inherited from class AbstractRequest

Fields inherited from interface Request

Constructor Summary

Method Summary

Methods inherited from class AbstractWMTSRequest

Methods inherited from class AbstractRequest

Methods inherited from class Object

Methods inherited from interface Request

Field Detail

LAYER

STYLE

TILECOL

TILEROW

TILEMATRIX

TILEMATRIXSET

layer

styleName

type

capabilities

Constructor Detail

AbstractGetTileRequest

AbstractGetTileRequest

Method Detail

initVersion

initRequest

createResponse

setLayer

setStyle

getFormat

setFormat

setRequestedHeight

setRequestedWidth

setRequestedBBox

setRequestedTime

getHeaders

getCrs

setCRS

getTiles

createTemplateUrl

getFinalURL