Package dev.frostlake.functions.scalar.string

Class Position

java.lang.Object
dev.frostlake.functions.BuiltInFunction
dev.frostlake.functions.TextArgumentFunction
dev.frostlake.functions.scalar.string.Position
public class Position extends TextArgumentFunction
POSITION(needle, haystack [, start]) — the 1-based position of needle, or 0 when absent.

Two BINARY arguments are searched BYTE-wise: POSITION(TO_BINARY('45','HEX'), TO_BINARY('48454C','HEX')) is 2 — the second byte — where searching the hex renderings found the digit pair at character 3.

  • Constructor Details

    • Position

      public Position()

  • Method Details

    • evaluate

      public Object evaluate(List<Object> args)
      Description copied from class: BuiltInFunction
      Computes the function's result over its already-evaluated argument values. A SQL NULL argument arrives as Java null, and returning null makes the SQL result NULL.
      Specified by:
      evaluate in class BuiltInFunction
      Parameters:
      args - the argument values, in call order
      Returns:
      the function's value for these arguments, or null for SQL NULL

    • evaluate

      public Object evaluate(List<Object> args, CollationSpec collation)
      Under a collation the needle is found where the collation matches it, not byte for byte.
      Overrides:
      evaluate in class BuiltInFunction
      Parameters:
      args - the argument values, in call order
      collation - the collation the call settled on, or null when it carries none
      Returns:
      the function's value for these arguments, or null for SQL NULL

    • getMinArgCount

      public int getMinArgCount()
      Description copied from class: BuiltInFunction
      The fewest arguments a call to this function may pass; fewer is an argument-count error.
      Specified by:
      getMinArgCount in class BuiltInFunction
      Returns:
      the minimum accepted argument count

    • getMaxArgCount

      public int getMaxArgCount()
      Description copied from class: BuiltInFunction
      The most arguments a call to this function may pass; Integer.MAX_VALUE marks a variadic function (see BuiltInFunction.isVariadic()).
      Specified by:
      getMaxArgCount in class BuiltInFunction
      Returns:
      the maximum accepted argument count