Interface GeometryFunction

    • 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 function
      java.lang.String getDescription()
      Gets the description of this function
      java.lang.String getName()
      Gets the name of this function
      java.lang.String[] getParameterNames()
      Gets the parameter names for this function
      java.lang.Class[] getParameterTypes()
      Gets the types of the other function arguments, if any.
      java.lang.Class getReturnType()
      Gets the return type of this function
      java.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 be RuntimeExceptions.
        Parameters:
        geom - the target geometry
        args - 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 class java.lang.Object
        Parameters:
        obj -
        Returns:
        true if this object is the same as the obj argument
      • isBinary

        boolean isBinary()