Package oracle.pgx.config

Class PreloadGraphConfig

java.lang.Object

oracle.pgx.config.AbstractConfig

oracle.pgx.config.AbstractPreloadGraphConfig

oracle.pgx.config.PreloadGraphConfig

@Generated("config_generator.py")
public class PreloadGraphConfig
extends AbstractPreloadGraphConfig

Preloaded Graph Config

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PreloadGraphConfig.Field	Fields of Preloaded Graph 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 PreloadGraphConfig.Field[]	getConfigFields()
java.util.Map<java.lang.String,java.lang.Object>	getLeftoverValues()	Gets the values that do not belong to any field.
java.lang.String	getName()	preloaded graph name
java.lang.String	getPath()	uri to graph config file
java.util.Map<PreloadGraphConfig.Field,java.lang.Object>	getValues()	Gets the parsed values.
java.util.Map<PreloadGraphConfig.Field,java.lang.Object>	getValuesWithoutDefaults()	Gets the values without defaults.
boolean	hasDefaultValue(PreloadGraphConfig.Field field)	Checks for default value.
boolean	isEmpty()	Checks if it's empty.
java.lang.Boolean	isPublish()	whether or not this preloaded graph should be published.
java.lang.Boolean	isPublishWithSnapshots()	whether or not this preloaded graph should be published together with its snapshots.
java.lang.Boolean	loadAtServerInitialization()	if true, PGX will load the pre-loaded graph during the initialization of the engine, otherwise loads the graph after completing the engine initialization.
static PreloadGraphConfig	parse(java.io.InputStream is, boolean strict, java.lang.String parentPath)	Parses an input stream.
static PreloadGraphConfig	parse(java.util.Map<java.lang.String,java.lang.Object> raw, boolean strict, java.lang.String parentPath)	Parses a raw key/value mapping.
static PreloadGraphConfig	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 PreloadGraphConfig 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 PreloadGraphConfig 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 PreloadGraphConfig 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 PreloadGraphConfig.Field[] getConfigFields()

getValues

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

getPath

public java.lang.String getPath()

uri to graph config file

getName

public java.lang.String getName()

preloaded graph name

loadAtServerInitialization

public java.lang.Boolean loadAtServerInitialization()

if true, PGX will load the pre-loaded graph during the initialization of the engine, otherwise loads the graph after completing the engine initialization.

isPublish

public java.lang.Boolean isPublish()

whether or not this preloaded graph should be published. If published, any session can reference it by name. If this option is set to true, "publish_with_snapshots" must be set to false

Specified by:

isPublish in class AbstractPreloadGraphConfig

isPublishWithSnapshots

public java.lang.Boolean isPublishWithSnapshots()

whether or not this preloaded graph should be published together with its snapshots. If published this way, any session can reference it by name and can set any snapshot. If this option is set to true, "publish" must be set to false.

Specified by:

isPublishWithSnapshots in class AbstractPreloadGraphConfig

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object