Interface GeometryFunction
-
- All Known Implementing Classes:
BaseGeometryFunction
,RepeaterGeometryFunction
,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.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
Two functions are the same if they have the same name, parameter types and return type.java.lang.String
getCategory()
Gets the category name of this functionjava.lang.String
getDescription()
Gets the description of this functionjava.lang.String
getName()
Gets the name of this functionjava.lang.String[]
getParameterNames()
Gets the parameter names for this functionjava.lang.Class[]
getParameterTypes()
Gets the types of the other function arguments, if any.java.lang.Class
getReturnType()
Gets the return type of this functionjava.lang.String
getSignature()
Gets a string representing the signature of this function.java.lang.Object
invoke(Geometry geom, java.lang.Object[] args)
Invokes this function.boolean
isBinary()
-
-
-
Method Detail
-
getCategory
java.lang.String getCategory()
Gets the category name of this function- Returns:
- the category name of the function
-
getName
java.lang.String getName()
Gets the name of this function- Returns:
- the name of the function
-
getDescription
java.lang.String getDescription()
Gets the description of this function- Returns:
- the name of the function
-
getParameterNames
java.lang.String[] getParameterNames()
Gets the parameter names for this function- Returns:
- the names of the function parameters
-
getParameterTypes
java.lang.Class[] getParameterTypes()
Gets the types of the other function arguments, if any.- Returns:
- the types
-
getReturnType
java.lang.Class getReturnType()
Gets the return type of this function- Returns:
- the type of the value returned by this function
-
getSignature
java.lang.String getSignature()
Gets a string representing the signature of this function.- Returns:
- the string for the function signature
-
invoke
java.lang.Object invoke(Geometry geom, java.lang.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(java.lang.Object obj)
Two functions are the same if they have the same name, parameter types and return type.- Overrides:
equals
in classjava.lang.Object
- Parameters:
obj
-- Returns:
- true if this object is the same as the obj argument
-
isBinary
boolean isBinary()
-
-