FeatureExtensionModule (Groovy Documentation)

geoscript.feature.io.FeatureExtensionModule

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

Constructor Summary

Constructors
Constructor and description
`FeatureExtensionModule ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`static java.lang.String`	`getGeoJSON(Feature feature, Map options)` Get this Feature as a GeoJSON String Parameters: `feature` - The Feature `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) Returns: The GeoJSON String
	`static java.lang.String`	`getGeoRSS(Feature feature, Map options)` Get this Feature as a GeoRSS String Parameters: `feature` - The Feature `options` - The named parameters feedType = The feed type (atom or rss) geometryType = The geometry type (simple, gml, w3c) includeAttributes = Whether to include all attributes attributeNamespace = The namespace for attributes (ogr=http://www.gdal/ogr/) itemTitle = The item title (Closure, Expression, or String) itemId = The item id (Closure, Expression, or String) itemDescription = The item description (Closure, Expression, or String) itemDate = The item date (Closure, Expression, or String) itemGeometry = The item geometry (Closure, Expression, or String) Returns: A GeoRSS String
	`static java.lang.String`	`getGeobuf(Feature feature, Map options)` Get this Feature as a Geobuf hex string Parameters: `feature` - The Feature `options` - The optional named parameters precision = The maximum precision (defaults to 6) dimension = The supported geometry coordinates dimension (defaults to 2) Returns: A Geobuf hex string
	`static [B`	`getGeobufBytes(Feature feature, Map options)` Get this Feature as a Geobuf byte array Parameters: `feature` - The Feature `options` - The optional named parameters precision = The maximum precision (defaults to 6) dimension = The supported geometry coordinates dimension (defaults to 2) Returns: A Geobuf byte arary
	`static java.lang.String`	`getGml(Feature feature, Map options)` Get this Feature as a GML String Parameters: `feature` - The Feature `options` - The named parameters version = The version 2, 3, or 3.2 format = Whether to pretty print or not bounds = Whether to include Feature Bounds or not xmldecl = Whether to include XML declaration or not nsprefix = The XML namespace prefix Returns: A GML String
	`static java.lang.String`	`getGpx(Feature feature, Map options)` Get this Feature as a GPX String Parameters: `feature` - The Feature `options` - The named parameters version = The GPX version (defaults to 1.1) includeAttributes = Whether to include attributes (defaults to false) attributeNamespace = The attribute namespace (prefix=url) elevation = The elevation filter, closure, or value time = The time elevation filter, closure, or value name = The name elevation filter, closure, or value description = The description elevation filter, closure, or value type = The type elevation filter, closure, or value Returns: A KML Placemark String
	`static java.lang.String`	`getKml(Feature feature, Map options)` Get this Feature as a KML Placemark Parameters: `feature` - The Feature `options` - The named parameters format = Whether to format the KML or not (default = false) xmldecl = Whether to include the XML declaration (default = false) Returns: A KML Placemark 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
  - FeatureExtensionModule()
- Method Detail
  - static java.lang.String getGeoJSON(Feature feature, Map options)
    
    Get this Feature as a GeoJSON String
    Parameters:
    feature - The Feature
    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)
    Returns:
    The GeoJSON String
  - static java.lang.String getGeoRSS(Feature feature, Map options)
    
    Get this Feature as a GeoRSS String
    Parameters:
    feature - The Feature
    options - The named parameters
    
    feedType = The feed type (atom or rss)
    
    geometryType = The geometry type (simple, gml, w3c)
    
    includeAttributes = Whether to include all attributes
    
    attributeNamespace = The namespace for attributes (ogr=http://www.gdal/ogr/)
    
    itemTitle = The item title (Closure, Expression, or String)
    
    itemId = The item id (Closure, Expression, or String)
    
    itemDescription = The item description (Closure, Expression, or String)
    
    itemDate = The item date (Closure, Expression, or String)
    
    itemGeometry = The item geometry (Closure, Expression, or String)
    Returns:
    A GeoRSS String
  - static java.lang.String getGeobuf(Feature feature, Map options)
    
    Get this Feature as a Geobuf hex string
    Parameters:
    feature - The Feature
    options - The optional named parameters
    
    precision = The maximum precision (defaults to 6)
    
    dimension = The supported geometry coordinates dimension (defaults to 2)
    Returns:
    A Geobuf hex string
  - static [B getGeobufBytes(Feature feature, Map options)
    
    Get this Feature as a Geobuf byte array
    Parameters:
    feature - The Feature
    options - The optional named parameters
    
    precision = The maximum precision (defaults to 6)
    
    dimension = The supported geometry coordinates dimension (defaults to 2)
    Returns:
    A Geobuf byte arary
  - static java.lang.String getGml(Feature feature, Map options)
    
    Get this Feature as a GML String
    Parameters:
    feature - The Feature
    options - The named parameters
    
    version = The version 2, 3, or 3.2
    
    format = Whether to pretty print or not
    
    bounds = Whether to include Feature Bounds or not
    
    xmldecl = Whether to include XML declaration or not
    
    nsprefix = The XML namespace prefix
    Returns:
    A GML String
  - static java.lang.String getGpx(Feature feature, Map options)
    
    Get this Feature as a GPX String
    Parameters:
    feature - The Feature
    options - The named parameters
    
    version = The GPX version (defaults to 1.1)
    
    includeAttributes = Whether to include attributes (defaults to false)
    
    attributeNamespace = The attribute namespace (prefix=url)
    
    elevation = The elevation filter, closure, or value
    
    time = The time elevation filter, closure, or value
    
    name = The name elevation filter, closure, or value
    
    description = The description elevation filter, closure, or value
    
    type = The type elevation filter, closure, or value
    Returns:
    A KML Placemark String
  - static java.lang.String getKml(Feature feature, Map options)
    
    Get this Feature as a KML Placemark
    Parameters:
    feature - The Feature
    options - The named parameters
    
    format = Whether to format the KML or not (default = false)
    
    xmldecl = Whether to include the XML declaration (default = false)
    Returns:
    A KML Placemark String

Summary:
Constructor
Method

| Detail:
Constructor
Method

Groovy Documentation

[Groovy] Class FeatureExtensionModule

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

FeatureExtensionModule()

Method Detail

static java.lang.String getGeoJSON(Feature feature, Map options)

static java.lang.String getGeoRSS(Feature feature, Map options)

static java.lang.String getGeobuf(Feature feature, Map options)

static [B getGeobufBytes(Feature feature, Map options)

static java.lang.String getGml(Feature feature, Map options)

static java.lang.String getGpx(Feature feature, Map options)

static java.lang.String getKml(Feature feature, Map options)