Layer (Groovy Documentation)

geoscript.layer.Layer

All Implemented Interfaces and Traits:

Renderable
```
class Layer
extends java.lang.Object
```
A Layer is a source of spatial data that contains a collection of Features. Most often Layers are accessed from a geoscript.workspace.Workspace but you can create an in memory Layer by simply passing a name and a geoscript.feature.Schema:
```
 Schema schema = new Schema("facilities", [new Field("geom","Point", "EPSG:2927"), new Field("name","string"), new Field("address","string")])
 Layer layer = new Layer("facilities", schema)
 
```
If, all you want to store in a Layer is geoscript.geom.Geometry, you can just pass a layer name:
```
 Layer layer = new Layer("points")
 layer.add([new Point(0,0)])
 layer.add([new Point(1,1)])
 
```
Authors:
Jared Erickson

Field Summary

Fields
Modifiers	Name	Description
`protected static FilterFactory2`	`filterFactory`	The FilterFactory2 for creating Filters

Properties Summary

Properties
Type	Name and description
`private FeatureSource`	`fs` The GeoTools FeatureSource
`private java.lang.String`	`name` The name
`Projection`	`proj`
`private Schema`	`schema` The Schema
`private Style`	`style` The Style
`private Workspace`	`workspace` The Workspace

Constructor Summary

