Package org.basex.query.func

Enum Class ApiFunction

java.lang.Object
java.lang.Enum<ApiFunction>
org.basex.query.func.ApiFunction
All Implemented Interfaces:
Serializable, Comparable<ApiFunction>, java.lang.constant.Constable, AFunction
public enum ApiFunction extends Enum<ApiFunction> implements AFunction
Definitions of all built-in XQuery functions. New namespace mappings for function prefixes and URIs must be added to the static initializer of the NSGlobal class.
Author:
BaseX Team 2005-21, BSD License, Christian Gruen

  • Enum Constant Details

    • _GEO_AREA

      public static final ApiFunction _GEO_AREA
      XQuery function.

    • _GEO_AS_BINARY

      public static final ApiFunction _GEO_AS_BINARY
      XQuery function.

    • _GEO_AS_TEXT

      public static final ApiFunction _GEO_AS_TEXT
      XQuery function.

    • _GEO_BOUNDARY

      public static final ApiFunction _GEO_BOUNDARY
      XQuery function.

    • _GEO_BUFFER

      public static final ApiFunction _GEO_BUFFER
      XQuery function.

    • _GEO_CENTROID

      public static final ApiFunction _GEO_CENTROID
      XQuery function.

    • _GEO_CONTAINS

      public static final ApiFunction _GEO_CONTAINS
      XQuery function.

    • _GEO_CONVEX_HULL

      public static final ApiFunction _GEO_CONVEX_HULL
      XQuery function.

    • _GEO_CROSSES

      public static final ApiFunction _GEO_CROSSES
      XQuery function.

    • _GEO_DIFFERENCE

      public static final ApiFunction _GEO_DIFFERENCE
      XQuery function.

    • _GEO_DIMENSION

      public static final ApiFunction _GEO_DIMENSION
      XQuery function.

    • _GEO_DISJOINT

      public static final ApiFunction _GEO_DISJOINT
      XQuery function.

    • _GEO_DISTANCE

      public static final ApiFunction _GEO_DISTANCE
      XQuery function.

    • _GEO_END_POINT

      public static final ApiFunction _GEO_END_POINT
      XQuery function.

    • _GEO_ENVELOPE

      public static final ApiFunction _GEO_ENVELOPE
      XQuery function.

    • _GEO_EQUALS

      public static final ApiFunction _GEO_EQUALS
      XQuery function.

    • _GEO_EXTERIOR_RING

      public static final ApiFunction _GEO_EXTERIOR_RING
      XQuery function.

    • _GEO_GEOMETRY_N

      public static final ApiFunction _GEO_GEOMETRY_N
      XQuery function.

    • _GEO_GEOMETRY_TYPE

      public static final ApiFunction _GEO_GEOMETRY_TYPE
      XQuery function.

    • _GEO_INTERIOR_RING_N

      public static final ApiFunction _GEO_INTERIOR_RING_N
      XQuery function.

    • _GEO_INTERSECTION

      public static final ApiFunction _GEO_INTERSECTION
      XQuery function.

    • _GEO_INTERSECTS

      public static final ApiFunction _GEO_INTERSECTS
      XQuery function.

    • _GEO_IS_CLOSED

      public static final ApiFunction _GEO_IS_CLOSED
      XQuery function.

    • _GEO_IS_RING

      public static final ApiFunction _GEO_IS_RING
      XQuery function.

    • _GEO_IS_SIMPLE

      public static final ApiFunction _GEO_IS_SIMPLE
      XQuery function.

    • _GEO_LENGTH

      public static final ApiFunction _GEO_LENGTH
      XQuery function.

    • _GEO_NUM_GEOMETRIES

      public static final ApiFunction _GEO_NUM_GEOMETRIES
      XQuery function.

    • _GEO_NUM_INTERIOR_RING

      public static final ApiFunction _GEO_NUM_INTERIOR_RING
      XQuery function.

    • _GEO_NUM_POINTS

      public static final ApiFunction _GEO_NUM_POINTS
      XQuery function.

    • _GEO_OVERLAPS

      public static final ApiFunction _GEO_OVERLAPS
      XQuery function.

    • _GEO_POINT_N

      public static final ApiFunction _GEO_POINT_N
      XQuery function.

    • _GEO_POINT_ON_SURFACE

      public static final ApiFunction _GEO_POINT_ON_SURFACE
      XQuery function.

    • _GEO_RELATE

      public static final ApiFunction _GEO_RELATE
      XQuery function.

    • _GEO_SRID

      public static final ApiFunction _GEO_SRID
      XQuery function.

    • _GEO_START_POINT

      public static final ApiFunction _GEO_START_POINT
      XQuery function.

    • _GEO_SYM_DIFFERENCE

      public static final ApiFunction _GEO_SYM_DIFFERENCE
      XQuery function.

    • _GEO_TOUCHES

      public static final ApiFunction _GEO_TOUCHES
      XQuery function.

    • _GEO_UNION

      public static final ApiFunction _GEO_UNION
      XQuery function.

    • _GEO_WITHIN

      public static final ApiFunction _GEO_WITHIN
      XQuery function.

    • _GEO_X

      public static final ApiFunction _GEO_X
      XQuery function.

    • _GEO_Y

      public static final ApiFunction _GEO_Y
      XQuery function.

    • _GEO_Z

      public static final ApiFunction _GEO_Z
      XQuery function.

    • _REQUEST_ADDRESS

      public static final ApiFunction _REQUEST_ADDRESS
      XQuery function.

    • _REQUEST_ATTRIBUTE

      public static final ApiFunction _REQUEST_ATTRIBUTE
      XQuery function.

    • _REQUEST_ATTRIBUTE_NAMES

      public static final ApiFunction _REQUEST_ATTRIBUTE_NAMES
      XQuery function.

    • _REQUEST_CONTEXT_PATH

      public static final ApiFunction _REQUEST_CONTEXT_PATH
      XQuery function.

    • _REQUEST_COOKIE

      public static final ApiFunction _REQUEST_COOKIE
      XQuery function.

    • _REQUEST_COOKIE_NAMES

      public static final ApiFunction _REQUEST_COOKIE_NAMES
      XQuery function.

    • _REQUEST_HEADER

      public static final ApiFunction _REQUEST_HEADER
      XQuery function.

    • _REQUEST_HEADER_NAMES

      public static final ApiFunction _REQUEST_HEADER_NAMES
      XQuery function.

    • _REQUEST_HOSTNAME

      public static final ApiFunction _REQUEST_HOSTNAME
      XQuery function.

    • _REQUEST_METHOD

      public static final ApiFunction _REQUEST_METHOD
      XQuery function.

    • _REQUEST_PARAMETER

      public static final ApiFunction _REQUEST_PARAMETER
      XQuery function.

    • _REQUEST_PARAMETER_NAMES

      public static final ApiFunction _REQUEST_PARAMETER_NAMES
      XQuery function.

    • _REQUEST_PATH

      public static final ApiFunction _REQUEST_PATH
      XQuery function.

    • _REQUEST_PORT

      public static final ApiFunction _REQUEST_PORT
      XQuery function.

    • _REQUEST_QUERY

      public static final ApiFunction _REQUEST_QUERY
      XQuery function.

    • _REQUEST_REMOTE_ADDRESS

      public static final ApiFunction _REQUEST_REMOTE_ADDRESS
      XQuery function.

    • _REQUEST_REMOTE_HOSTNAME

      public static final ApiFunction _REQUEST_REMOTE_HOSTNAME
      XQuery function.

    • _REQUEST_REMOTE_PORT

      public static final ApiFunction _REQUEST_REMOTE_PORT
      XQuery function.

    • _REQUEST_SCHEME

      public static final ApiFunction _REQUEST_SCHEME
      XQuery function.

    • _REQUEST_SET_ATTRIBUTE

      public static final ApiFunction _REQUEST_SET_ATTRIBUTE
      XQuery function.

    • _REQUEST_URI

      public static final ApiFunction _REQUEST_URI
      XQuery function.

    • _RESTXQ_BASE_URI

      public static final ApiFunction _RESTXQ_BASE_URI
      XQuery function.

    • _RESTXQ_INIT

      public static final ApiFunction _RESTXQ_INIT
      XQuery function.

    • _RESTXQ_URI

      public static final ApiFunction _RESTXQ_URI
      XQuery function.

    • _RESTXQ_WADL

      public static final ApiFunction _RESTXQ_WADL
      XQuery function.

    • _SESSION_ACCESSED

      public static final ApiFunction _SESSION_ACCESSED
      XQuery function.

    • _SESSION_CLOSE

      public static final ApiFunction _SESSION_CLOSE
      XQuery function.

    • _SESSION_CREATED

      public static final ApiFunction _SESSION_CREATED
      XQuery function.

    • _SESSION_DELETE

      public static final ApiFunction _SESSION_DELETE
      XQuery function.

    • _SESSION_GET

      public static final ApiFunction _SESSION_GET
      XQuery function.

    • _SESSION_ID

      public static final ApiFunction _SESSION_ID
      XQuery function.

    • _SESSION_NAMES

      public static final ApiFunction _SESSION_NAMES
      XQuery function.

    • _SESSION_SET

      public static final ApiFunction _SESSION_SET
      XQuery function.

    • _SESSIONS_ACCESSED

      public static final ApiFunction _SESSIONS_ACCESSED
      XQuery function.

    • _SESSIONS_CLOSE

      public static final ApiFunction _SESSIONS_CLOSE
      XQuery function.

    • _SESSIONS_CREATED

      public static final ApiFunction _SESSIONS_CREATED
      XQuery function.

    • _SESSIONS_DELETE

      public static final ApiFunction _SESSIONS_DELETE
      XQuery function.

    • _SESSIONS_GET

      public static final ApiFunction _SESSIONS_GET
      XQuery function.

    • _SESSIONS_IDS

      public static final ApiFunction _SESSIONS_IDS
      XQuery function.

    • _SESSIONS_NAMES

      public static final ApiFunction _SESSIONS_NAMES
      XQuery function.

    • _SESSIONS_SET

      public static final ApiFunction _SESSIONS_SET
      XQuery function.

    • _WS_BROADCAST

      public static final ApiFunction _WS_BROADCAST
      XQuery function.

    • _WS_CLOSE

      public static final ApiFunction _WS_CLOSE
      XQuery function.

    • _WS_DELETE

      public static final ApiFunction _WS_DELETE
      XQuery function.

    • _WS_EMIT

      public static final ApiFunction _WS_EMIT
      XQuery function.

    • _WS_EVAL

      public static final ApiFunction _WS_EVAL
      XQuery function.

    • _WS_GET

      public static final ApiFunction _WS_GET
      XQuery function.

    • _WS_ID

      public static final ApiFunction _WS_ID
      XQuery function.

    • _WS_IDS

      public static final ApiFunction _WS_IDS
      XQuery function.

    • _WS_PATH

      public static final ApiFunction _WS_PATH
      XQuery function.

    • _WS_SEND

      public static final ApiFunction _WS_SEND
      XQuery function.

    • _WS_SET

      public static final ApiFunction _WS_SET
      XQuery function.

  • Method Details

    • values

      public static ApiFunction[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static ApiFunction valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • definition

      public FuncDefinition definition()
      Specified by:
      definition in interface AFunction

    • init

      public static void init(ArrayList<FuncDefinition> list)
      Adds function signatures to the list. Called via reflection during initialization.
      Parameters:
      list - list of function signatures

    • toString

      public final String toString()
      Overrides:
      toString in class Enum<ApiFunction>