Class BaseGeometryFunction
- java.lang.Object
-
- org.locationtech.jtstest.geomfunction.BaseGeometryFunction
-
- All Implemented Interfaces:
Comparable
,GeometryFunction
- Direct Known Subclasses:
StaticMethodGeometryFunction
public abstract class BaseGeometryFunction extends Object implements GeometryFunction, Comparable
A base for implementations ofGeometryFunction
which provides most of the required structure. Extenders must supply the behaviour for the actual function invocation.- Author:
- Martin Davis
-
-
Field Summary
Fields Modifier and Type Field Description protected String
category
protected String
description
protected boolean
isRequiredB
protected String
name
protected String[]
parameterNames
protected Class[]
parameterTypes
protected Class
returnType
-
Constructor Summary
Constructors Constructor Description BaseGeometryFunction(String category, String name, String[] parameterNames, Class[] parameterTypes, Class returnType)
BaseGeometryFunction(String category, String name, String description, String[] parameterNames, Class[] parameterTypes, Class returnType)
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description int
compareTo(Object o)
boolean
equals(Object obj)
Two functions are the same if they have the same signature (name, parameter types and return type).static int
firstScalarParamIndex(GeometryFunction func)
String
getCategory()
Gets the category name of this functionString
getDescription()
Gets the description of this functionprotected static Double
getDoubleOrNull(Object[] args, int index)
protected static Integer
getIntegerOrNull(Object[] args, int index)
String
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.int
hashCode()
abstract Object
invoke(Geometry geom, Object[] args)
Invokes this function.boolean
isBinary()
static boolean
isBinaryGeomFunction(GeometryFunction func)
boolean
isRequiredB()
-
-
-
Method Detail
-
isBinaryGeomFunction
public static boolean isBinaryGeomFunction(GeometryFunction func)
-
firstScalarParamIndex
public static int firstScalarParamIndex(GeometryFunction func)
-
getCategory
public String getCategory()
Description copied from interface:GeometryFunction
Gets the category name of this function- Specified by:
getCategory
in interfaceGeometryFunction
- Returns:
- the category name of the function
-
getName
public String getName()
Description copied from interface:GeometryFunction
Gets the name of this function- Specified by:
getName
in interfaceGeometryFunction
- Returns:
- the name of the function
-
getDescription
public String getDescription()
Description copied from interface:GeometryFunction
Gets the description of this function- Specified by:
getDescription
in interfaceGeometryFunction
- Returns:
- the name of the function
-
getParameterNames
public String[] getParameterNames()
Description copied from interface:GeometryFunction
Gets the parameter names for this function- Specified by:
getParameterNames
in interfaceGeometryFunction
- Returns:
- the names of the function parameters
-
getParameterTypes
public Class[] getParameterTypes()
Gets the types of the other function arguments, if any.- Specified by:
getParameterTypes
in interfaceGeometryFunction
- Returns:
- the types
-
getReturnType
public Class getReturnType()
Description copied from interface:GeometryFunction
Gets the return type of this function- Specified by:
getReturnType
in interfaceGeometryFunction
- Returns:
- the type of the value returned by this function
-
isBinary
public boolean isBinary()
- Specified by:
isBinary
in interfaceGeometryFunction
-
isRequiredB
public boolean isRequiredB()
- Specified by:
isRequiredB
in interfaceGeometryFunction
-
getSignature
public String getSignature()
Description copied from interface:GeometryFunction
Gets a string representing the signature of this function.- Specified by:
getSignature
in interfaceGeometryFunction
- Returns:
- the string for the function signature
-
invoke
public abstract Object invoke(Geometry geom, Object[] args)
Description copied from interface:GeometryFunction
Invokes this function. Note that any exceptions returned must beRuntimeException
s.- Specified by:
invoke
in interfaceGeometryFunction
- Parameters:
geom
- the target geometryargs
- the other arguments to the function- Returns:
- the value computed by the function
-
equals
public boolean equals(Object obj)
Two functions are the same if they have the same signature (name, parameter types and return type).- Specified by:
equals
in interfaceGeometryFunction
- Overrides:
equals
in classObject
- Parameters:
obj
-- Returns:
- true if this object is the same as the obj argument
-
compareTo
public int compareTo(Object o)
- Specified by:
compareTo
in interfaceComparable
-
-