Function (Groovy Documentation)

geoscript.filter.Function

```
class Function
extends Expression
```
A GeoScript Function either wraps an existing GeoTools Function or an CQL String.
You can create a Function from CQL:
```
 Function f = new Function("centroid(the_geom)")
 
```
You can also create a Function from CQL and a Closure:
```
 Function f = new Function("my_centroid(the_geom)", {g-> g.centroid})
 
```
See GeoServer's Function Reference for more details.
Authors:
Jared Erickson

Inherited fields
Fields inherited from class	Fields
`class Expression`	`filterFactory`

Properties Summary

Properties
Type	Name and description
`Function`	`function` The GeoTools Function

Constructor Summary

Constructors
Constructor and description
`Function (Function f)` Create a Function from a GeoTools Function
`Function (java.lang.String str)` Create a new Function from a CQL compatible string
`Function (java.lang.String name, Expression[] expressions)` Create a new Function from a name and one or more Expressions
`Function (java.lang.String name, groovy.lang.Closure closure, Expression[] expressions)` Create a new Function from a Closure with one or more Expressions.
`Function (java.lang.String cql, groovy.lang.Closure closure)` Create a new Function from CQL and a Closure.
`Function (Process process, Function[] functions)` Create a Rendering Transformation Function from a Process and a variable List of Functions.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`static java.util.List<java.lang.String>`	`getFunctionNames()` Get a List of all Function names
	`static void`	`registerFunction(java.lang.String name, groovy.lang.Closure closure)` Register a new Function by name with a Closure.
	`java.lang.String`	`toString()` The string presentation

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Expression`	`evaluate, fromCQL, getValue, toString`

- Property Detail
  - Function function
    
    The GeoTools Function
- Constructor Detail
  - Function(Function f)
    
    Create a Function from a GeoTools Function
    Parameters:
    f - The GeoTools Function
  - Function(java.lang.String str)
    
    Create a new Function from a CQL compatible string
    Parameters:
    str - A CQL String
  - Function(java.lang.String name, Expression[] expressions)
    
    Create a new Function from a name and one or more Expressions
    Parameters:
    name - The Function name
    expressions - One or more Expressions
  - Function(java.lang.String name, groovy.lang.Closure closure, Expression[] expressions)
    
    Create a new Function from a Closure with one or more Expressions.
    Parameters:
    name - The name of the new Function
    closure - The Closure
    expressions - One or more Expressions
  - Function(java.lang.String cql, groovy.lang.Closure closure)
    
    Create a new Function from CQL and a Closure.
    Parameters:
    cql - The CQL statement
    closure - The Closure
  - @java.lang.Deprecated Function(Process process, Function[] functions)
    
    Create a Rendering Transformation Function from a Process and a variable List of Functions.
    Parameters:
    process - The GeoScript Process
    functions - A variable List of Functions
- Method Detail
  - static java.util.List<java.lang.String> getFunctionNames()
    
    Get a List of all Function names
    Returns:
    A List of all Function names
  - static void registerFunction(java.lang.String name, groovy.lang.Closure closure)
    
    Register a new Function by name with a Closure.
    Parameters:
    name - The name of the new Function
    closure - The Closure
  - java.lang.String toString()
    
    The string presentation
    Returns:
    The name of the Function

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class Function

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

Function function

Constructor Detail

Function(Function f)

Function(java.lang.String str)

Function(java.lang.String name, Expression[] expressions)

Function(java.lang.String name, groovy.lang.Closure closure, Expression[] expressions)

Function(java.lang.String cql, groovy.lang.Closure closure)

@java.lang.Deprecated Function(Process process, Function[] functions)

Method Detail

static java.util.List<java.lang.String> getFunctionNames()

static void registerFunction(java.lang.String name, groovy.lang.Closure closure)

java.lang.String toString()