Package oracle.pgx.config

Class GraphBuilderConfig

java.lang.Object

oracle.pgx.config.AbstractConfig

oracle.pgx.config.AbstractGraphBuilderConfig

oracle.pgx.config.GraphBuilderConfig

@Generated("config_generator.py")
public class GraphBuilderConfig
extends AbstractGraphBuilderConfig

Graph Builder Parameters

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GraphBuilderConfig.Field	Fields of Graph Builder Parameters

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 GraphBuilderConfig.Field[]	getConfigFields()
IdGenerationStrategy	getEdgeIdGenerationStrategy()	if AUTO_GENERATED edges IDs are auto generated.
java.util.Map<java.lang.String,java.lang.Object>	getLeftoverValues()	Gets the values that do not belong to any field.
java.util.Map<GraphBuilderConfig.Field,java.lang.Object>	getValues()	Gets the parsed values.
java.util.Map<GraphBuilderConfig.Field,java.lang.Object>	getValuesWithoutDefaults()	Gets the values without defaults.
IdGenerationStrategy	getVertexIdGenerationStrategy()	if AUTO_GENERATED vertices IDs are auto generated.
boolean	hasDefaultValue(GraphBuilderConfig.Field field)	Checks for default value.
boolean	isEmpty()	Checks if it's empty.
java.lang.Boolean	isRetainEdgeId()	if true keep the edge id after graph construction.
java.lang.Boolean	isRetainVertexId()	if true keep the vertex id after graph construction.
static GraphBuilderConfig	parse(java.io.InputStream is, boolean strict, java.lang.String parentPath)	Parses an input stream.
static GraphBuilderConfig	parse(java.util.Map<java.lang.String,java.lang.Object> raw, boolean strict, java.lang.String parentPath)	Parses a raw key/value mapping.
static GraphBuilderConfig	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.AbstractGraphBuilderConfig

hashCode

Methods inherited from class oracle.pgx.config.AbstractConfig

getDefault, getValueFromEnvironment, getValueFromEnvironment, parseString, setSerializable

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

parse

public static GraphBuilderConfig 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 GraphBuilderConfig 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 GraphBuilderConfig 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 GraphBuilderConfig.Field[] getConfigFields()

getValues

public java.util.Map<GraphBuilderConfig.Field,java.lang.Object> getValues()

Gets the parsed values.

Specified by:

getValues in class AbstractGraphBuilderConfig

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(GraphBuilderConfig.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<GraphBuilderConfig.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)

isRetainEdgeId

public java.lang.Boolean isRetainEdgeId()

if true keep the edge id after graph construction. If false drop the edge id.

isRetainVertexId

public java.lang.Boolean isRetainVertexId()

if true keep the vertex id after graph construction. If false drop the vertex id.

getVertexIdGenerationStrategy

public IdGenerationStrategy getVertexIdGenerationStrategy()

if AUTO_GENERATED vertices IDs are auto generated. If USER_IDS vertex IDs must be explicitly defined by the user

getEdgeIdGenerationStrategy

public IdGenerationStrategy getEdgeIdGenerationStrategy()

if AUTO_GENERATED edges IDs are auto generated. If USER_IDS edge IDs must be explicitly defined by the user

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class AbstractGraphBuilderConfig