TileLayer (Groovy Documentation)

geoscript.layer.TileLayer

All Implemented Interfaces and Traits:: java.io.Closeable

abstract class TileLayer<T extends Tile>
extends java.lang.Object
implements java.io.Closeable

A TileLayer

Authors:: Jared Erickson

Properties Summary

Properties
Type	Name and description
`Bounds`	`bounds` The Bounds
`java.lang.String`	`name` The name
`Projection`	`proj` The Projection

Constructor Summary

Constructors
Constructor and description
`TileLayer ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`abstract void`	`close()` Close the TileLayer
	`abstract void`	`delete(T t)` Delete a Tile
	`void`	`delete(TileCursor<T> tiles)` Delete all of the Tiles in the TileCursor
	`abstract T`	`get(long z, long x, long y)` Get a Tile
	`Layer`	`getLayer(Map options, TileCursor cursor)` Get a Layer of the Tiles in a TileCursor
	`abstract Pyramid`	`getPyramid()` Get the Pyramid
	`Map`	`getTileCoordinates(Bounds b, Grid g)` Get Tile coordinates (minX, minY, maxX, maxY) for the given Bounds and Grid
	`static TileLayer`	`getTileLayer(java.lang.String paramsStr)` Get a TileLayer from a string of connection parameters.
	`static TileLayer`	`getTileLayer(Map params)` Get a TileLayer from a connection parameter Map.
	`static TileRenderer`	`getTileRenderer(Map options, TileLayer tileLayer, Layer layer)` Get a default TileRenderer for the given TileLayer.
	`static TileRenderer`	`getTileRenderer(Map options, TileLayer tileLayer, java.util.List<Layer> layers)` Get a default TileRenderer for the given TileLayer.
	`abstract void`	`put(T t)` Add a Tile
	`TileCursor<T>`	`tiles(long z)` Get a TileCursor for all the Tiles in the zoom level
	`TileCursor<T>`	`tiles(long z, long minX, long minY, long maxX, long maxY)` Get a TileCursor for all the Tiles in the zoom level for the given columns and rows
	`TileCursor<T>`	`tiles(Bounds b, long z)` Get a TileCursor for all the Tiles within the given Bounds
	`TileCursor<T>`	`tiles(Bounds b, double resX, double resY)` Get a TileCursor for all the Tiles within the given Bounds and resolutions
	`TileCursor<T>`	`tiles(Bounds b, int w, int h)` Get a TileCursor for all the Tiles withing the given Bounds and image size
	`TileCursor<T>`	`tiles(java.awt.Point p, long z, int w, int h)` Get a TileCursor for all Tiles centered on a Point for a given zoom level that fill an image of a certain width and height
	`java.lang.String`	`toString()`
	`static void`	`withTileLayer(TileLayer tileLayer, groovy.lang.Closure closure)` Use a TileLayer within a Closure and make sure it gets closed.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Property Detail
  - Bounds bounds
    
    The Bounds
  - java.lang.String name
    
    The name
  - Projection proj
    
    The Projection
- Constructor Detail
  - TileLayer()
- Method Detail
  - abstract void close()
    
    Close the TileLayer
  - abstract void delete(T t)
    
    Delete a Tile
    Parameters:
    t - The Tile
  - void delete(TileCursor<T> tiles)
    
    Delete all of the Tiles in the TileCursor
    Parameters:
    tiles - The TileCursor
  - abstract T get(long z, long x, long y)
    
    Get a Tile
    Parameters:
    z - The zoom level
    x - The column
    y - The row
    Returns:
    A Tile
  - Layer getLayer(Map options, TileCursor cursor)
    
    Get a Layer of the Tiles in a TileCursor @return
    Parameters:
    options - Optional named parameters
    
    outLayer = The name of the Layer
    
    outWorkspace = The Workspace
    
    geomFieldName = The name of the geometry Field
    
    idFieldName = The name of the ID Field
    
    zFieldName = The name of the Z Field
    
    xFieldName = The name of the X Field
    
    yFieldName = The name of the Y Field
    cursor
  - abstract Pyramid getPyramid()
    
    Get the Pyramid
    Returns:
    The Pyramid
  - Map getTileCoordinates(Bounds b, Grid g)
    
    Get Tile coordinates (minX, minY, maxX, maxY) for the given Bounds and Grid
    Parameters:
    b - The Bounds
    g - The Grid
    Returns:
    A Map with tile coordinates (minX, minY, maxX, maxY)
  - static TileLayer getTileLayer(java.lang.String paramsStr)
    
    Get a TileLayer from a string of connection parameters.
    - MBTiles = 'states.mbtiles'
    - MBTiles = 'type=mbtiles file=states.mbtiles'
    - GeoPackage = 'states.gpkg'
    - GeoPackage = 'type=geopackage file=states.gpkg'
    - TMS = 'type=tms file=C:\Tiles\states format=jpeg'
    - OSM = 'type=osm url=http://a.tile.openstreetmap.org'
    - UTFGrid = 'type=utfgrid file=/Users/me/tiles/states'
    - VectorTiles = 'type=vectortiles name=states file=/Users/me/tiles/states format=mvt pyramid=GlobalMercator'
    - VectorTiles = 'type=vectortiles name=states url=http://vectortiles.org format=pbf pyramid=GlobalGeodetic'
    Parameters:
    paramsStr - The connection parameter string
    Returns:
    A TileLayer or null
  - static TileLayer getTileLayer(Map params)
    
    Get a TileLayer from a connection parameter Map.
    Parameters:
    params - A Map of connection parameters.
    
    MBTiles = [type: 'mbtiles', file: 'states.mbtiles']
    
    GeoPackage = '[type: 'geopackage', file: 'states.gpkg']
    
    TMS = [type: 'tms', file: 'C:\\Tiles\\states format:jpeg']
    
    OSM = [type: 'osm', url: 'http://a.tile.openstreetmap.org']
    
    UTFGrid = [type: 'utfgrid', file: '/Users/me/tiles/states']
    
    VectorTiles = [type: 'vectortiles', name: 'states', file: '/Users/me/tiles/states format:mvt pyramid:GlobalMercator']
    
    VectorTiles = [type: 'vectortiles', name: 'states', url: 'http://vectortiles.org format:pbf pyramid:GlobalGeodetic']
    Returns:
    A TileLayer or null
  - static TileRenderer getTileRenderer(Map options, TileLayer tileLayer, Layer layer)
    
    Get a default TileRenderer for the given TileLayer.
    Parameters:
    options - The optional named parameters:
    
    fields = Some TileRenderers can be customized with a List of Fields.
    tileLayer - The TileLayer
    layer - The Layer
    Returns:
    A TileRenderer or null
  - static TileRenderer getTileRenderer(Map options, TileLayer tileLayer, java.util.List<Layer> layers)
    
    Get a default TileRenderer for the given TileLayer.
    Parameters:
    options - The optional named parameters:
    
    fields = Some TileRenderers can be customized with a List of Fields.
    tileLayer - The TileLayer
    layers - The List of Layers (some TileRenderers can only render one Layer at a time)
    Returns:
    A TileRenderer or null
  - abstract void put(T t)
    
    Add a Tile
    Parameters:
    t - The Tile
  - TileCursor<T> tiles(long z)
    
    Get a TileCursor for all the Tiles in the zoom level
    Parameters:
    z - The zoom level
    Returns:
    A TileCursor
  - TileCursor<T> tiles(long z, long minX, long minY, long maxX, long maxY)
    
    Get a TileCursor for all the Tiles in the zoom level for the given columns and rows
    Parameters:
    z - The zoom level
    minX - The min x or column
    minY - The min y or row
    maxX - The max x or column
    maxY - The max y or row
    Returns:
    A TileCursor
  - TileCursor<T> tiles(Bounds b, long z)
    
    Get a TileCursor for all the Tiles within the given Bounds
    Parameters:
    z - The zoom level
    b - The Bounds
    Returns:
    A TileCursor
  - TileCursor<T> tiles(Bounds b, double resX, double resY)
    
    Get a TileCursor for all the Tiles within the given Bounds and resolutions
    Parameters:
    b - The Bounds
    resX - The x resolution
    resY - The y resolution
    Returns:
    A TileCursor
  - TileCursor<T> tiles(Bounds b, int w, int h)
    
    Get a TileCursor for all the Tiles withing the given Bounds and image size
    Parameters:
    b - The Bounds
    w - The image width
    h - The image height
    Returns:
    A TileCursor
  - TileCursor<T> tiles(java.awt.Point p, long z, int w, int h)
    
    Get a TileCursor for all Tiles centered on a Point for a given zoom level that fill an image of a certain width and height
    Parameters:
    p - The Point (in the TileLayer's Projection)
    z - The zoom level
    w - The image width
    h - The image height
    Returns:
    A TileCursor
  - @java.lang.Override java.lang.String toString()
  - static void withTileLayer(TileLayer tileLayer, groovy.lang.Closure closure)
    
    Use a TileLayer within a Closure and make sure it gets closed.
    Parameters:
    tileLayer - The TileLayer
    closure - A Closure that takes the TileLayer

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class TileLayer<T extends Tile>

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

Bounds bounds

java.lang.String name

Projection proj

Constructor Detail

TileLayer()

Method Detail

abstract void close()

abstract void delete(T t)

void delete(TileCursor<T> tiles)

abstract T get(long z, long x, long y)

Layer getLayer(Map options, TileCursor cursor)

abstract Pyramid getPyramid()

Map getTileCoordinates(Bounds b, Grid g)

static TileLayer getTileLayer(java.lang.String paramsStr)

static TileLayer getTileLayer(Map params)

static TileRenderer getTileRenderer(Map options, TileLayer tileLayer, Layer layer)

static TileRenderer getTileRenderer(Map options, TileLayer tileLayer, java.util.List<Layer> layers)

abstract void put(T t)

TileCursor<T> tiles(long z)

TileCursor<T> tiles(long z, long minX, long minY, long maxX, long maxY)

TileCursor<T> tiles(Bounds b, long z)

TileCursor<T> tiles(Bounds b, double resX, double resY)

TileCursor<T> tiles(Bounds b, int w, int h)

TileCursor<T> tiles(java.awt.Point p, long z, int w, int h)

@java.lang.Override java.lang.String toString()

static void withTileLayer(TileLayer tileLayer, groovy.lang.Closure closure)