Package oracle.pgx.config

Class UdfConfig

java.lang.Object

oracle.pgx.config.AbstractConfig

oracle.pgx.config.AbstractUdfConfig

oracle.pgx.config.UdfConfig

@Generated("config_generator.py")
public class UdfConfig
extends AbstractUdfConfig

PGX Udf Config

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UdfConfig.Field	Fields of PGX Udf 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)
static UdfConfig.Field[]	getConfigFields()
java.util.Map<java.lang.String,java.lang.Object>	getLeftoverValues()	Gets the values that do not belong to any field.
java.util.List<UdfFunctionConfig>	getUserDefinedFunctions()	list of user defined functions
java.util.Map<UdfConfig.Field,java.lang.Object>	getValues()	Gets the parsed values.
java.util.Map<UdfConfig.Field,java.lang.Object>	getValuesWithoutDefaults()	Gets the values without defaults.
boolean	hasDefaultValue(UdfConfig.Field field)	Checks for default value.
boolean	isEmpty()	Checks if it's empty.
static UdfConfig	parse(java.io.InputStream is, boolean strict, java.lang.String parentPath)	Parses an input stream.
static UdfConfig	parse(java.util.Map<java.lang.String,java.lang.Object> raw, boolean strict, java.lang.String parentPath)	Parses a raw key/value mapping.
static UdfConfig	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.AbstractUdfConfig

getUdfsAsStream

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 UdfConfig 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 UdfConfig 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 UdfConfig 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 UdfConfig.Field[] getConfigFields()

getValues

public java.util.Map<UdfConfig.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(UdfConfig.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<UdfConfig.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)

getUserDefinedFunctions

public java.util.List<UdfFunctionConfig> getUserDefinedFunctions()

list of user defined functions

Specified by:

getUserDefinedFunctions in class AbstractUdfConfig

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object