LayerExtensionModule (Groovy Documentation)

geoscript.layer.io.LayerExtensionModule

A Groovy Extension Module that adds methods to the Layer class.
Authors:
Jared Erickson

Constructor Summary

Constructors
Constructor and description
`LayerExtensionModule ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`static void`	`toGML(Layer layer, OutputStream out)` Write the Layer as GML to an OutputStream Parameters: `layer` - The Layer `out` - The OutputStream (defaults to System.out)
	`static void`	`toGMLFile(Layer layer, File file)` Write the Layer as GML to a File Parameters: `layer` - The Layer `file` - The File
	`static java.lang.String`	`toGMLString(Layer layer)` Write the Layer as GML to a String Parameters: `layer` - The Layer `out` - A GML String
	`static void`	`toGeobuf(Layer layer, OutputStream out)` Write the Layer as Geobuf to an OutputStream Parameters: `layer` - The Layer `out` - The OutputStream (defaults to System.out)
	`static [B`	`toGeobufBytes(Layer layer)` Write the Layer as Geobuf to a byte array Parameters: `layer` - The Layer `out` - A Geobuf byte array
	`static void`	`toGeobufFile(Layer layer, File file)` Write the Layer as Geobuf to a File Parameters: `layer` - The Layer `file` - The File
	`static java.lang.String`	`toGeobufString(Layer layer)` Write the Layer as Geobuf to a String Parameters: `layer` - The Layer `out` - A Geobuf Hex String
	`static void`	`toJSON(Layer layer, OutputStream out)` Write the Layer as GeoJSON to an OutputStream Parameters: `layer` - The Layer `out` - The OutputStream (defaults to System.out)
	`static void`	`toJSON(Layer layer, Map options, OutputStream out)` Write the Layer as GeoJSON to an OutputStream Parameters: `layer` - The Layer `options` - Optional named parameters: decimals = The number of decimals (defaults to 4) encodeFeatureBounds = Whether to encode Feature Bounds (default is false) encodeFeatureCollectionBounds = Whether to encode FeatureCollection Bounds (default is false) encodeFeatureCollectionCRS = Whether to encode FeatureCollection CRS (default is false) encodeFeatureCRS = Whether to encode Feature CRS (default is false) encodeNullValues = Whether to encode null values (default is false) `out` - The OutputStream (defaults to System.out)
	`static void`	`toJSONFile(Layer layer, Map options, File file)` Write the Layer as GeoJSON to a File Parameters: `layer` - The Layer `options` - Optional named parameters: decimals = The number of decimals (defaults to 4) encodeFeatureBounds = Whether to encode Feature Bounds (default is false) encodeFeatureCollectionBounds = Whether to encode FeatureCollection Bounds (default is false) encodeFeatureCollectionCRS = Whether to encode FeatureCollection CRS (default is false) encodeFeatureCRS = Whether to encode Feature CRS (default is false) encodeNullValues = Whether to encode null values (default is false) `file` - The File
	`static java.lang.String`	`toJSONString(Layer layer, Map options)` Write the Layer as GeoJSON to a String Parameters: `layer` - The Layer `options` - Optional named parameters: decimals = The number of decimals (defaults to 4) encodeFeatureBounds = Whether to encode Feature Bounds (default is false) encodeFeatureCollectionBounds = Whether to encode FeatureCollection Bounds (default is false) encodeFeatureCollectionCRS = Whether to encode FeatureCollection CRS (default is false) encodeFeatureCRS = Whether to encode Feature CRS (default is false) encodeNullValues = Whether to encode null values (default is false) `out` - A GeoJSON String
	`static void`	`toKML(Layer layer, OutputStream out, Closure nameClosure, Closure descriptionClosure)` Write the Layer as KML to an OutputStream.
	`static void`	`toKMLFile(Layer layer, File file, Closure nameClosure, Closure descriptionClosure)` Write the Layer as KML to a File.
	`static java.lang.String`	`toKMLString(Layer layer, Closure nameClosure, Closure descriptionClosure)` Write the Layer as KML to a String.

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

- Constructor Detail
  - LayerExtensionModule()
- Method Detail
  - static void toGML(Layer layer, OutputStream out)
    
    Write the Layer as GML to an OutputStream
    Parameters:
    layer - The Layer
    out - The OutputStream (defaults to System.out)
  - static void toGMLFile(Layer layer, File file)
    
    Write the Layer as GML to a File
    Parameters:
    layer - The Layer
    file - The File
  - static java.lang.String toGMLString(Layer layer)
    
    Write the Layer as GML to a String
    Parameters:
    layer - The Layer
    out - A GML String
  - static void toGeobuf(Layer layer, OutputStream out)
    
    Write the Layer as Geobuf to an OutputStream
    Parameters:
    layer - The Layer
    out - The OutputStream (defaults to System.out)
  - static [B toGeobufBytes(Layer layer)
    
    Write the Layer as Geobuf to a byte array
    Parameters:
    layer - The Layer
    out - A Geobuf byte array
  - static void toGeobufFile(Layer layer, File file)
    
    Write the Layer as Geobuf to a File
    Parameters:
    layer - The Layer
    file - The File
  - static java.lang.String toGeobufString(Layer layer)
    
    Write the Layer as Geobuf to a String
    Parameters:
    layer - The Layer
    out - A Geobuf Hex String
  - static void toJSON(Layer layer, OutputStream out)
    
    Write the Layer as GeoJSON to an OutputStream
    Parameters:
    layer - The Layer
    out - The OutputStream (defaults to System.out)
  - static void toJSON(Layer layer, Map options, OutputStream out)
    
    Write the Layer as GeoJSON to an OutputStream
    Parameters:
    layer - The Layer
    options - Optional named parameters:
    
    decimals = The number of decimals (defaults to 4)
    
    encodeFeatureBounds = Whether to encode Feature Bounds (default is false)
    
    encodeFeatureCollectionBounds = Whether to encode FeatureCollection Bounds (default is false)
    
    encodeFeatureCollectionCRS = Whether to encode FeatureCollection CRS (default is false)
    
    encodeFeatureCRS = Whether to encode Feature CRS (default is false)
    
    encodeNullValues = Whether to encode null values (default is false)
    out - The OutputStream (defaults to System.out)
  - static void toJSONFile(Layer layer, Map options, File file)
    
    Write the Layer as GeoJSON to a File
    Parameters:
    layer - The Layer
    options - Optional named parameters:
    
    decimals = The number of decimals (defaults to 4)
    
    encodeFeatureBounds = Whether to encode Feature Bounds (default is false)
    
    encodeFeatureCollectionBounds = Whether to encode FeatureCollection Bounds (default is false)
    
    encodeFeatureCollectionCRS = Whether to encode FeatureCollection CRS (default is false)
    
    encodeFeatureCRS = Whether to encode Feature CRS (default is false)
    
    encodeNullValues = Whether to encode null values (default is false)
    file - The File
  - static java.lang.String toJSONString(Layer layer, Map options)
    
    Write the Layer as GeoJSON to a String
    Parameters:
    layer - The Layer
    options - Optional named parameters:
    
    decimals = The number of decimals (defaults to 4)
    
    encodeFeatureBounds = Whether to encode Feature Bounds (default is false)
    
    encodeFeatureCollectionBounds = Whether to encode FeatureCollection Bounds (default is false)
    
    encodeFeatureCollectionCRS = Whether to encode FeatureCollection CRS (default is false)
    
    encodeFeatureCRS = Whether to encode Feature CRS (default is false)
    
    encodeNullValues = Whether to encode null values (default is false)
    out - A GeoJSON String
  - static void toKML(Layer layer, OutputStream out, Closure nameClosure, Closure descriptionClosure)
    
    Write the Layer as KML to an OutputStream.
    Parameters:
    layer - The Layer
    out - The OutputStream (defaults to System.out)
    nameClosure - A Closure that takes a Feature and returns a value used as the Placemark's name. Default to the Feature's ID
    descriptionClosure - A Closure that takes a Feature and returns a value used as the Placemark's description. Defaults to null which means no description is created
  - static void toKMLFile(Layer layer, File file, Closure nameClosure, Closure descriptionClosure)
    
    Write the Layer as KML to a File.
    Parameters:
    layer - The Layer
    file - The File we are writing
    nameClosure - A Closure that takes a Feature and returns a value used as the Placemark's name. Default to the Feature's ID
    descriptionClosure - A Closure that takes a Feature and returns a value used as the Placemark's description. Defaults to null which means no description is created
  - static java.lang.String toKMLString(Layer layer, Closure nameClosure, Closure descriptionClosure)
    
    Write the Layer as KML to a String.
    Parameters:
    layer - The Layer
    nameClosure - A Closure that takes a Feature and returns a value used as the Placemark's name. Default to the Feature's ID
    descriptionClosure - A Closure that takes a Feature and returns a value used as the Placemark's description. Defaults to null which means no description is created

Summary:
Constructor
Method

| Detail:
Constructor
Method

Groovy Documentation

[Groovy] Class LayerExtensionModule

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

LayerExtensionModule()

Method Detail

static void toGML(Layer layer, OutputStream out)

static void toGMLFile(Layer layer, File file)

static java.lang.String toGMLString(Layer layer)

static void toGeobuf(Layer layer, OutputStream out)

static [B toGeobufBytes(Layer layer)

static void toGeobufFile(Layer layer, File file)

static java.lang.String toGeobufString(Layer layer)

static void toJSON(Layer layer, OutputStream out)

static void toJSON(Layer layer, Map options, OutputStream out)

static void toJSONFile(Layer layer, Map options, File file)

static java.lang.String toJSONString(Layer layer, Map options)

static void toKML(Layer layer, OutputStream out, Closure nameClosure, Closure descriptionClosure)

static void toKMLFile(Layer layer, File file, Closure nameClosure, Closure descriptionClosure)

static java.lang.String toKMLString(Layer layer, Closure nameClosure, Closure descriptionClosure)