Package oracle.pgx.config

Class FileGraphStoringConfig

java.lang.Object

oracle.pgx.config.AbstractConfig

oracle.pgx.config.AbstractFileGraphStoringConfig

oracle.pgx.config.FileGraphStoringConfig

@Generated("config_generator.py")
public class FileGraphStoringConfig
extends AbstractFileGraphStoringConfig

PGX Engine File Graph Storing Config

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FileGraphStoringConfig.Field	Fields of PGX Engine File Graph Storing 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.lang.String	getBasePath()	base path to use for storing a graph; file paths will be constructed using the following format <base_path>_<partition_index>.<extension>_, i.e.
oracle.pgx.vfs.CompressionScheme	getCompressionScheme()	the scheme to use for compression, or none to disable compression
static FileGraphStoringConfig.Field[]	getConfigFields()
java.lang.Character	getDelimiter()	delimiter character used as separator when storing.
java.lang.String	getEdgeExtension()	the extension to use when creating edge file partitions
java.lang.Integer	getInitialPartitionIndex()	the value used as initial partition index, i.e.
java.util.Map<java.lang.String,java.lang.Object>	getLeftoverValues()	Gets the values that do not belong to any field.
java.lang.Integer	getNumPartitions()	the number of partitions that should be created, when exporting to multiple files
java.lang.String	getRowExtension()	the extension to use when creating row file partitions
java.util.Map<FileGraphStoringConfig.Field,java.lang.Object>	getValues()	Gets the parsed values.
java.util.Map<FileGraphStoringConfig.Field,java.lang.Object>	getValuesWithoutDefaults()	Gets the values without defaults.
java.lang.String	getVertexExtension()	the extension to use when creating vertex file partitions
boolean	hasDefaultValue(FileGraphStoringConfig.Field field)	Checks for default value.
boolean	isEmpty()	Checks if it's empty.
static FileGraphStoringConfig	parse(java.io.InputStream is, boolean strict, java.lang.String parentPath)	Parses an input stream.
static FileGraphStoringConfig	parse(java.util.Map<java.lang.String,java.lang.Object> raw, boolean strict, java.lang.String parentPath)	Parses a raw key/value mapping.
static FileGraphStoringConfig	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.AbstractFileGraphStoringConfig

getSeparator, 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 FileGraphStoringConfig 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 FileGraphStoringConfig 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 FileGraphStoringConfig 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 FileGraphStoringConfig.Field[] getConfigFields()

getValues

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

getBasePath

public java.lang.String getBasePath()

base path to use for storing a graph; file paths will be constructed using the following format <base_path>_<partition_index>.<extension>_, i.e. parent_path/my_graph_1.edges

Specified by:

getBasePath in class AbstractFileGraphStoringConfig

Returns:

the base path

getNumPartitions

public java.lang.Integer getNumPartitions()

the number of partitions that should be created, when exporting to multiple files

Specified by:

getNumPartitions in class AbstractFileGraphStoringConfig

Returns:

the number of partitions

getDelimiter

public java.lang.Character getDelimiter()

delimiter character used as separator when storing. The characters ", {, } and \n cannot be used as delimiters

Specified by:

getDelimiter in class AbstractFileGraphStoringConfig

Returns:

the delimiter

getInitialPartitionIndex

public java.lang.Integer getInitialPartitionIndex()

the value used as initial partition index, i.e. initial_partition_index=1024 -> my_graph_1024.edges, my_graph_1025.edges

Specified by:

getInitialPartitionIndex in class AbstractFileGraphStoringConfig

Returns:

the inital partition index

getVertexExtension

public java.lang.String getVertexExtension()

the extension to use when creating vertex file partitions

Specified by:

getVertexExtension in class AbstractFileGraphStoringConfig

Returns:

the extension

getEdgeExtension

public java.lang.String getEdgeExtension()

the extension to use when creating edge file partitions

Specified by:

getEdgeExtension in class AbstractFileGraphStoringConfig

Returns:

the extension

getRowExtension

public java.lang.String getRowExtension()

the extension to use when creating row file partitions

Specified by:

getRowExtension in class AbstractFileGraphStoringConfig

Returns:

the extension

getCompressionScheme

public oracle.pgx.vfs.CompressionScheme getCompressionScheme()

the scheme to use for compression, or none to disable compression

Specified by:

getCompressionScheme in class AbstractFileGraphStoringConfig

Returns:

the compression scheme

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class AbstractFileGraphStoringConfig