Constructors
Constructor and description
`Layer (FeatureSource fs)` Create a new Layer from a GeoTools FeatureSource
`Layer (Layer layer)` Create a new Layer from an existing Layer
`Layer (java.lang.String name, Workspace workspace, FeatureSource fs, Schema schema)` Create a new Layer from a name, Workspace, FeatureSource, and Schema
`Layer (Workspace workspace, FeatureSource fs)` Create a new Layer from a Workspace and FeatureSource
`Layer (java.lang.String name, Workspace workspace)` Create a new Layer from a name and Workspace
`Layer (java.lang.String name, Schema schema)` Create a new Layer with a name in the Memory Workspace
`Layer ()` Create a new Layer with a default name, Schema in the Memory Workspace
`Layer (java.lang.String name)` Create a new Layer with the given name, a simple Schema with just a Geometry Field in the Memory Workspace
`Layer (FeatureCollection fc)` Create a new Layer from a GeoTools FeatureCollection.
`Layer (java.lang.String name, FeatureCollection fc)` Create a new Layer from a GeoTools FeatureCollection
`Layer ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`add(java.lang.Object o)` Add a Feature to the Layer Parameters: `o` - The Feature, the List of Features, or a List/Map of values
	`Bounds`	`bounds(java.lang.Object filter)` Get the Bounds of the Features in the Layer Parameters: `filer` - The Filter or Filter String to limit the Features used to construct the bounds.
	`Bounds`	`bounds(Map options)` Get the Bounds of Layer using named parameters Parameters: `options` - The named parameters filter = A Filter or a CQL String params = A Map of parameters to plugin into a query Returns: The Bounds
	`Layer`	`buffer(Map options, double distance)` Buffer all of the Features in the this Layer.
	`Layer`	`buffer(Map options, Expression distance)` Buffer all of the Features in the this Layer.
	`Layer`	`clip(Map options, Layer clipLayer)` Clip this Layer by another Layer.
	`List`	`collectFromFeature(java.lang.Object filter, Closure closure)` Collect values from the Features of a Layer Parameters: `filter` - The Filter which is optional `closure` - A Closure which takes a Feature and returns a value
	`List`	`collectFromFeature(Map options, Closure closure)` Collect values from the Features of a Layer
	`int`	`count(java.lang.Object filter)` Count the number of Features in the layer Parameters: `filer` - The Filter or Filter String to limit the number of Features counted.
	`int`	`count(Map options)` Count the number of Features using named parameters Parameters: `options` - The named parameters filter = A Filter or CQL String params = A Map of parameters based to the query Returns: The number of Features in the Layer
	`void`	`delete(java.lang.Object filter)` Delete Features from the Layer Parameters: `filer` - The Filter or Filter String to limit the Features to delete.
	`Layer`	`dissolve(Map options, Field field)` Dissolve the Features of a Layer by a Field.
	`Layer`	`dissolve(Map options)` Dissolve intersecting Features of a Layer.
	`void`	`eachFeature(java.lang.Object filter, Closure closure)` Call the Closure for each Feature optionally filtered by the Filter Parameters: `filter` - The Filter which is optional `closure` - A Closure which takes a Feature
	`void`	`eachFeature(Map options, Closure closure)` Call the Closure for each Feature.
	`Layer`	`erase(Map options, Layer layer2)` Erase this Layer with another Layer.
	`Layer`	`filter(java.lang.Object filter, java.lang.String newName)` Filer the Layer.
	`Feature`	`first(Map options)` Get the first Feature that matches
	`static Layer`	`fromGeometries(Map options, java.lang.String name, List geometries)` Create a Layer from a List of Geometries Parameters: `options` - Optional named parameters: proj = The Projection (defaults to EPSg:4326) style = A Style `name` - The name of the new Layer `geometries` - The List of Geometries Returns: The Layer
	`static Layer`	`fromGeometry(Map options, java.lang.String name, Geometry geometry)` Create a Layer from a Geometry Parameters: `options` - Optional named parameters: proj = The Projection (defaults to EPSg:4326) style = A Style `name` - The name of the new Layer `geometry` - The Geometry Returns: The Layer
	`Bounds`	`getBounds()` Get the Bounds of the Features in the Layer Returns: The Bounds of the Features in the Layer
	`int`	`getCount()` Count the number of Features in the layer Returns: The number of Features in the Layer
	`Cursor`	`getCursor(Map options)` Get a Cursor over the Features of the Layer using named parameters.
	`Cursor`	`getCursor(java.lang.Object filter, List sort, int max, int start, List fields, java.lang.Object sourceProj, java.lang.Object destProj, java.lang.Object params)` Get a Cursor over the Features of the Layer.
	`List`	`getFeatures(java.lang.Object filter, Closure transform, List sort, Map params)` Get a List of Features Parameters: `filer` - The Filter or Filter String to limit the Features used to construct the bounds.
	`List`	`getFeatures(Map options)` Get a List of Features Parameters: `options` - The named parameters transform = The Closure used to modify the Features takes a Feature and returns a Feature filter = The Filter or Filter String to limit the Features.
	`java.lang.String`	`getFormat()` Get the Workspace format Returns: The format identifying the workspace
	`List`	`getMapLayers(Bounds bounds, List size)` Get the map layers @return
	`java.lang.String`	`getName()` Get the Layer's name Returns: The Layer's name
	`Projection`	`getProj()` Get the Layer's Projection Returns: The Layer's Projection
	`Raster`	`getRaster(java.lang.Object field, List gridSize, Bounds bounds, java.lang.String rasterName)` Convert this Layer into a Raster Parameters: `field` - The numeric Field or Field name from which to get values `gridSize` - The grid size (width and height) `bounds` - The Bounds of the Raster `name` - The name of the Raster Returns: A Raster
	`Writer`	`getWriter(Map options)` Get a Writer for this Layer Parameters: `options` - The named parameters batch: The number of features to write at one time (defaults to 1000) transaction: The type of transaction: null, auto or autocommit, or default.
	`List`	`histogram(java.lang.Object field, int classes)` Calculate a histogram of values for an attribute of the Layer.
	`Layer`	`identity(Map options, Layer layer2)` Calculate the identity between this Layer and another Layer.
	`List`	`interpolate(java.lang.Object field, int classes, java.lang.String method)` Create a List of interpolated values for a Field Parameters: `field` - The Field of Field name `classes` - The number of classes `method` - The interpolation method: linear, exp(onential), log(arithmic) Returns: A List of values
	`Layer`	`intersection(Map options, Layer layer2)` Intersect this Layer with another Layer.
	`Layer`	`merge(Map options, Layer otherLayer)` Merge this Layer with another Layer to create an output Layer Parameters: `options` - A Map of options that can include outLayer or outWorkspace outLayer = The output Layer's name outWorkspace = The output Workspace postfixAll = Whether to add a postfix to all field names includeDuplicates = Whether to include duplicate fields maxFieldNameLength = The maximum Field name length `otherLayer` - The other layer Returns: The merged Layer
	`Map`	`minmax(java.lang.Object field, java.lang.Object low, java.lang.Object high)` Calculates the minimum and maximum values for an attribute of the Layer.
	`static java.lang.String`	`newname()` Generate a new name Returns: A new Layer name
	`void`	`plus(java.lang.Object o)` Add a Feature to the Layer Parameters: `o` - The Feature or List/Map of values
	`void`	`queueModified(Feature feature, java.lang.String name)` Add the Feature to a List of modified Features Parameters: `feature` - The modified Feature `name` - The modified field name.
	`protected FeatureCollection`	`readFeatures(Cursor cursor, Schema schema, int chunk)` Read Features from a Cursor in Batches.
	`Layer`	`reproject(Projection p, java.lang.String newName, int chunk, Projection sourceProjection)` Reproject the Layer Parameters: `p` - The Projection `newName` - The new name (defaults to a default new name) `chunk` - The number of Features to reproject in one batch `sourceProjection` - The optional default source Projection if the Layer doesn't have a Projection defined Returns: The reprojected Layer
	`Layer`	`reproject(Projection p, Workspace outputWorkspace, java.lang.String newName, int chunk, Projection sourceProjection)` Reproject the Layer to another Layer in the given Workspace Parameters: `p` - The Projection `outputWorkspace` - The output Workspace `newName` - The name of the new Layer `chunk` - The number of Features to reproject in one batch `sourceProjection` - The optional default source Projection if the Layer doesn't have a Projection defined Returns: The reprojected Layer
	`Layer`	`reproject(Layer projectedLayer, int chunk, Projection sourceProjection)` Reproject this Layer to another Layer that already exists.
	`protected double`	`round2(double num)`
	`protected void`	`setDefaultSymbolizer(java.lang.String geometryType)` Set the default Symbolizer based on the geometry type Parameters: `geometryType` - The geometry type Returns: A default Symbolizer
	`void`	`setProj(java.lang.Object value)` Set the Layer's Projection.
	`void`	`split(Field field, Workspace workspace)` Split this Layer into sub Layers based on values taken from the Field.
	`void`	`split(Layer splitLayer, Field field, Workspace workspace)` Split this Layer into multiple Layers based on the Features from the split Layer.
	`Layer`	`symDifference(Map options, Layer layer2)` Calculate the symmetric difference between this Layer and another Layer.
	`java.lang.String`	`toString()` The string representation Returns: The string representation
	`Layer`	`transform(java.lang.String name, Map definitions)` Transform this Layer into a Layer with a new name using a Map of definitions.
	`Layer`	`union(Map options, Layer layer2)` Union this Layer with another Layer.
	`void`	`update(Field fld, java.lang.Object value, java.lang.Object filter, boolean isScript)` Update the values of a Field Parameters: `fld` - The Field whose values will be updated `value` - Either a static value, a Closure that takes a Feature and return an Object, an Expression, or a Groovy Script (if isScript is true) `filter` - The Filter to limit the Features that will be updated `isScript` - A flag for whether the value is a Groovy script or not (defaults to false).
	`void`	`update()` Update all modified Features whose values where changed with the Feature.set(field,value) method.
	`Layer`	`update(Map options, Layer layer2)` Calculate the update between this Layer and another Layer.
	`void`	`withWriter(Map options, Closure c)` Add Features to a Writer within a Closure that takes a Writer ready to adding Features.

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()`

