Interface GeometryFunction
-
- All Known Implementing Classes:
BaseGeometryFunction
,FilterGeometryFunction
,RepeaterGeometryFunction
,SpreaderGeometryFunction
,StaticMethodGeometryFunction
public interface GeometryFunction
A reification of a function which can be executed on aGeometry
, possibly with other arguments. The function may return a Geometry or a scalar value.- Author:
- Martin Davis
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
equals(Object obj)
Two functions are the same if they have the same name, parameter types and return type.String
getCategory()
Gets the category name of this functionString
getDescription()
Gets the description of this functionString
getName()
Gets the name of this functionString[]
getParameterNames()
Gets the parameter names for this functionClass<?>[]
getParameterTypes()
Gets the types of the other function arguments, if any.Class<?>
getReturnType()
Gets the return type of this functionString
getSignature()
Gets a string representing the signature of this function.Object
invoke(Geometry geom, Object[] args)
Invokes this function.boolean
isBinary()
boolean
isRequiredB()
-
-
-
Method Detail
-
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
Object invoke(Geometry geom, Object[] args)
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
boolean equals(Object obj)
Two functions are the same if they have the same name, parameter types and return type.
-
isBinary
boolean isBinary()
-
isRequiredB
boolean isRequiredB()
-
-