Interface GeometryFunction

  • All Known Implementing Classes:
    BaseGeometryFunction, 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.
    Author:
    Martin Davis
    • Method Detail

      • getName

        String getName()
        Gets the name 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
      • invoke

        Object invoke​(Geometry geom,
                      Object[] args)
        Invokes this function. Note that any exceptions returned must be RuntimeExceptions.
        Parameters:
        geom - the target geometry
        args - 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.
        Overrides:
        equals in class Object
        Parameters:
        obj -
        Returns:
        true if this object is the same as the obj argument
      • isBinary

        boolean isBinary()