- Field Detail
  - protected static final FilterFactory2 filterFactory
    
    The FilterFactory2 for creating Filters
- Property Detail
  - private FeatureSource fs
    
    The GeoTools FeatureSource
  - private java.lang.String name
    
    The name
  - Projection proj
  - private Schema schema
    
    The Schema
  - private Style style
    
    The Style
  - private Workspace workspace
    
    The Workspace
- Constructor Detail
  - Layer(FeatureSource fs)
    
    Create a new Layer from a GeoTools FeatureSource
    Parameters:
    fs - The GeoTools FeatureSource
  - Layer(Layer layer)
    
    Create a new Layer from an existing Layer
    Parameters:
    layer - Another Layer
  - Layer(java.lang.String name, Workspace workspace, FeatureSource fs, Schema schema)
    
    Create a new Layer from a name, Workspace, FeatureSource, and Schema
    Parameters:
    name - The Layer's name
    workspace - The Workspace
    fs - The GeoTools FeatureSource
    schema - The GeoScript Schema
  - Layer(Workspace workspace, FeatureSource fs)
    
    Create a new Layer from a Workspace and FeatureSource
    Parameters:
    workspace - The Workspace
    fs - The GeoTools FeatureSource
  - Layer(java.lang.String name, Workspace workspace)
    
    Create a new Layer from a name and Workspace
    Parameters:
    name - The Layer's name
    workspace - The Workspace
  - Layer(java.lang.String name, Schema schema)
    
    Create a new Layer with a name in the Memory Workspace
    Parameters:
    name - The Layer's name
    schema - The Schema
  - Layer()
    
    Create a new Layer with a default name, Schema in the Memory Workspace
  - Layer(java.lang.String name)
    
    Create a new Layer with the given name, a simple Schema with just a Geometry Field in the Memory Workspace
  - Layer(FeatureCollection fc)
    
    Create a new Layer from a GeoTools FeatureCollection.
    Parameters:
    fc - The GeoTools FeatureCollection
  - Layer(java.lang.String name, FeatureCollection fc)
    
    Create a new Layer from a GeoTools FeatureCollection
    Parameters:
    name - The name of the new Layer
    fc - The GeoTools FeatureCollection
  - Layer()
