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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UdfFunctionConfig.Field	Fields of PGX User Defined Function Config

Field Summary

Fields inherited from class oracle.pgx.config.AbstractConfig

ENV_SEPARATOR, ENV_VARIABLE_PREFIX, SYSTEM_PROPERTY_PREFIX

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
java.util.List<UdfFunctionArgumentConfig>	getArguments()	list of arguments
static UdfFunctionConfig.Field[]	getConfigFields()
java.lang.String	getFunctionName()	name of the function used as identifier in PGX
java.lang.String	getImplementationReference()	reference to the UDF implementation on the classpath
UdfLanguage	getLanguage()	language the function is implemented in
java.util.Map<java.lang.String,java.lang.Object>	getLeftoverValues()	Gets the values that do not belong to any field.
java.lang.String	getNamespace()	namespace of the function in PGX
PropertyType	getReturnType()	return type of the function
java.lang.String	getSourceCode()	source code of the function provided inline
java.lang.String	getSourceFunctionName()	name of the function in the source language
java.lang.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://), a HDFS path (deprecated) (prefix hdfs:) or a classpath (prefix classpath:/ or jar:)
java.util.Map<UdfFunctionConfig.Field,java.lang.Object>	getValues()	Gets the parsed values.
java.util.Map<UdfFunctionConfig.Field,java.lang.Object>	getValuesWithoutDefaults()	Gets the values without defaults.
boolean	hasDefaultValue(UdfFunctionConfig.Field field)	Checks for default value.
boolean	isEmpty()	Checks if it's empty.
static UdfFunctionConfig	parse(java.io.InputStream is, boolean strict, java.lang.String parentPath)	Parses an input stream.
static UdfFunctionConfig	parse(java.util.Map<java.lang.String,java.lang.Object> raw, boolean strict, java.lang.String parentPath)	Parses a raw key/value mapping.
static UdfFunctionConfig	parse(java.util.Properties props, boolean strict)	Parses a properties file.
java.lang.String	toString()
java.lang.String	toString(boolean hideSensitiveData)

Methods inherited from class oracle.pgx.config.AbstractConfig

getDefault, getValueFromEnvironment, getValueFromEnvironment, parseString, setSerializable

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

parse

public static UdfFunctionConfig parse(java.io.InputStream is,
                                      boolean strict,
                                      java.lang.String parentPath)
                               throws java.io.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:

java.io.IOException - Signals that an I/O exception has occurred.

parse

public static UdfFunctionConfig parse(java.util.Map<java.lang.String,java.lang.Object> raw,
                                      boolean strict,
                                      java.lang.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(java.util.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 java.util.Map<UdfFunctionConfig.Field,java.lang.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 java.util.Map<UdfFunctionConfig.Field,java.lang.Object> getValuesWithoutDefaults()

Gets the values without defaults.

Returns:

the values without defaults

getLeftoverValues

public java.util.Map<java.lang.String,java.lang.Object> getLeftoverValues()

Gets the values that do not belong to any field.

Returns:

the values that do not belong to any field

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toString

public java.lang.String toString(boolean hideSensitiveData)

getNamespace

public java.lang.String getNamespace()

namespace of the function in PGX

getFunctionName

public java.lang.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 java.lang.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://), a HDFS path (deprecated) (prefix hdfs:) or a classpath (prefix classpath:/ or jar:)

Specified by:

getSourceLocation in class AbstractUdfFunctionConfig

getSourceCode

public java.lang.String getSourceCode()

source code of the function provided inline

Specified by:

getSourceCode in class AbstractUdfFunctionConfig

getImplementationReference

public java.lang.String getImplementationReference()

reference to the UDF implementation on the classpath

Specified by:

getImplementationReference in class AbstractUdfFunctionConfig

getSourceFunctionName

public java.lang.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 java.util.List<UdfFunctionArgumentConfig> getArguments()

list of arguments

Specified by:

getArguments in class AbstractUdfFunctionConfig

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object