Interface ExternalFunction


  • @UML(identifier="PF_ExternalFunction",
         specification=ISO_19117)
    public interface ExternalFunction
    External functions are used to perform computations that sometimes are needed to evaluate the query statements and/or perform the portrayal rules.

    There are no limitations to the operations it can perform or the return types it can have.
    External functions shall be modeled as operations, as described in ISO 19109.
    External functions shall not be used in the default portrayal specification.

    Since:
    GeoAPI 2.2
    • Method Detail

      • getParameters

        @UML(identifier="formalParameter",
             obligation=MANDATORY,
             specification=ISO_19117)
        Collection<AttributeDefinition> getParameters()
        Formal parameters for this function. this is a immutable copy of the collection.
        Returns:
        collection of AttributeDefinition
      • getName

        @UML(identifier="functionName",
             obligation=MANDATORY,
             specification=ISO_19117)
        String getName()
        Returns the name of the function. It shall contain no spaces and always start with a letter or and underscore character.
      • getReturnType

        @UML(identifier="returnType",
             obligation=MANDATORY,
             specification=ISO_19117)
        Class getReturnType()
        Returns the class type for this function.
      • getDescription

        @UML(identifier="description",
             obligation=OPTIONAL,
             specification=ISO_19117)
        InternationalString getDescription()
        Returns a description of the function. It is a human readable value.