- Method Detail
  - void add(java.lang.Object o)
    
    Add a Feature to the Layer
    Parameters:
    o - The Feature, the List of Features, or a List/Map of values
  - Bounds bounds(java.lang.Object filter)
    
    Get the Bounds of the Features in the Layer
    Parameters:
    filer - The Filter or Filter String to limit the Features used to construct the bounds. Defaults to null.
    Returns:
    The Bounds of the Features in the Layer
  - Bounds bounds(Map options)
    
    Get the Bounds of Layer using named parameters
    Parameters:
    options - The named parameters
    
    filter = A Filter or a CQL String
    
    params = A Map of parameters to plugin into a query
    Returns:
    The Bounds
  - Layer buffer(Map options, double distance)
    
    Buffer all of the Features in the this Layer.
    Parameters:
    options - The Map of options which can include outWorkspace and outLayer
    
    outLayer = The output Layer's name
    
    outWorkspace = The output Workspace
    
    quadrantSegments = The number of quadrant segments
    
    capStyle = The end cap style
    
    singleSided = Whether the buffer should be single sided or not
    distance - The buffer distance
    Returns:
    A Layer with the buffered Features
  - Layer buffer(Map options, Expression distance)
    
    Buffer all of the Features in the this Layer.
    Parameters:
    options - The Map of options which can include outWorkspace and outLayer
    
    outLayer = The output Layer's name
    
    outWorkspace = The output Workspace
    
    quadrantSegments = The number of quadrant segments
    
    capStyle = The end cap style
    
    singleSided = Whether the buffer should be single sided or not
    distance - An Expression that represents the buffer distance (can be a Literal, Function, or Property)
    Returns:
    A Layer with the buffered Features
  - Layer clip(Map options, Layer clipLayer)
    
    Clip this Layer by another Layer.
    Parameters:
    options - Named parameters
    
    outLayer = The name of the output Layer (defaults to this.layer.name_clipLayer.name_clipped)
    
    outWorkspace = The output Workspace (defaults to the Memory Workspace)
    clipLayer - The clip Layer
    Returns:
    The clipped Layer
  - List collectFromFeature(java.lang.Object filter, Closure closure)
    
    Collect values from the Features of a Layer
    Parameters:
    filter - The Filter which is optional
    closure - A Closure which takes a Feature and returns a value
  - List collectFromFeature(Map options, Closure closure)
    
    Collect values from the Features of a Layer
    Returns:
    Parameters:
    options - The named parameters
    
    filter = The Filter or Filter String to limit the Features. Defaults to null.
    
    sort = A List of Lists that define the sort order [[Field or Field name, "ASC" or "DESC"],...]. Not all Layers support sorting!
    
    max= The maximum number of Features to include in the Cursor
    
    start = The index of the record to start the cursor at. Together with maxFeatures this simulates paging. Not all Layers support the start index and paging!
    
    fields = A List of Fields or Field names to include. Used to select only a subset of Fields.
    
    params = A Map of parameters to plug into the query.
    
    closure - The Closure which takes a Feature and returns a value
  - int count(java.lang.Object filter)
    
    Count the number of Features in the layer
    Parameters:
    filer - The Filter or Filter String to limit the number of Features counted. Defaults to null.
    Returns:
    The number of Features in the Layer
  - int count(Map options)
    
    Count the number of Features using named parameters
    Parameters:
    options - The named parameters
    
    filter = A Filter or CQL String
    
    params = A Map of parameters based to the query
    Returns:
    The number of Features in the Layer
  - void delete(java.lang.Object filter)
    
    Delete Features from the Layer
    Parameters:
    filer - The Filter or Filter String to limit the Features to delete. Defaults to null.
  - Layer dissolve(Map options, Field field)
    
    Dissolve the Features of a Layer by a Field.
    Parameters:
    options - A Map of options that can include outLayer, outWorkspace, idFieldName, and countFieldName
    layer - The input Layer
    field - The Field
    Returns:
    The output Layer
  - Layer dissolve(Map options)
    
    Dissolve intersecting Features of a Layer.
    Parameters:
    options - A Map of options that can include outLayer, outWorkspace, idFieldName, and countFieldName
    
    outLayer = The output Layer's name
    
    outWorkspace = The output Workspace
    
    idFieldName = The ID Field name (id)
    
    countyFieldName = The count Field name (count)
    layer - The input Layer
    field - The Field
    Returns:
    The output Layer
  - void eachFeature(java.lang.Object filter, Closure closure)
    
    Call the Closure for each Feature optionally filtered by the Filter
    Parameters:
    filter - The Filter which is optional
    closure - A Closure which takes a Feature
  - void eachFeature(Map options, Closure closure)
    
    Call the Closure for each Feature.
    Parameters:
    options - The named parameters
    
    filter = The Filter or Filter String to limit the Features. Defaults to null.
    
    sort = A List of Lists that define the sort order [[Field or Field name, "ASC" or "DESC"],...]. Not all Layers support sorting!
    
    max= The maximum number of Features to include in the Cursor
    
    start = The index of the record to start the cursor at. Together with maxFeatures this simulates paging. Not all Layers support the start index and paging!
    
    fields = A List of Fields or Field names to include. Used to select only a subset of Fields.
    
    params = A Map of parameters to plug into the query.
    closure - The Closure which takes a Feature
  - Layer erase(Map options, Layer layer2)
    
    Erase this Layer with another Layer.
    Parameters:
    options - Named parameters
    
    outLayer = The name of the output Layer (defaults to this.layer.name_layer2.name_erase)
    
    outWorkspace = The output Workspace (defaults to the Memory Workspace)
    layer2 - The second Layer
    Returns:
    The output Layer
  - Layer filter(java.lang.Object filter, java.lang.String newName)
    
    Filer the Layer.
    Parameters:
    filter - A Filter or Filter String used to limit the number of Features returned in the new Layer
    newName - The name of the new Layer (defaults to a default new name)
    Returns:
    A new Layer in the same workspace
  - Feature first(Map options)
    
    Get the first Feature that matches
    Returns:
    Parameters:
    options - Named parameters
    
    filter = A geoscript.filter.Filter or CQL String
    
    sort = A String (FIELD ASC | DESC) or List of Strings
    
    params = A Map of parameters to plugin into the query
  - static Layer fromGeometries(Map options, java.lang.String name, List geometries)
    
    Create a Layer from a List of Geometries
    Parameters:
    options - Optional named parameters:
    
    proj = The Projection (defaults to EPSg:4326)
    
    style = A Style
    name - The name of the new Layer
    geometries - The List of Geometries
    Returns:
    The Layer
  - static Layer fromGeometry(Map options, java.lang.String name, Geometry geometry)
    
    Create a Layer from a Geometry
    Parameters:
    options - Optional named parameters:
    
    proj = The Projection (defaults to EPSg:4326)
    
    style = A Style
    name - The name of the new Layer
    geometry - The Geometry
    Returns:
    The Layer
  - Bounds getBounds()
    
    Get the Bounds of the Features in the Layer
    Returns:
    The Bounds of the Features in the Layer
  - int getCount()
    
    Count the number of Features in the layer
    Returns:
    The number of Features in the Layer
  - Cursor getCursor(Map options)
    
    Get a Cursor over the Features of the Layer using named parameters.
    Parameters:
    options. - The Map of named parameters can include:
    
    filter = The Filter or Filter String to limit the Features. Defaults to null.
    
    sort = A List of Lists that define the sort order [[Field or Field name, "ASC" or "DESC"],...]. Not all Layers support sorting!
    
    max= The maximum number of Features to include in the Cursor
    
    start = The index of the record to start the cursor at. Together with maxFeatures this simulates paging. Not all Layers support the start index and paging!
    
    fields = A List of Fields or Field names to include. Used to select only a subset of Fields.
    
    params = A Map of parameters to plug into the query.
    Returns:
    A Cursor
  - Cursor getCursor(java.lang.Object filter, List sort, int max, int start, List fields, java.lang.Object sourceProj, java.lang.Object destProj, java.lang.Object params)
    
    Get a Cursor over the Features of the Layer.
    Parameters:
    filter - The Filter or Filter String to limit the Features. Defaults to null.
    sort - A List of Lists [[Field or Field name, "ASC" or "DESC"],...] or a List of Strings ["name DESC", "price ASC"] that define the sort order. Not all Layers support sorting!
    max - The maximum number of Features to include in the Cursor
    start - The zero based index of the record to start the cursor at. Together with maxFeatures this simulates paging. Not all Layers support the start index and paging!
    fields - A List of Fields or Field names to include. Used to select only a subset of Fields.
    params - A Map of parameters to plug into the query.
    Returns:
    A Cursor
  - List getFeatures(java.lang.Object filter, Closure transform, List sort, Map params)
    
    Get a List of Features
    Parameters:
    filer - The Filter or Filter String to limit the Features used to construct the bounds. Defaults to null.
    transform - The Closure used to modify the Features. Defaults to null.
    sort - A List of Lists that define the sort order [[Field or Field name, "ASC" or "DESC"],...]. Not all Layers support sorting!
    params - A Map of parameters to plug into the query.
    Returns:
    A List of Features
  - List getFeatures(Map options)
    
    Get a List of Features
    Parameters:
    options - The named parameters
    
    transform = The Closure used to modify the Features takes a Feature and returns a Feature
    
    filter = The Filter or Filter String to limit the Features. Defaults to null.
    
    sort = A List of Lists that define the sort order [[Field or Field name, "ASC" or "DESC"],...]. Not all Layers support sorting!
    
    max= The maximum number of Features to include in the Cursor
    
    start = The index of the record to start the cursor at. Together with maxFeatures this simulates paging. Not all Layers support the start index and paging!
    
    fields = A List of Fields or Field names to include. Used to select only a subset of Fields.
    
    params = A Map of parameters to plug into the query.
    Returns:
    A List of Features
  - java.lang.String getFormat()
    
    Get the Workspace format
    Returns:
    The format identifying the workspace
  - List getMapLayers(Bounds bounds, List size)
    
    Get the map layers @return
  - java.lang.String getName()
    
    Get the Layer's name
    Returns:
    The Layer's name
  - Projection getProj()
    
    Get the Layer's Projection
    Returns:
    The Layer's Projection
  - Raster getRaster(java.lang.Object field, List gridSize, Bounds bounds, java.lang.String rasterName)
    
    Convert this Layer into a Raster
    Parameters:
    field - The numeric Field or Field name from which to get values
    gridSize - The grid size (width and height)
    bounds - The Bounds of the Raster
    name - The name of the Raster
    Returns:
    A Raster
  - Writer getWriter(Map options)
    
    Get a Writer for this Layer
    Parameters:
    options - The named parameters
    
    batch: The number of features to write at one time (defaults to 1000)
    
    transaction: The type of transaction: null, auto or autocommit, or default. The default value depends on the type of Layer.
    Returns:
    A Writer
  - List histogram(java.lang.Object field, int classes)
    
    Calculate a histogram of values for an attribute of the Layer.
    Parameters:
    field - The Field or field name
    classes - The number of classes
    Returns:
    A List of Lists for each class
  - Layer identity(Map options, Layer layer2)
    
    Calculate the identity between this Layer and another Layer.
    Parameters:
    options - Named parameters
    
    outLayer = The name of the output Layer (defaults to this.layer.name_layer2.name_identity)
    
    outWorkspace = The output Workspace (defaults to the Memory Workspace)
    
    postfixAll = Whether to postfix all field names when combining schemas (defaults to false)
    
    includeDuplicates = Whether to include duplicate field names (defaults to true)
    
    maxFieldNameLength = The maximum field name length (defaults to 10 if output Workspace is Directory, otherwise there is no limit)
    layer2 - The second Layer
    Returns:
    The output Layer
  - List interpolate(java.lang.Object field, int classes, java.lang.String method)
    
    Create a List of interpolated values for a Field
    Parameters:
    field - The Field of Field name
    classes - The number of classes
    method - The interpolation method: linear, exp(onential), log(arithmic)
    Returns:
    A List of values
  - Layer intersection(Map options, Layer layer2)
    
    Intersect this Layer with another Layer.
    Parameters:
    options - Named parameters
    
    outLayer = The name of the output Layer (defaults to this.layer.name_layer2.name_intersection)
    
    outWorkspace = The output Workspace (defaults to the Memory Workspace)
    
    postfixAll = Whether to postfix all field names when combining schemas (defaults to false)
    
    includeDuplicates = Whether to include duplicate field names (defaults to true)
    
    maxFieldNameLength = The maximum field name length (defaults to 10 if output Workspace is Directory, otherwise there is no limit)
    layer2 - The second Layer
    Returns:
    The output Layer
  - Layer merge(Map options, Layer otherLayer)
    
    Merge this Layer with another Layer to create an output Layer
    Parameters:
    options - A Map of options that can include outLayer or outWorkspace
    
    outLayer = The output Layer's name
    
    outWorkspace = The output Workspace
    
    postfixAll = Whether to add a postfix to all field names
    
    includeDuplicates = Whether to include duplicate fields
    
    maxFieldNameLength = The maximum Field name length
    otherLayer - The other layer
    Returns:
    The merged Layer
  - Map minmax(java.lang.Object field, java.lang.Object low, java.lang.Object high)
    
    Calculates the minimum and maximum values for an attribute of the Layer.
    Parameters:
    field - The Field
    low - The low/minimum value
    high - The high/maximum value
    Returns:
    A Map with mininimum (min) and maximum (max) values
  - static java.lang.String newname()
    
    Generate a new name
    Returns:
    A new Layer name
  - void plus(java.lang.Object o)
    
    Add a Feature to the Layer
    Parameters:
    o - The Feature or List/Map of values
  - void queueModified(Feature feature, java.lang.String name)
    
    Add the Feature to a List of modified Features
    Parameters:
    feature - The modified Feature
    name - The modified field name.
  - protected FeatureCollection readFeatures(Cursor cursor, Schema schema, int chunk)
    
    Read Features from a Cursor in Batches.
    Parameters:
    cursor - The Cursor
    schema - The output Schema
    chunk - The number of Features to be read
    Returns:
    A GeoTools FeatureCollection
  - Layer reproject(Projection p, java.lang.String newName, int chunk, Projection sourceProjection)
    
    Reproject the Layer
    Parameters:
    p - The Projection
    newName - The new name (defaults to a default new name)
    chunk - The number of Features to reproject in one batch
    sourceProjection - The optional default source Projection if the Layer doesn't have a Projection defined
    Returns:
    The reprojected Layer
  - Layer reproject(Projection p, Workspace outputWorkspace, java.lang.String newName, int chunk, Projection sourceProjection)
    
    Reproject the Layer to another Layer in the given Workspace
    Parameters:
    p - The Projection
    outputWorkspace - The output Workspace
    newName - The name of the new Layer
    chunk - The number of Features to reproject in one batch
    sourceProjection - The optional default source Projection if the Layer doesn't have a Projection defined
    Returns:
    The reprojected Layer
  - Layer reproject(Layer projectedLayer, int chunk, Projection sourceProjection)
    
    Reproject this Layer to another Layer that already exists.
    Parameters:
    projectedLayer - The already created projected Layer
    chunk - The number of Features to reproject in one batch
    sourceProjection - The optional default source Projection if the Layer doesn't have a Projection defined
    Returns:
    The projected Layer
  - protected double round2(double num)
  - protected void setDefaultSymbolizer(java.lang.String geometryType)
    
    Set the default Symbolizer based on the geometry type
    Parameters:
    geometryType - The geometry type
    Returns:
    A default Symbolizer
  - void setProj(java.lang.Object value)
    
    Set the Layer's Projection.
    Parameters:
    value - The value can either be a Projection or a String
  - void split(Field field, Workspace workspace)
    
    Split this Layer into sub Layers based on values taken from the Field. The new Layers are created in the given Workspace.
    Parameters:
    field - The Field that contains the values that will be used to split the Layer
    workspace - The Workspace where the new Layers will be created
  - void split(Layer splitLayer, Field field, Workspace workspace)
    
    Split this Layer into multiple Layers based on the Features from the split Layer.
    Parameters:
    splitLayer - The split Layer whose Features are used to split this Layer into multiple Layers
    field - The Field from the split Layer used to name the new Layers
    workspace - The Workspace where the new Layers are created
  - Layer symDifference(Map options, Layer layer2)
    
    Calculate the symmetric difference between this Layer and another Layer.
    Parameters:
    options - Named parameters
    
    outLayer = The name of the output Layer (defaults to this.layer.name_layer2.name_symdifference)
    
    outWorkspace = The output Workspace (defaults to the Memory Workspace)
    
    postfixAll = Whether to postfix all field names when combining schemas (defaults to false)
    
    includeDuplicates = Whether to include duplicate field names (defaults to true)
    
    maxFieldNameLength = The maximum field name length (defaults to 10 if output Workspace is Directory, otherwise there is no limit)
    layer2 - The second Layer
    Returns:
    The output Layer
  - java.lang.String toString()
    
    The string representation
    Returns:
    The string representation
  - Layer transform(java.lang.String name, Map definitions)
    
    Transform this Layer into a Layer with a new name using a Map of definitions.
    Parameters:
    name - The new name
    definitions - A Map of Definitions (key=Field name, value=Expression)
    Returns:
    A new transformed Layer
  - Layer union(Map options, Layer layer2)
    
    Union this Layer with another Layer.
    Parameters:
    options - Named parameters
    
    outLayer = The name of the output Layer (defaults to this.layer.name_layer2.name_union)
    
    outWorkspace = The output Workspace (defaults to the Memory Workspace)
    
    postfixAll = Whether to postfix all field names when combining schemas (defaults to false)
    
    includeDuplicates = Whether to include duplicate field names (defaults to true)
    
    maxFieldNameLength = The maximum field name length (defaults to 10 if output Workspace is Directory, otherwise there is no limit)
    layer2 - The second Layer
    Returns:
    The unioned Layer
  - void update(Field fld, java.lang.Object value, java.lang.Object filter, boolean isScript)
    
    Update the values of a Field
    Parameters:
    fld - The Field whose values will be updated
    value - Either a static value, a Closure that takes a Feature and return an Object, an Expression, or a Groovy Script (if isScript is true)
    filter - The Filter to limit the Features that will be updated
    isScript - A flag for whether the value is a Groovy script or not (defaults to false). If the value is a script, it can access the Feature as variable f and the counter as variable c.
  - void update()
    
    Update all modified Features whose values where changed with the Feature.set(field,value) method.
  - Layer update(Map options, Layer layer2)
    
    Calculate the update between this Layer and another Layer.
    Parameters:
    options - Named parameters
    
    outLayer = The name of the output Layer (defaults to this.layer.name_layer2.name_update)
    
    outWorkspace = The output Workspace (defaults to the Memory Workspace)
    layer2 - The second Layer
    Returns:
    The output Layer
  - void withWriter(Map options, Closure c)
    
    Add Features to a Writer within a Closure that takes a Writer ready to adding Features.
    Parameters:
    options - The named parameters
    
    batch: The number of features to write at one time (defaults to 1000)
    
    transaction: The type of transaction: null, auto or autocommit, or default. The default value depends on the type of Layer.
    c - A Closure which takes one parameter, a Writer

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Groovy] Class Layer

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected static final FilterFactory2 filterFactory

