Module org.opengis.geoapi

Package org.opengis.filter.capability

Interface AvailableFunction

@UML(identifier="AvailableFunctions",
     specification=ISO_19143)
public interface AvailableFunction

A function that may be used in filter expressions. The description of each function includes a declaration of the return type, the list of arguments with optional names and expected types.

Since:

3.1

See Also:

• FilterCapabilities.getFunctions()

Method Summary

Modifier and Type	Method	Description
default List<? extends Argument>	getArguments()	Returns the list of arguments expected by the function.
LocalName	getName()	Returns the function name.
ScopedName	getReturnType()	Returns the type of return value.

Method Details

getName

@UML(identifier="name",
     obligation=MANDATORY,
     specification=ISO_19143)
LocalName getName()

Returns the function name.

Returns:

the function name.

getReturnType

@UML(identifier="returns",
     obligation=MANDATORY,
     specification=ISO_19143)
ScopedName getReturnType()

Returns the type of return value.

Returns:

the type of return value.

getArguments

@UML(identifier="arguments",
     obligation=OPTIONAL,
     specification=ISO_19143)
default List<? extends Argument> getArguments()

Returns the list of arguments expected by the function.

Returns:

arguments that the function accepts.