Process (Groovy Documentation)

geoscript.process.Process

A Process is a way of packaging spatial algorithms. You can create a GeoScript Process by name and get access to all of the built in GeoTool's Processes:

 def p = new Process("gs:Bounds")
 Map results = p.execute(["features": layer])

Or you can create a new Process using a Groovy Closure:

 Process p = new Process("convexhull",
   "Create a convexhull around the features",
   [features: geoscript.layer.Cursor],
   [result: geoscript.layer.Cursor],
   { inputs ->
       def geoms = new GeometryCollection(inputs.features.collect{f -> f.geom})
       def output = new Layer()
       output.add([geoms.convexHull])
       [result: output]
   }
 )
 Map results = p.execute(["features": layer])

Authors:: Jared Erickson

Properties Summary

Properties
Type	Name and description
`private Process`	`process` The underlying GeoTools Process

Constructor Summary

Constructors
Constructor and description
`Process (java.lang.String name)` Create a Process by name.
`Process (java.lang.String name, java.lang.String description, Map inputs, Map outputs, Closure closure)` Create a new Process with a Groovy Closure
`Process ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`static java.lang.Object`	`convert(java.lang.Object source, java.lang.Class target)` Convert the source Object to the target Class if possible.
	`static java.lang.Class`	`convertGeoScriptToGeoToolsClass(java.lang.Class geoScriptClass)` Convert GeoScript classes to a corresponding GeoTools class Parameters: `geoScriptClass` - The GeoScript class Returns: The Class
	`static java.lang.Class`	`convertGeoToolsToGeoScriptClass(java.lang.Class geoToolsClass)` Convert a GeoTools Class to a correspondng GeoScript Class Parameters: `geoToolsClass` - The GeoTools Class Returns: The Class
	`Map`	`execute(Map params)` Execute this Process with the given parameters Parameters: `params` - The input parameters Returns: A Map or results
	`java.lang.String`	`getDescription()` Get the description Returns: The description
	`java.lang.String`	`getName()` Get the name Returns: The name
	`Map`	`getParameters()` Get the Map of input parameters.
	`static List`	`getProcessNames()` Get a List of the Process names Returns: A List of Process names
	`Map`	`getResults()` Get the Map of output results.
	`java.lang.String`	`getTitle()` Get the title Returns: The title
	`java.lang.String`	`getVersion()` Get the version Returns: The version
	`static void`	`registerProcess(java.lang.String name, java.lang.String description, Map inputs, Map outputs, Closure closure)` Register a Process with the GeoScript ProcessFactory Parameters: `name` - The name of the Process `description` - The description `inputs` - The input parameters `outputs` - The output results `closure` - The Groovy Closure
	`java.lang.String`	`toString()` The string representation Returns: The string representation

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
  - private Process process
    
    The underlying GeoTools Process
- Constructor Detail
  - Process(java.lang.String name)
    
    Create a Process by name. If the namespace is not given, "geoscript" is the default.
    Parameters:
    name - The name of the Process
  - Process(java.lang.String name, java.lang.String description, Map inputs, Map outputs, Closure closure)
    
    Create a new Process with a Groovy Closure
    Parameters:
    name - The name of the Process
    description - The description
    inputs - The input parameters
    outputs - The output results
    closure - The Groovy Closure
  - Process()
- Method Detail
  - static java.lang.Object convert(java.lang.Object source, java.lang.Class target)
    
    Convert the source Object to the target Class if possible. This is used to convert GeoScript and GeoTools objects back and forth
    Parameters:
    source - The source Object
    target - The target Class
    Returns:
    The source Object as the target Class (if possible)
  - static java.lang.Class convertGeoScriptToGeoToolsClass(java.lang.Class geoScriptClass)
    
    Convert GeoScript classes to a corresponding GeoTools class
    Parameters:
    geoScriptClass - The GeoScript class
    Returns:
    The Class
  - static java.lang.Class convertGeoToolsToGeoScriptClass(java.lang.Class geoToolsClass)
    
    Convert a GeoTools Class to a correspondng GeoScript Class
    Parameters:
    geoToolsClass - The GeoTools Class
    Returns:
    The Class
  - Map execute(Map params)
    
    Execute this Process with the given parameters
    Parameters:
    params - The input parameters
    Returns:
    A Map or results
  - java.lang.String getDescription()
    
    Get the description
    Returns:
    The description
  - java.lang.String getName()
    
    Get the name
    Returns:
    The name
  - Map getParameters()
    
    Get the Map of input parameters.
    Returns:
    The Map of input parameters
  - static List getProcessNames()
    
    Get a List of the Process names
    Returns:
    A List of Process names
  - Map getResults()
    
    Get the Map of output results.
    Returns:
    The Map of output results
  - java.lang.String getTitle()
    
    Get the title
    Returns:
    The title
  - java.lang.String getVersion()
    
    Get the version
    Returns:
    The version
  - static void registerProcess(java.lang.String name, java.lang.String description, Map inputs, Map outputs, Closure closure)
    
    Register a Process with the GeoScript ProcessFactory
    Parameters:
    name - The name of the Process
    description - The description
    inputs - The input parameters
    outputs - The output results
    closure - The Groovy Closure
  - java.lang.String toString()
    
    The string representation
    Returns:
    The string representation

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class Process

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

private Process process

Constructor Detail

Process(java.lang.String name)

Process(java.lang.String name, java.lang.String description, Map inputs, Map outputs, Closure closure)

Process()

Method Detail

static java.lang.Object convert(java.lang.Object source, java.lang.Class target)

static java.lang.Class convertGeoScriptToGeoToolsClass(java.lang.Class geoScriptClass)

static java.lang.Class convertGeoToolsToGeoScriptClass(java.lang.Class geoToolsClass)

Map execute(Map params)

java.lang.String getDescription()

java.lang.String getName()

Map getParameters()

static List getProcessNames()

Map getResults()

java.lang.String getTitle()

java.lang.String getVersion()

static void registerProcess(java.lang.String name, java.lang.String description, Map inputs, Map outputs, Closure closure)

java.lang.String toString()