Property Detail

private FeatureSource fs

private java.lang.String name

Projection proj

private Schema schema

private Style style

private Workspace workspace

Constructor Detail

Layer(FeatureSource fs)

Layer(Layer layer)

Layer(java.lang.String name, Workspace workspace, FeatureSource fs, Schema schema)

Layer(Workspace workspace, FeatureSource fs)

Layer(java.lang.String name, Workspace workspace)

Layer(java.lang.String name, Schema schema)

Layer()

Layer(java.lang.String name)

Layer(FeatureCollection fc)

Layer(java.lang.String name, FeatureCollection fc)

Layer()

Method Detail

void add(java.lang.Object o)

Bounds bounds(java.lang.Object filter)

Bounds bounds(Map options)

Layer buffer(Map options, double distance)

Layer buffer(Map options, Expression distance)

Layer clip(Map options, Layer clipLayer)

List collectFromFeature(java.lang.Object filter, Closure closure)

List collectFromFeature(Map options, Closure closure)

int count(java.lang.Object filter)

int count(Map options)

void delete(java.lang.Object filter)

Layer dissolve(Map options, Field field)

Layer dissolve(Map options)

void eachFeature(java.lang.Object filter, Closure closure)

void eachFeature(Map options, Closure closure)

Layer erase(Map options, Layer layer2)

