Interface GeometryFunction
- All Known Implementing Classes:
BaseGeometryFunction
,RepeaterGeometryFunction
,StaticMethodGeometryFunction
public interface GeometryFunction
A reification of a function which can be executed on a
Geometry
, possibly with other arguments.
The function may return a Geometry or a scalar value.-
Method Summary
Modifier and TypeMethodDescriptionboolean
Two functions are the same if they have the same name, parameter types and return type.Gets the category name of this functionGets the description of this functiongetName()
Gets the name of this functionString[]
Gets the parameter names for this functionClass[]
Gets the types of the other function arguments, if any.Gets the return type of this functionGets a string representing the signature of this function.Invokes this function.boolean
isBinary()
-
Method Details
-
getCategory
String getCategory()Gets the category name of this function- Returns:
- the category name of the function
-
getName
String getName()Gets the name of this function- Returns:
- the name of the function
-
getDescription
String getDescription()Gets the description of this function- Returns:
- the name of the function
-
getParameterNames
String[] getParameterNames()Gets the parameter names for this function- Returns:
- the names of the function parameters
-
getParameterTypes
Class[] getParameterTypes()Gets the types of the other function arguments, if any.- Returns:
- the types
-
getReturnType
Class getReturnType()Gets the return type of this function- Returns:
- the type of the value returned by this function
-
getSignature
String getSignature()Gets a string representing the signature of this function.- Returns:
- the string for the function signature
-
invoke
Invokes this function. Note that any exceptions returned must beRuntimeException
s.- Parameters:
geom
- the target geometryargs
- the other arguments to the function- Returns:
- the value computed by the function
-
equals
Two functions are the same if they have the same name, parameter types and return type. -
isBinary
boolean isBinary()
-