Package oracle.pgx.config

Class ProviderLoadingConfig

java.lang.Object

oracle.pgx.config.AbstractConfig

oracle.pgx.config.ProviderLoadingConfig

@Generated("config_generator.py")
public class ProviderLoadingConfig
extends AbstractConfig

PGX Engine Entity Provider Loading Config

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ProviderLoadingConfig.Field	Fields of PGX Engine Entity Provider Loading 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 ProviderLoadingConfig.Field[]	getConfigFields()
java.lang.String	getFilter()	[currently unsupported] the filter expression
java.util.List<java.lang.String>	getGroupingBy()	[currently unsupported] array of edge properties used for aggregator.
java.util.Map<java.lang.String,java.lang.Object>	getLeftoverValues()	Gets the values that do not belong to any field.
java.util.Map<ProviderLoadingConfig.Field,java.lang.Object>	getValues()	Gets the parsed values.
java.util.Map<ProviderLoadingConfig.Field,java.lang.Object>	getValuesWithoutDefaults()	Gets the values without defaults.
boolean	hasDefaultValue(ProviderLoadingConfig.Field field)	Checks for default value.
java.lang.Boolean	isCreateKeyMapping()	if true, a mapping between entity keys and internal IDs is prepared during loading.
boolean	isEmpty()	Checks if it's empty.
java.lang.Boolean	isStrictMode()	if true, exceptions are thrown and logged with ERROR level whenever loader encounters problems with input file, such as invalid format, repeated keys, missing fields, mismatches and other potential errors.
java.lang.Boolean	loadLabels()	whether or not to load the entity label if it is available
static ProviderLoadingConfig	parse(java.io.InputStream is, boolean strict, java.lang.String parentPath)	Parses an input stream.
static ProviderLoadingConfig	parse(java.util.Map<java.lang.String,java.lang.Object> raw, boolean strict, java.lang.String parentPath)	Parses a raw key/value mapping.
static ProviderLoadingConfig	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 ProviderLoadingConfig 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 ProviderLoadingConfig 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 ProviderLoadingConfig 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 ProviderLoadingConfig.Field[] getConfigFields()

getValues

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

isCreateKeyMapping

public java.lang.Boolean isCreateKeyMapping()

if true, a mapping between entity keys and internal IDs is prepared during loading.

isStrictMode

public java.lang.Boolean isStrictMode()

if true, exceptions are thrown and logged with ERROR level whenever loader encounters problems with input file, such as invalid format, repeated keys, missing fields, mismatches and other potential errors. If false, loader may use less memory during loading phase, but behave unexpectedly with erratic input files

loadLabels

public java.lang.Boolean loadLabels()

whether or not to load the entity label if it is available

getFilter

public java.lang.String getFilter()

[currently unsupported] the filter expression

getGroupingBy

public java.util.List<java.lang.String> getGroupingBy()

[currently unsupported] array of edge properties used for aggregator. For Vertices, only the ID can be used (default)

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object