Layer filter(java.lang.Object filter, java.lang.String newName)

Feature first(Map options)

static Layer fromGeometries(Map options, java.lang.String name, List geometries)

static Layer fromGeometry(Map options, java.lang.String name, Geometry geometry)

Bounds getBounds()

int getCount()

Cursor getCursor(Map options)

Cursor getCursor(java.lang.Object filter, List sort, int max, int start, List fields, java.lang.Object sourceProj, java.lang.Object destProj, java.lang.Object params)

List getFeatures(java.lang.Object filter, Closure transform, List sort, Map params)

List getFeatures(Map options)

java.lang.String getFormat()

List getMapLayers(Bounds bounds, List size)

java.lang.String getName()

Projection getProj()

Raster getRaster(java.lang.Object field, List gridSize, Bounds bounds, java.lang.String rasterName)

Writer getWriter(Map options)

List histogram(java.lang.Object field, int classes)

Layer identity(Map options, Layer layer2)

List interpolate(java.lang.Object field, int classes, java.lang.String method)

Layer intersection(Map options, Layer layer2)

Layer merge(Map options, Layer otherLayer)

Map minmax(java.lang.Object field, java.lang.Object low, java.lang.Object high)

static java.lang.String newname()

void plus(java.lang.Object o)

void queueModified(Feature feature, java.lang.String name)

protected FeatureCollection readFeatures(Cursor cursor, Schema schema, int chunk)

Layer reproject(Projection p, java.lang.String newName, int chunk, Projection sourceProjection)

Layer reproject(Projection p, Workspace outputWorkspace, java.lang.String newName, int chunk, Projection sourceProjection)

Layer reproject(Layer projectedLayer, int chunk, Projection sourceProjection)

protected double round2(double num)

protected void setDefaultSymbolizer(java.lang.String geometryType)

void setProj(java.lang.Object value)

void split(Field field, Workspace workspace)

void split(Layer splitLayer, Field field, Workspace workspace)

Layer symDifference(Map options, Layer layer2)

java.lang.String toString()