Package oracle.pgx.config

Class UdfFunctionConfig

java.lang.Object
oracle.pgx.config.AbstractConfig
oracle.pgx.config.AbstractUdfFunctionConfig
oracle.pgx.config.UdfFunctionConfig
@Generated("config_generator.py") public class UdfFunctionConfig extends AbstractUdfFunctionConfig
PGX User Defined Function Config

  • Method Details

    • parse

      public static UdfFunctionConfig parse(InputStream is, boolean strict, String parentPath) throws IOException
      Parses an input stream.
      Parameters:
      is - the input stream
      strict - if true, parses in strict mode
      parentPath - if not null, resolves relative paths against this parentPath
      Returns:
      the parsed graph config
      Throws:
      IOException - Signals that an I/O exception has occurred.

    • parse

      public static UdfFunctionConfig parse(Map<String,Object> raw, boolean strict, String parentPath)
      Parses a raw key/value mapping.
      Parameters:
      raw - the raw key/value mapping to parse
      strict - if true, parses in strict mode
      parentPath - if not null, resolves relative paths against this parentPath
      Returns:
      the parsed graph config

    • parse

      public static UdfFunctionConfig parse(Properties props, boolean strict)
      Parses a properties file.
      Parameters:
      props - the properties to parse
      strict - if true, parses in strict mode
      Returns:
      the parsed graph config

    • getConfigFields

      public static UdfFunctionConfig.Field[] getConfigFields()

    • getValues

      public Map<UdfFunctionConfig.Field,Object> getValues()
      Gets the parsed values.
      Specified by:
      getValues in class AbstractConfig
      Returns:
      the parsed values

    • isEmpty

      public boolean isEmpty()
      Checks if it's empty.
      Returns:
      true, if the Map 'values' is empty.

    • hasDefaultValue

      public boolean hasDefaultValue(UdfFunctionConfig.Field field)
      Checks for default value.
      Parameters:
      field - the field
      Returns:
      true, if value for given field is the default value

    • getValuesWithoutDefaults

      public Map<UdfFunctionConfig.Field,Object> getValuesWithoutDefaults()
      Gets the values without defaults.
      Returns:
      the values without defaults

    • getLeftoverValues

      public Map<String,Object> getLeftoverValues()
      Gets the values that do not belong to any field.
      Returns:
      the values that do not belong to any field

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • toString

      public String toString(boolean hideSensitiveData)

    • getNamespace

      public String getNamespace()
      namespace of the function in PGX

    • getFunctionName

      public String getFunctionName()
      name of the function used as identifier in PGX
      Specified by:
      getFunctionName in class AbstractUdfFunctionConfig

    • getLanguage

      public UdfLanguage getLanguage()
      language the function is implemented in
      Specified by:
      getLanguage in class AbstractUdfFunctionConfig

    • getSourceLocation

      public String getSourceLocation()
      source code of the function provided as a unified resource identifier, either pointing to a a local file (relative to the location of this config or absolute), a web resource (prefix http://' or https://), or a classpath (prefix classpath:/ or jar:)
      Specified by:
      getSourceLocation in class AbstractUdfFunctionConfig

    • getSourceCode

      public String getSourceCode()
      source code of the function provided inline
      Specified by:
      getSourceCode in class AbstractUdfFunctionConfig

    • getImplementationReference

      public String getImplementationReference()
      reference to the UDF implementation on the classpath
      Specified by:
      getImplementationReference in class AbstractUdfFunctionConfig

    • getSourceFunctionName

      public String getSourceFunctionName()
      name of the function in the source language
      Specified by:
      getSourceFunctionName in class AbstractUdfFunctionConfig

    • getReturnType

      public PropertyType getReturnType()
      return type of the function
      Specified by:
      getReturnType in class AbstractUdfFunctionConfig

    • getArguments

      public List<UdfFunctionArgumentConfig> getArguments()
      list of arguments
      Specified by:
      getArguments in class AbstractUdfFunctionConfig

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object